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

NAME

App::calx - Display a calendar

VERSION

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

SYNOPSIS

# See calx script provided in this distribution

DESCRIPTION

FUNCTIONS

gen_calendar

Usage:

gen_calendar(%args) -> [$status_code, $reason, $payload, \%result_meta]

Generate one or more monthly calendars in 3-column format.

This function is not exported.

Arguments ('*' denotes required arguments):

  • caldates_modules => array[perl::calendar::dates::modname]

    (No description)

  • dates => array[hash]

    (No description)

  • highlight_today => bool (default: 1)

    (No description)

  • month => int

    The first month.

    Not required if months=12 (generate whole year from month 1 to 12).

  • months => int (default: 1)

    (No description)

  • time_zone => str

    (No description)

  • year => int

    (No description)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

gen_monthly_calendar

Usage:

gen_monthly_calendar(%args) -> any

Generate a single month calendar.

Return [\@lines, \@hol]

This function is not exported.

Arguments ('*' denotes required arguments):

  • caldates_modules => array[perl::calendar::dates::modname]

    (No description)

  • dates => array[hash]

    (No description)

  • highlight_today => bool (default: 1)

    (No description)

  • month* => int

    (No description)

  • show_next_month_days => bool (default: 1)

    (No description)

  • show_prev_month_days => bool (default: 1)

    (No description)

  • show_year_in_title => bool (default: 1)

    (No description)

  • time_zone => str

    (No description)

  • year* => int

    (No description)

Return value: (any)

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.

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.