NAME

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

VERSION

This document describes version 0.23 of list-org-anniversaries (from Perl distribution App-OrgUtils), released on 2015-01-03.

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.

--cache-dir=s

Cache Org parse result.

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.

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--due-in=i

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

--field-pattern=s

Field regex that specifies anniversaries.

Default value:

 "(?:birthday|anniversary)"

--files-json=s

See --files.

--files-yaml=s

See --files.

--files=s@*

Can be specified multiple times.

--format-options=s

Pass options to formatter.

--format=s

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

--has-tags-json=s

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

See --has-tags.

--has-tags-yaml=s

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

See --has-tags.

--has-tags=s@

Filter headlines that have the specified tags.

Can be specified multiple times.

--help, -h, -?

Display this help message.

--json

Equivalent to --format=json-pretty.

--lacks-tags-json=s

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

See --lacks-tags.

--lacks-tags-yaml=s

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

See --lacks-tags.

--lacks-tags=s@

Filter headlines that don't have the specified tags.

Can be specified multiple times.

--max-overdue=i

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

--no-config

Do not use any configuration file.

--perl

Equivalent to --format=perl.

--sort-json=s

Specify sorting (JSON-encoded).

See --sort.

--sort-yaml=s

Specify sorting (YAML-encoded).

See --sort.

--sort=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.

--time-zone=s

Will be passed to parser's options.

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

--today-json=s

Assume today's date (JSON-encoded).

See --today.

--today-yaml=s

Assume today's date (YAML-encoded).

See --today.

--today=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.

--version, -v

--yaml

Equivalent to --format=yaml.

FILES

/etc/list-org-anniversaries.conf

~/list-org-anniversaries.conf

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.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/sharyanto/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.

cpanm App::OrgUtils

perl -MCPAN -e shell
install App::OrgUtils