The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-week-0.06
River stage zero No dependents
3 ++
/ week

NAME

week - colorful calender command

SYNOPSIS

week [ -Mmodule ] [ option ] [ date ]

Options:

    -n      Display n months surronding today (default 3).
    -A n    Display n months after current month.
    -B n    Display n months before current month (default 1).
    -C[n]   Display n months before and after current month (default 4).
    -y      Display year calender.
    -Y[n]   Display n years of calender
    -c n    Display calendar in n column (default 3).

    --colormap  FIELD=COLOR

Module options:

    --mono
    --lavender
    --green
    --pastel

VERSION

Version 0.06

DESCRIPTION

By default, week command display the previous, current and next month surrounding today, just like -3 option of cal command.

Number of month can be given with dash.

    $ week -12

Before and after months can be specified with -B and -A option, and -C for both.

    $ week -B4 -A4
    $ week -C4

Date can given like:

    $ week 2019/9/23
    $ week 9/23        # 9/23 of current year
    $ week 23          # 23rd of current month

Greater number is handled as year. Next command display calender of year 1752.

    $ week 1752

Use option -y to show one year calender. Number of years can be specified by -Y option, and implicitly set -y option.

    $ week -y          # display this year's calender

    $ week -Y2c6       # display 2 years calender in 6 column

    $ week -Y 1752     # display 1752 years of calender (takes long)

COLORMAP

Each field is labled by names.

    FRAME       Enclosing frame
    MONTH       Month name
    WEEK        Day of the week
    DAYS        Calender
    THISMONTH   Target month name
    THISWEEK    Target day of the week
    THISDAYS    Target calender
    THISDAY     Target date

Color for each field can be specified by --colormap (--cm) option with LABEL=colorspec syntax. Default color is:

    --colormap      DAYS=L05/335 \
    --colormap      WEEK=L05/445 \
    --colormap     FRAME=L05/445 \
    --colormap     MONTH=L05/335 \
    --colormap   THISDAY=522/113 \
    --colormap  THISDAYS=555/113 \
    --colormap  THISWEEK=L05/445 \
    --colormap THISMONTH=555/113

Colormap is handled by Getopt::EX::Colormap module; use `perldoc Getopt::EX::Colormap` for detail.

You can add special effect afterward. For example, put next line in your ~/.weekrc to blink today. $<move> indicates to move all following arguments here, so that insert this option at the end.

    option default $<move> --cm 'THISDAY=+F'

FILES

~/.weekrc

Start up file.

MODULES

Currently two modules are included in the distribution. These options can be used without any special action, because they are defined to load appropriate module automatically in default start up module (App::week::default).

-Mcolors
    --mono
    --lavender
    --green
    --pastel
-Mteams
    --tigers
    --giants
    --lions

Feel free to update these modules and send pull request to github site.

SEE ALSO

https://github.com/kaz-utashiro/App-week

Getopt::EX::Colormap

https://qiita.com/kaz-utashiro/items/603f4bca39e397afc91c

AUTHOR

Kazumasa Utashiro

LICENSE

You can redistribute it and/or modify it under the same terms as Perl itself.

COPYRIGHT

The following copyright notice applies to all the files provided in this distribution, including binary files, unless explicitly noted otherwise.

Copyright 2018- Kazumasa Utashiro