/ 
App-CalendarDatesUtils-0.011
River stage one • 1 direct dependent • 1 total dependent
/ list-calendar-dates

NAME

list-calendar-dates - List dates from one or more Calendar::Dates::* modules

VERSION

This document describes version 0.011 of list-calendar-dates (from Perl distribution App-CalendarDatesUtils), released on 2019-12-11.

SYNOPSIS

Usage:

% list-calendar-dates [options] [year] [month] [day]

OPTIONS

* marks required options.

Main options

--action=s

Default value:

"list-dates"

Valid values:

["list-dates","list-modules"]
--detail, -l

Whether to show detailed record for each date.

--param=s%

Specify parameters.

Each value is a name-value pair, use key=value syntax. Can be specified multiple times.

--params-json=s

Specify parameters (JSON-encoded).

See --param.

-L

List all Calendar::Dates modules (eqv to --action=list-modules).

See --action.

Entry filtering options

--all-entries, -A

Return all entries (include low-priority ones).

By default, low-priority entries (entries tagged `low-priority`) are not included. This option will include those entries.

When combined with --all-years, this option will also cause all very early years and all years far into the future to be included also.

--all-years

List dates from all available years instead of a single year.

Note that by default, following common usage pattern, dates with years that are too old (< 10 years ago) or that are too far into the future (> 10 years from now) are not included, unless you combine this option with --all-entries (-A).

--day=s, -D
--exclude-tag=s@, -T

Can be specified multiple times.

--exclude-tags-json=s

See --exclude-tag.

--include-tag=s@, -t

Can be specified multiple times.

--include-tags-json=s

See --include-tag.

--max-year=s
--min-year=s
--month=s, -M
--past

Only show entries that are less than (at least) today's date.

--year=s, -Y

Specify year of dates to list.

The default is to list dates in the current year. You can specify all_years instead to list dates from all available years.

Module selection options

--all-modules, -a

Use all installed Calendar::Dates::* modules.

--modules-json=s, -m

Name(s) of Calendar::Dates::* module (without the prefix) (JSON-encoded).

See --modules.

--modules=s@

Name(s) of Calendar::Dates::* module (without the prefix).

Can be specified multiple times.

Output options

--format-options=s

Pass options to formatter.

--format=s

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

Default value:

undef
--json

Equivalent to --format=json-pretty.

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

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-calendar-dates list-calendar-dates

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-calendar-dates 'p/*/`list-calendar-dates`/'

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-CalendarDatesUtils.

SOURCE

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

BUGS

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

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) 2019 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.