list-org-anniversaries - List all anniversaries in Org files
This document describes version 0.30 of list-org-anniversaries (from Perl distribution App-OrgUtils), released on 2015-04-03.
# 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)
This script
See App::ListOrgAnniversaries for more details, including available options.
* marks required options.
*
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.
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Only show anniversaries that are due in this number of days.
Field regex that specifies anniversaries.
Default value:
"(?:birthday|anniversary)"
See --file.
--file
Choose output format, e.g. json, text.
undef
Filter headlines that have the specified tags (JSON-encoded).
See --has-tags.
--has-tags
Filter headlines that have the specified tags.
Display this help message.
Set output format to json.
Filter headlines that don't have the specified tags (JSON-encoded).
See --lacks-tags.
--lacks-tags
Filter headlines that don't have the specified tags.
Don't show dates that are overdue more than this number of days.
When outputing as JSON, strip result envelope.
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]
Do not use any configuration file.
Specify sorting (JSON-encoded).
See --sort.
--sort
Specify sorting.
"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.
Will be passed to parser's options.
If not set, TZ environment variable will be picked as default.
Assume today's date (JSON-encoded).
See --today.
--today
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.
LIST_ORG_ANNIVERSARIES_OPT
~/list-org-anniversaries.conf
/etc/list-org-anniversaries.conf
Org::Parser
org-contacts, http://julien.danjou.info/org-contacts.html
This script has shell tab completion capability with support for several shells.
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.
~/.bashrc
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.
shcompgen
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.
Source repository is at https://github.com/perlancar/perl-App-OrgUtils.
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.
perlancar <perlancar@cpan.org>
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.
To install App::OrgUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::OrgUtils
CPAN shell
perl -MCPAN -e shell install App::OrgUtils
For more information on module installation, please visit the detailed CPAN module installation guide.