++ed by:
RRWO ADAMJS

2 PAUSE users
2 non-PAUSE users.

perlancar

NAME

list-org-anniversaries - List all anniversaries in Org files

VERSION

This document describes version 0.32 of list-org-anniversaries (from Perl distribution App-OrgUtils), released on 2015-08-17.

SYNOPSIS

 # list all anniversaries
 $ list-org-anniversaries ~/addressbook.org

 # only show friends' birthdays due in 1 week and not past 1 week overdue
 $ list-org-anniversaries --field-pattern 'birthday' --has-tags '[friend]' \
     --due-in 7 --max-overdue 7 --nopretty ~/contacts-*.org

With an Org contacts file like this:

 * Andi Angkasa
 - email      :: andi@example.com
 - birthday   :: [1981-07-05 ]
 * B
 ** Budi Bagus              :friend:
 - email      :: budi@example.com
 - birthday   :: [1900-04-07 ]
 * C
 ** Cinta Cemara            :spouse:friend:
 :PROPERTIES:
 :EMAIL: cinta@example.com
 :CELL: 0812-345-6789
 :BIRTHDAY: 1900-06-30
 :WEDDING_ANNIVERSARY: 2010-07-04
 :END:

and assuming today is 2011-07-01, the script will print something like:

 in 3 days: 1st WEDDING_ANNIVERSARY of Cinta Cemara (2010-07-04 - 2011-07-04)
 1 day ago: birthday of Cinta Cemara (2010-06-30)

DESCRIPTION

This script

See App::ListOrgAnniversaries for more details, including available options.

OPTIONS

* marks required options.

Configuration options

--config-path=filename

{en_US Set path to configuration file}.

Can be specified multiple times.

--config-profile=s

{en_US Set configuration profile to use}.

--no-config

{en_US Do not use any configuration file}.

Environment options

--no-env

{en_US Do not read environment for default options}.

Output options

--format=s

{en_US Choose output format, e.g. json, text}.

Default value:

 undef
--json

{en_US Set output format to json}.

--naked-res

{en_US When outputing as JSON, strip result envelope}.

Default value:

 0

{en_US By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
}

Other options

--cache-dir=dirname

{en_US Cache Org parse result}.

{en_US Since Org::Parser can spend some time to parse largish Org files, this is an option to store the parse result. Caching is turned on if this argument is set. }

--due-in=i

{en_US Only show anniversaries that are due in this number of days}.

--field-pattern=s

{en_US Field regex that specifies anniversaries}.

Default value:

 "(?:birthday|anniversary)"
--file=filename*

Can be specified multiple times.

--files-json=filename

See --file.

--has-tags-json=s

{en_US Filter headlines that have the specified tags} (JSON-encoded).

See --has-tags.

--has-tags=s@

{en_US Filter headlines that have the specified tags}.

Can be specified multiple times.

--help, -h, -?

{en_US Display help message and exit}.

--lacks-tags-json=s

{en_US Filter headlines that don't have the specified tags} (JSON-encoded).

See --lacks-tags.

--lacks-tags=s@

{en_US Filter headlines that don't have the specified tags}.

Can be specified multiple times.

--max-overdue=i

{en_US Don't show dates that are overdue more than this number of days}.

--sort-json=s

{en_US Specify sorting} (JSON-encoded).

See --sort.

--sort=s

{en_US Specify sorting}.

Default value:

 "due_date"

{en_US If string, must be one of 'date', '-date' (descending).

If code, sorting code will get [REC, DUE_DATE] as the items to compare, where REC is the final record that will be returned as final result (can be a string or a hash, if 'detail' is enabled), and DUE_DATE is the DateTime object. }

--time-zone=timezone

{en_US Will be passed to parser's options}.

{en_US If not set, TZ environment variable will be picked as default. }

--today-json=s

{en_US Assume today's date} (JSON-encoded).

See --today.

--today=s

{en_US Assume today's date}.

{en_US You can provide Unix timestamp or DateTime object. If you provide a DateTime object, remember to set the correct time zone. }

--version, -v

{en_US Display program's version and exit}.

SEE ALSO

Org::Parser

org-contacts, http://julien.danjou.info/org-contacts.html

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C list-org-anniversaries list-org-anniversaries

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete list-org-anniversaries 'p/*/`list-org-anniversaries`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

ENVIRONMENT

LIST_ORG_ANNIVERSARIES_OPT => str

Specify additional command-line options

CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/list-org-anniversaries.conf, ~/list-org-anniversaries.conf or /etc/list-org-anniversaries.conf (can be changed by specifying --config-path). All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

Configuration file is in the format of IOD, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

List of available configuration parameters:

 cache_dir (see --cache-dir)
 due_in (see --due-in)
 field_pattern (see --field-pattern)
 files (see --file)
 format (see --format)
 has_tags (see --has-tags)
 lacks_tags (see --lacks-tags)
 max_overdue (see --max-overdue)
 naked_res (see --naked-res)
 sort (see --sort)
 time_zone (see --time-zone)
 today (see --today)

FILES

~/.config/list-org-anniversaries.conf

~/list-org-anniversaries.conf

/etc/list-org-anniversaries.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-OrgUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-OrgUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.