]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
cal: cleanup man page
authorKarel Zak <kzak@redhat.com>
Fri, 7 Oct 2016 13:44:18 +0000 (15:44 +0200)
committerKarel Zak <kzak@redhat.com>
Fri, 7 Oct 2016 13:44:18 +0000 (15:44 +0200)
Signed-off-by: Karel Zak <kzak@redhat.com>
misc-utils/cal.1

index 11e97462ce6ff692ee385ed3367240d87bd2016b..2048e95e270c82af121349b4a27eea4bbed9ae6d 100644 (file)
@@ -52,19 +52,6 @@ month is displayed.
 .sp
 The \fImonth\fR may be specified as a number (1-12) or as a month name according
 to the current locales.
-.sp
-.B cal
-accepts special placeholders when parsing \fItimestamp\fR, "now" may be used to
-refer to the current time, "today", "yesterday", "tomorrow" refer to
-of the current day, the day before or the next day, respectively.
-.sp
-The relative date specifications are also accepted, in this case "+" is
-evaluated to the current time plus the specified time span. Correspondingly, a
-time span that is prefixed with "-" is evaluated to the current time minus the
-specified time span, for example '+2days'. Instead of prefixing the time span
-with "+" or "-", it may also be suffixed with a space and the word "left" or
-"ago" (for example '1 week ago').
-
 .SH OPTIONS
 .TP
 \fB\-1\fR, \fB\-\-one\fR
@@ -110,17 +97,32 @@ Display version information and exit.
 \fB\-h\fR, \fB\-\-help\fR
 Display help text and exit.
 .SH PARAMETERS
-A single parameter specifies the year to be displayed; note the
-year must be fully specified:
+.TP
+\fBSingle digits-only parameter (e.g. 'cal 2020')\fR
+Specifies the \fIyear\fR to be displayed; note the year must be fully specified:
 .B "cal 89"
 will not display a calendar for 1989.
-.PP
-Two parameters denote the month (1 - 12) and year.
-.PP
-Three parameters denote the day (1-31), month and year, and the day will be
+.TP
+\fBSingle string parameter (e.g. 'cal tomorrow')\fR
+Specifies \fItimestamp\fR. The special placeholders are accepted when parsing timestamp, "now" may be used to
+refer to the current time, "today", "yesterday", "tomorrow" refer to
+of the current day, the day before or the next day, respectively.
+.sp
+The relative date specifications are also accepted, in this case "+" is
+evaluated to the current time plus the specified time span. Correspondingly, a
+time span that is prefixed with "-" is evaluated to the current time minus the
+specified time span, for example '+2days'. Instead of prefixing the time span
+with "+" or "-", it may also be suffixed with a space and the word "left" or
+"ago" (for example '1 week ago').
+.TP
+\fBTwo parameters (e.g. 'cal 11 2020')\fR
+Denote the \fImonth\fR (1 - 12) and \fIyear\fR.
+.TP
+\fBThree parameters (e.g. 'cal 25 11 2020')\fR
+Denote the \fIday\fR (1-31), \fImonth and \fIyear\fR, and the day will be
 highlighted if the calendar is displayed on a terminal.  If no parameters are
 specified, the current month's calendar is displayed.
-.PP
+.SH NOTES
 A year starts on January 1.  The first day of the week is determined by the
 locale.
 .PP