add documentation

2 files changed, 112 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
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.