/ 
App-OrgUtils-0.487
River stage one • 2 direct dependents • 2 total dependents
/ list-org-anniversaries

NAME

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

VERSION

This document describes version 0.487 of list-org-anniversaries (from Perl distribution App-OrgUtils), released on 2024-01-09.

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.

Main options

--due-in=s

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

--field-pattern=s

Regex for fields that specify anniversaries.

Default value:

qr((?:birthday|dob|date of birth|anniversary))i
--file=s@*

(No description)

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

--files-json=s

See --file.

Can also be specified as the 1st command-line argument and onwards.

--has-tags-json=s

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

See --has-tags.

--has-tags=s@

Filter headlines that have the specified tags.

Can be specified multiple times.

--lacks-tags-json=s

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

See --lacks-tags.

--lacks-tags=s@

Filter headlines that don't have the specified tags.

Can be specified multiple times.

--max-overdue=s

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

--reminded-field-pattern=s

Default value:

qr(reminded)i
--reminded-suffix=s

Default value:

" reminded"
--sort-json=s

Specify sorting (JSON-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=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.

Configuration options

--config-path=s, -c

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

--config-profile=s, -P

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

[profile=dev]
username=foo
pass=beaver

[profile=production]
username=bar
pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--no-config, -C

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

Environment options

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--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]
--page-result

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

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.

CONFIGURATION FILE

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

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

All found files will be read and merged.

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

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

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

You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [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.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

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)
reminded_field_pattern (see --reminded-field-pattern)
reminded_suffix (see --reminded-suffix)
sort (see --sort)
time_zone (see --time-zone)
today (see --today)

ENVIRONMENT

LIST_ORG_ANNIVERSARIES_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/list-org-anniversaries.conf

/home/u1/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.

SEE ALSO

Org::Parser

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

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar <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.

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.