aboutsummaryrefslogtreecommitdiff
path: root/wcal.1
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 /wcal.1
parentd91a2b325c04884bfe923b64b0a9410167d0e2ab (diff)
downloadwcal-5597886318d0b4ec578b261b49f5bd80baf29538.tar.gz
wcal-5597886318d0b4ec578b261b49f5bd80baf29538.tar.xz
wcal-5597886318d0b4ec578b261b49f5bd80baf29538.zip
add documentation
Diffstat (limited to 'wcal.1')
-rw-r--r--wcal.158
1 files changed, 58 insertions, 0 deletions
diff --git a/wcal.1 b/wcal.1
new file mode 100644
index 0000000..4371958
--- /dev/null
+++ b/wcal.1
@@ -0,0 +1,58 @@
+.Dd March 28, 2020
+.Dt WCAL 1
+.Os
+.Sh NAME
+.Nm wcal
+.Nd ISO weekly calendar
+.Sh SYNOPSIS
+.Nm
+.Op Fl 13yci
+.Op Fl d Ar YYYY-MM-DD
+.Sh DESCRIPTION
+The
+.Nm
+utility prints a week-oriented calendar.
+Each week is prefixed with its ISO week number.
+.Pp
+When outputting to a TTY, the current day is shown in reverse video.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl 1
+Show the calendar for the current month.
+(This is the default.)
+.It Fl 3
+Show the calendar for the previous, current, and next month.
+.It Fl y
+Show the calendar for the whole year.
+.It Fl c
+Show the calendar for the current week.
+.It Fl i
+Show the calendar starting from the current week indefinitely.
+.It Fl d Ar YYYY-MM-DDD
+Show the calendar for a different date than today.
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh SEE ALSO
+.Xr cal 1
+.Pp
+.Nm
+is inspired by this online tool:
+.Lk https://demeyere.design/journal/plain-text-calendar
+.Sh AUTHORS
+.An Leah Neukirchen Aq Mt leah@vuxu.org
+.Sh LICENSE
+.Nm
+is in the public domain.
+.Pp
+To the extent possible under law,
+the creator of this work
+has waived all copyright and related or
+neighboring rights to this work.
+.Pp
+.Lk http://creativecommons.org/publicdomain/zero/1.0/
+.Sh BUGS
+This program uses
+.Xr mktime 3
+for date manipulation and does not respect the Gregorian calendar reform.