2006-12-06 17:25:32 -06:00
|
|
|
.\" Copyright (c) 1989, 1990, 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
|
|
.\" Kim Letkeman.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" @(#)cal.1 8.1 (Berkeley) 6/6/93
|
|
|
|
.\"
|
2018-01-16 12:08:31 -06:00
|
|
|
.TH CAL 1 "January 2018" "util-linux" "User Commands"
|
2011-08-02 07:55:55 -05:00
|
|
|
.SH NAME
|
2011-08-18 15:18:34 -05:00
|
|
|
cal \- display a calendar
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.B cal
|
2014-12-14 13:45:29 -06:00
|
|
|
[options]
|
|
|
|
.RI [[[ day ] " month" ] " year" ]
|
2016-05-31 11:27:20 -05:00
|
|
|
.br
|
|
|
|
.B cal
|
|
|
|
[options]
|
2018-02-07 04:06:58 -06:00
|
|
|
.RI [ "timestamp" | "monthname" ]
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH DESCRIPTION
|
2011-08-18 15:18:34 -05:00
|
|
|
.B cal
|
|
|
|
displays a simple calendar. If no arguments are specified, the current
|
2011-06-11 15:27:18 -05:00
|
|
|
month is displayed.
|
2016-05-31 06:53:58 -05:00
|
|
|
.sp
|
2016-10-07 09:10:28 -05:00
|
|
|
The \fImonth\fR may be specified as a number (1-12), as a month name or as an
|
|
|
|
abbreviated month name according to the current locales.
|
2018-01-16 12:08:31 -06:00
|
|
|
.sp
|
|
|
|
Two different calendar systems are used, Gregorian and Julian. These are
|
|
|
|
nearly identical systems with Gregorian making a small adjustment to the
|
|
|
|
frequency of leap years; this facilitates improved synchronization with solar
|
|
|
|
events like the equinoxes. The Gregorian calendar reform was introduced in
|
|
|
|
1582, but its adoption continued up to 1923. By default
|
|
|
|
.B cal
|
|
|
|
uses the adoption date of 3 Sept 1752. From that date forward the Gregorian
|
|
|
|
calendar is displayed; previous dates use the Julian calendar system. 11 days
|
|
|
|
were removed at the time of adoption to bring the calendar in sync with solar
|
|
|
|
events. So Sept 1752 has a mix of Julian and Gregorian dates by which the 2nd
|
|
|
|
is followed by the 14th (the 3rd through the 13th are absent).
|
|
|
|
.sp
|
|
|
|
Optionally, either the proleptic Gregorian calendar or the Julian calendar may
|
|
|
|
be used exclusively.
|
|
|
|
.RB See\ \-\-reform\ below.
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
|
|
\fB\-1\fR, \fB\-\-one\fR
|
2006-12-06 17:25:53 -06:00
|
|
|
Display single month output.
|
|
|
|
(This is the default.)
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-3\fR, \fB\-\-three\fR
|
2013-10-09 13:44:12 -05:00
|
|
|
Display three months spanning the date.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
2015-04-07 06:05:39 -05:00
|
|
|
\fB\-n , \-\-months\fR \fInumber\fR
|
2015-06-24 13:58:06 -05:00
|
|
|
Display \fInumber\fR of months, starting from the month containing the date.
|
2015-04-07 06:05:39 -05:00
|
|
|
.TP
|
2015-10-09 19:39:02 -05:00
|
|
|
\fB\-S, \fB\-\-span\fR
|
|
|
|
Display months spanning the date.
|
|
|
|
.TP
|
2011-06-11 15:27:18 -05:00
|
|
|
\fB\-s\fR, \fB\-\-sunday\fR
|
2006-12-06 17:25:53 -06:00
|
|
|
Display Sunday as the first day of the week.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-m\fR, \fB\-\-monday\fR
|
2006-12-06 17:25:41 -06:00
|
|
|
Display Monday as the first day of the week.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
2020-05-11 10:41:33 -05:00
|
|
|
\fB\-v\fR, \fB\-\-vertical\fR
|
|
|
|
Display using a vertical layout (aka ncal mode).
|
|
|
|
.TP
|
2018-01-16 12:08:31 -06:00
|
|
|
.B \-\-iso
|
2020-01-03 05:04:00 -06:00
|
|
|
Display the proleptic Gregorian calendar exclusively. This option does not affect
|
|
|
|
week numbers and the first day of the week.
|
2018-01-16 12:08:31 -06:00
|
|
|
.RB See\ \-\-reform\ below.
|
|
|
|
.TP
|
2011-06-11 15:27:18 -05:00
|
|
|
\fB\-j\fR, \fB\-\-julian\fR
|
2018-01-16 12:08:31 -06:00
|
|
|
Use day-of-year numbering for all calendars. These are also called ordinal
|
|
|
|
days. Ordinal days range from 1 to 366. This option does not switch from the
|
|
|
|
Gregorian to the Julian calendar system, that is controlled by the
|
|
|
|
.BR \-\-reform\ option.
|
|
|
|
.sp
|
|
|
|
Sometimes Gregorian calendars using ordinal dates are referred to as Julian
|
|
|
|
calendars. This can be confusing due to the many date related conventions that
|
|
|
|
use Julian in their name: (ordinal) julian date, julian (calendar) date,
|
|
|
|
(astronomical) julian date, (modified) julian date, and more. This option is
|
|
|
|
named julian, because ordinal days are identified as julian by the POSIX
|
|
|
|
standard. However, be aware that
|
|
|
|
.B cal
|
|
|
|
also uses the Julian calendar system.
|
|
|
|
.RB See\ DESCRIPTION\ above.
|
|
|
|
.TP
|
|
|
|
.BI \-\-reform\ val
|
|
|
|
This option sets the adoption date of the Gregorian calendar reform. Calendar
|
|
|
|
dates previous to reform use the Julian calendar system. Calendar dates
|
|
|
|
after reform use the Gregorian calendar system. The argument
|
|
|
|
.I val
|
|
|
|
can be:
|
|
|
|
.RS
|
|
|
|
.IP \(bu 2
|
|
|
|
.I 1752
|
|
|
|
- sets 3 September 1752 as the reform date (default).
|
|
|
|
This is when the Gregorian calendar reform was adopted by the British Empire.
|
|
|
|
.IP \(bu 2
|
|
|
|
.I gregorian
|
|
|
|
- display Gregorian calendars exclusively. This special placeholder sets the
|
|
|
|
reform date below the smallest year that
|
|
|
|
.B cal
|
|
|
|
can use; meaning all calendar output uses the Gregorian calendar system. This
|
|
|
|
is called the proleptic Gregorian calendar, because dates prior to the calendar
|
|
|
|
system's creation use extrapolated values.
|
|
|
|
.IP \(bu 2
|
|
|
|
.I iso
|
|
|
|
- alias of
|
|
|
|
.IR gregorian .
|
|
|
|
The ISO 8601 standard for the representation of dates and times in information
|
|
|
|
interchange requires using the proleptic Gregorian calendar.
|
|
|
|
.IP \(bu 2
|
|
|
|
.I julian
|
|
|
|
- display Julian calendars exclusively. This special placeholder sets the reform date above the largest year that
|
|
|
|
.B cal
|
|
|
|
can use; meaning all
|
|
|
|
calendar output uses the Julian calendar system.
|
|
|
|
.PP
|
|
|
|
.RB See\ \%DESCRIPTION\ above.
|
|
|
|
.RE
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-y\fR, \fB\-\-year\fR
|
2013-10-09 13:44:12 -05:00
|
|
|
Display a calendar for the whole year.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
2015-04-07 06:05:39 -05:00
|
|
|
\fB\-Y, \fB\-\-twelve\fR
|
|
|
|
Display a calendar for the next twelve months.
|
|
|
|
.TP
|
2016-03-17 04:54:31 -05:00
|
|
|
\fB\-w\fR, \fB\-\-week\fR[=\fInumber\fR]
|
2020-01-03 05:04:00 -06:00
|
|
|
Display week numbers in the calendar (US or ISO-8601). See NOTES section
|
|
|
|
for more details.
|
2013-10-06 13:44:45 -05:00
|
|
|
.TP
|
2016-03-17 04:54:31 -05:00
|
|
|
\fB\-\-color\fR[=\fIwhen\fR]
|
2015-02-25 05:37:55 -06:00
|
|
|
Colorize the output. The optional argument \fIwhen\fP
|
|
|
|
can be \fBauto\fR, \fBnever\fR or \fBalways\fR. If the \fIwhen\fR argument is omitted,
|
2015-06-24 13:58:06 -05:00
|
|
|
it defaults to \fBauto\fR. The colors can be disabled; for the current built-in default
|
|
|
|
see the \fB\-\-help\fR output. See also the \fBCOLORS\fR section.
|
2013-05-01 17:12:16 -05:00
|
|
|
.TP
|
2011-06-11 15:27:18 -05:00
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
2007-09-03 01:25:40 -05:00
|
|
|
Display version information and exit.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
2013-10-14 14:34:39 -05:00
|
|
|
Display help text and exit.
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH PARAMETERS
|
2016-10-07 08:44:18 -05:00
|
|
|
.TP
|
2019-12-14 16:42:47 -06:00
|
|
|
\fBSingle digits-only parameter (e.g., 'cal 2020')\fR
|
2016-10-07 08:44:18 -05:00
|
|
|
Specifies the \fIyear\fR to be displayed; note the year must be fully specified:
|
2011-06-11 15:27:18 -05:00
|
|
|
.B "cal 89"
|
|
|
|
will not display a calendar for 1989.
|
2016-10-07 08:44:18 -05:00
|
|
|
.TP
|
2019-12-14 16:42:47 -06:00
|
|
|
\fBSingle string parameter (e.g., 'cal tomorrow' or 'cal August')\fR
|
2016-10-07 09:10:28 -05:00
|
|
|
Specifies \fItimestamp\fR or a \fImonth name\fR (or abbreviated name) according to the current
|
2016-10-07 09:02:36 -05:00
|
|
|
locales.
|
|
|
|
.sp
|
|
|
|
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.
|
2016-10-07 08:44:18 -05:00
|
|
|
.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
|
2019-12-14 16:42:47 -06:00
|
|
|
\fBTwo parameters (e.g., 'cal 11 2020')\fR
|
2016-10-07 08:44:18 -05:00
|
|
|
Denote the \fImonth\fR (1 - 12) and \fIyear\fR.
|
|
|
|
.TP
|
2019-12-14 16:42:47 -06:00
|
|
|
\fBThree parameters (e.g., 'cal 25 11 2020')\fR
|
2016-10-07 08:44:18 -05:00
|
|
|
Denote the \fIday\fR (1-31), \fImonth and \fIyear\fR, and the day will be
|
2015-06-24 13:58:06 -05:00
|
|
|
highlighted if the calendar is displayed on a terminal. If no parameters are
|
2011-06-11 15:27:18 -05:00
|
|
|
specified, the current month's calendar is displayed.
|
2016-10-07 08:44:18 -05:00
|
|
|
.SH NOTES
|
2015-06-24 13:58:06 -05:00
|
|
|
A year starts on January 1. The first day of the week is determined by the
|
2018-01-22 06:03:27 -06:00
|
|
|
locale or the
|
|
|
|
.BR \-\-sunday \ and \ \-\-monday \ options.
|
2011-06-11 15:27:18 -05:00
|
|
|
.PP
|
2018-01-22 06:03:27 -06:00
|
|
|
The week numbering depends on the choice of the first day of the week. If it
|
|
|
|
is Sunday then the customary North American numbering is used, where 1 January
|
2020-01-03 05:04:00 -06:00
|
|
|
is in week number 1. If it is Monday (\fB\-m\fR) then the ISO 8601 standard week
|
|
|
|
numbering is used, where the first Thursday is in week number 1.
|
2014-03-11 04:05:32 -05:00
|
|
|
.SH COLORS
|
|
|
|
Implicit coloring can be disabled as follows:
|
|
|
|
.RS
|
|
|
|
|
2018-05-18 14:21:42 -05:00
|
|
|
.B touch /etc/terminal-colors.d/cal.disable
|
2014-03-11 04:05:32 -05:00
|
|
|
|
|
|
|
.RE
|
2015-02-25 05:37:55 -06:00
|
|
|
See
|
|
|
|
.BR terminal-colors.d (5)
|
|
|
|
for more details about colorization configuration.
|
Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently
There is value in ensuring that manual page sections use consistently
named sections, as far as possible, and also that sections have a
consistent order within manual pages. This is one of a series of patches
to place manual page sections in a consistent order.
In this patch, we ensure that the NOTES, HISTORY, BUGS, and EXAMPLE
sections are always placed near the end of the page, just above
AUTHORS, COPYRIGHT, SEE ALSO, and AVAILABILITY.
One page is not fixed by this patch: term-utils/agetty.8. This page
is a mess of unusual section names, and probably requires an individual
edit.
Testing that no gross editing mistake (causing accidental loss or addition
of text) was performed as follows:
$ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > a
[Apply patch]
$ cat $(grep '\.SH' -l $(find . -name '*.[1-9]') |sort) | sort > b
$ diff a b
$ echo $?
0
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-05-21 02:28:32 -05:00
|
|
|
.SH HISTORY
|
|
|
|
A cal command appeared in Version 6 AT&T UNIX.
|
2013-12-22 12:06:04 -06:00
|
|
|
.SH BUGS
|
2018-01-16 12:08:31 -06:00
|
|
|
The default
|
2013-12-22 12:06:04 -06:00
|
|
|
.B cal
|
2018-01-16 12:08:31 -06:00
|
|
|
output uses 3 September 1752 as the Gregorian calendar reform date. The
|
|
|
|
historical reform dates for the other locales, including its introduction in
|
|
|
|
October 1582, are not implemented.
|
2013-12-22 12:06:04 -06:00
|
|
|
.PP
|
|
|
|
Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
|
|
|
|
or the lunisolar Hindu, are not supported.
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH AVAILABILITY
|
2010-11-30 04:41:59 -06:00
|
|
|
The cal command is part of the util-linux package and is available from
|
2016-12-17 02:06:57 -06:00
|
|
|
https://www.kernel.org/pub/linux/utils/util-linux/.
|