From 5597886318d0b4ec578b261b49f5bd80baf29538 Mon Sep 17 00:00:00 2001 From: Leah Neukirchen Date: Sat, 28 Mar 2020 19:16:15 +0100 Subject: add documentation --- README | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..ee15776 --- /dev/null +++ b/README @@ -0,0 +1,54 @@ +WCAL(1) General Commands Manual WCAL(1) + +NAME + wcal – ISO weekly calendar + +SYNOPSIS + wcal [-13yci] [-d YYYY-MM-DD] + +DESCRIPTION + The wcal utility prints a week-oriented calendar. Each week is prefixed + with its ISO week number. + + When outputting to a TTY, the current day is shown in reverse video. + + The options are as follows: + + -1 Show the calendar for the current month. (This is the default.) + + -3 Show the calendar for the previous, current, and next month. + + -y Show the calendar for the whole year. + + -c Show the calendar for the current week. + + -i Show the calendar starting from the current week indefinitely. + + -d YYYY-MM-DDD + Show the calendar for a different date than today. + +EXIT STATUS + The wcal utility exits 0 on success, and >0 if an error occurs. + +SEE ALSO + cal(1) + + wcal is inspired by this online tool: + https://demeyere.design/journal/plain-text-calendar + +AUTHORS + Leah Neukirchen + +LICENSE + wcal is in the public domain. + + To the extent possible under law, the creator of this work has waived all + copyright and related or neighboring rights to this work. + + http://creativecommons.org/publicdomain/zero/1.0/ + +BUGS + This program uses mktime(3) for date manipulation and does not respect + the Gregorian calendar reform. + +Void Linux March 28, 2020 Void Linux -- cgit 1.4.1