aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLeah Neukirchen <leah@vuxu.org>2020-03-28 19:16:15 +0100
committerLeah Neukirchen <leah@vuxu.org>2020-03-28 19:16:15 +0100
commit5597886318d0b4ec578b261b49f5bd80baf29538 (patch)
tree1c217765d14644bf2be9676113ea3ddc72763b75 /README
parentd91a2b325c04884bfe923b64b0a9410167d0e2ab (diff)
downloadwcal-5597886318d0b4ec578b261b49f5bd80baf29538.tar.gz
wcal-5597886318d0b4ec578b261b49f5bd80baf29538.tar.xz
wcal-5597886318d0b4ec578b261b49f5bd80baf29538.zip
add documentation
Diffstat (limited to 'README')
-rw-r--r--README54
1 files changed, 54 insertions, 0 deletions
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 <leah@vuxu.org>
+
+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