The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
PERLANCAR / App-OrgUtils-0.44 / bin / list-org-anniversaries 
#!perl

our $DATE = '2016-11-06'; # DATE
our $VERSION = '0.44'; # VERSION

use 5.010;
use strict;
use warnings;

use Perinci::CmdLine::Any;

binmode STDOUT, ":utf8";
Perinci::CmdLine::Any->new(
    url => '/App/ListOrgAnniversaries/list_org_anniversaries')->run;

1;
# ABSTRACT: List all anniversaries in Org files
# PODNAME: list-org-anniversaries

__END__

=pod

=encoding UTF-8

=head1 NAME

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

=head1 VERSION

This document describes version 0.44 of list-org-anniversaries (from Perl distribution App-OrgUtils), released on 2016-11-06.

=head1 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)

=head1 DESCRIPTION

This script

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

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--due-in>=I<i>

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

=item B<--field-pattern>=I<s>

Field regex that specifies anniversaries.

Default value:

 "(?:birthday|anniversary)"

=item B<--file>=I<filename>*

Can be specified multiple times.

=item B<--files-json>=I<filename>

See C<--file>.

=item B<--has-tags-json>=I<s>

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

See C<--has-tags>.

=item B<--has-tags>=I<s@>

Filter headlines that have the specified tags.

Can be specified multiple times.

=item B<--lacks-tags-json>=I<s>

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

See C<--lacks-tags>.

=item B<--lacks-tags>=I<s@>

Filter headlines that don't have the specified tags.

Can be specified multiple times.

=item B<--max-overdue>=I<i>

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

=item B<--sort-json>=I<s>

Specify sorting (JSON-encoded).

See C<--sort>.

=item B<--sort>=I<s>

Specify sorting.

Default value:

 "due_date"

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.


=item B<--time-zone>=I<timezone>

Will be passed to parser's options.

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


=item B<--today-json>=I<s>

Assume today's date (JSON-encoded).

See C<--today>.

=item B<--today>=I<s>

Assume today's date.

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


=back

=head2 Configuration options

=over

=item B<--config-path>=I<filename>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--no-config>

Do not use any configuration file.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

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]


=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

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

=head2 bash

To activate bash completion for this script, put:

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

in your bash startup (e.g. C<~/.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 L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

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

in your tcsh startup (e.g. C<~/.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 C<shcompgen> (see above).

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.

=head1 CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/list-org-anniversaries.conf>, F<~/list-org-anniversaries.conf>, or F</etc/list-org-anniversaries.conf>.

All found files will be read and merged.

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

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

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 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)

=head1 ENVIRONMENT

=head2 LIST_ORG_ANNIVERSARIES_OPT => str

Specify additional command-line options

=head1 FILES

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

~/list-org-anniversaries.conf

/etc/list-org-anniversaries.conf

=head1 HOMEPAGE

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

=head1 SOURCE

Source repository is at L<https://github.com/sharyanto/perl-App-OrgUtils>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<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.

=head1 SEE ALSO

L<Org::Parser>

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

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.

=cut