From e5927d541147dab344d274f02e7c467403883b3f Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Fri, 7 Oct 2016 15:44:18 +0200 Subject: [PATCH] cal: cleanup man page Signed-off-by: Karel Zak --- misc-utils/cal.1 | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/misc-utils/cal.1 b/misc-utils/cal.1 index 11e97462c..2048e95e2 100644 --- a/misc-utils/cal.1 +++ b/misc-utils/cal.1 @@ -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