/ 
App-calx-0.008
River stage one • 1 direct dependent • 1 total dependent
/ calx

NAME

calx - Display calendar with highlighted dates

VERSION

This document describes version 0.008 of calx (from Perl distribution App-calx), released on 2023-06-22.

SYNOPSIS

# show calendar for the current month, with dates from Calendar::Dates::ID::Holiday
% calx -c ID::Holiday

# show calendar for the current month, with dates from Calendar::Dates::ID::Holiday and Calendar::Dates::SG::Holiday
% calx -c ID::Holiday -c SD::Holiday

# show calendar for the current month, with dates from all installed Calendar::Dates::* modules
% calx -a

# show calendar for the whole year
% calx 2019 -c ID::Holiday

# show calendar for a certain month and year
% calx 2 2019 -c ID::Holiday

# echo -e "2023-05-30\n2023-05-31\n2023-06-01\n" | calx

DESCRIPTION

This command provides a variant of cal utility for displaying ASCII calendar on the command-line. It focuses on highlighting certain dates. It currently always starts the week at Monday and can get the list of dates from command-line option (`--date`) or stdin or one or more Calendar::Dates::* modules.

OPTIONS

% calx [opts] [[month] year]

Most options follow cal. Not all options from cal are supported/recognized. Some options are specific to calx.

-1

Show a single month of calendar (the default).

-3

Show three months of calendar (previous, current, next).

-h

Turn off highlighting of today.

-y

Show one year (12 months) of calendar (the default if only year is specified).

-c MODULE+

Get dates from a Calendar::Dates module (value is name of module without the "Calendar::Dates::" prefix). Can be specified multiple times.

-a

Get dates from all installed Calendar::Dates::* modules.

--date DATE+

Highlight one or more dates. You can also supply the dates from stdin. The dates must be in ISO8601 YYYY-MM-DD format.

HOMEPAGE

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

SOURCE

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

SEE ALSO

cal Unix utility

Calendar::Dates

cal Unix utility.

Other cal variants: cal-idn (from App::cal::idn).

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) 2023, 2019 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-calx

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.