]> git.ipfire.org Git - thirdparty/util-linux.git/blame - misc-utils/cal.1
cal: Track date span independently from months_in_row
[thirdparty/util-linux.git] / misc-utils / cal.1
CommitLineData
6dbe3af9
KZ
1.\" Copyright (c) 1989, 1990, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Kim Letkeman.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\" notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\" must display the following acknowledgement:
17.\" This product includes software developed by the University of
18.\" California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\" may be used to endorse or promote products derived from this software
21.\" without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" @(#)cal.1 8.1 (Berkeley) 6/6/93
36.\"
e10f0d07 37.TH CAL 1 "June 2015" "util-linux" "User Commands"
b881ebc6 38.SH NAME
232dc924 39cal \- display a calendar
4b5a1ab8
SK
40.SH SYNOPSIS
41.B cal
f49ccec2
BS
42[options]
43.RI [[[ day ] " month" ] " year" ]
4b5a1ab8 44.SH DESCRIPTION
232dc924
BS
45.B cal
46displays a simple calendar. If no arguments are specified, the current
4b5a1ab8
SK
47month is displayed.
48.SH OPTIONS
49.TP
50\fB\-1\fR, \fB\-\-one\fR
ffc43748
KZ
51Display single month output.
52(This is the default.)
4b5a1ab8
SK
53.TP
54\fB\-3\fR, \fB\-\-three\fR
233ad1fa 55Display three months spanning the date.
4b5a1ab8 56.TP
7800509b 57\fB\-n , \-\-months\fR \fInumber\fR
e10f0d07 58Display \fInumber\fR of months, starting from the month containing the date.
7800509b 59.TP
4b5a1ab8 60\fB\-s\fR, \fB\-\-sunday\fR
ffc43748 61Display Sunday as the first day of the week.
4b5a1ab8
SK
62.TP
63\fB\-m\fR, \fB\-\-monday\fR
eb63b9b8 64Display Monday as the first day of the week.
4b5a1ab8
SK
65.TP
66\fB\-j\fR, \fB\-\-julian\fR
eb63b9b8 67Display Julian dates (days one-based, numbered from January 1).
4b5a1ab8
SK
68.TP
69\fB\-y\fR, \fB\-\-year\fR
233ad1fa 70Display a calendar for the whole year.
4b5a1ab8 71.TP
7800509b
MK
72\fB\-Y, \fB\-\-twelve\fR
73Display a calendar for the next twelve months.
74.TP
af7c483e 75\fB\-w\fR, \fB\-\-week\fR[\fI=number\fR]
c36c4a4e
TK
76Display week numbers in the calendar (US or ISO-8601).
77.TP
d106c83b 78\fB\-\-color\fR[\fI=when\fR]
5d51dc2a
KZ
79Colorize the output. The optional argument \fIwhen\fP
80can be \fBauto\fR, \fBnever\fR or \fBalways\fR. If the \fIwhen\fR argument is omitted,
e10f0d07
BS
81it defaults to \fBauto\fR. The colors can be disabled; for the current built-in default
82see the \fB\-\-help\fR output. See also the \fBCOLORS\fR section.
e47346ff 83.TP
4b5a1ab8 84\fB\-V\fR, \fB\-\-version\fR
14b22761 85Display version information and exit.
4b5a1ab8
SK
86.TP
87\fB\-h\fR, \fB\-\-help\fR
b4362b6f 88Display help text and exit.
4b5a1ab8 89.SH PARAMETERS
3fe71c46 90A single parameter specifies the year to be displayed; note the
4b5a1ab8
SK
91year must be fully specified:
92.B "cal 89"
93will not display a calendar for 1989.
94.PP
6dbe3af9 95Two parameters denote the month (1 - 12) and year.
4b5a1ab8
SK
96.PP
97Three parameters denote the day (1-31), month and year, and the day will be
e10f0d07 98highlighted if the calendar is displayed on a terminal. If no parameters are
4b5a1ab8
SK
99specified, the current month's calendar is displayed.
100.PP
e10f0d07 101A year starts on January 1. The first day of the week is determined by the
4b5a1ab8
SK
102locale.
103.PP
2d4f3bfb
BS
104The week numbering depends on the choice of the first day of the week. If Sunday
105(the default) is used for the first day of the week, then the customary North
106American numbering will be used, i.e. the first Sunday of the year starts the
107first week. If Monday is selected, then the ISO-8601 standard week numbering
108is used, where the first Thursday of the year is in week number 1.
60ec67ff
KZ
109.SH COLORS
110Implicit coloring can be disabled as follows:
111.RS
112
113.br
114.BI "touch /etc/terminal-colors.d/cal.disable"
115.br
116
117.RE
5d51dc2a
KZ
118See
119.BR terminal-colors.d (5)
120for more details about colorization configuration.
bc36e66a
SK
121.SH BUGS
122.PP
123The
124.B cal
cad44d02
BS
125program uses the 3rd of September 1752 as the date of the Gregorian calendar
126reformation -- that is when it happened in Great Britain and its colonies
e10f0d07 127(including what is now the USA). Starting at that date, eleven days were eliminated
cad44d02
BS
128by this reformation, so the calendar for that month is rather unusual.
129The actual historical dates at which the calendar reform happened in all the
130different countries (locales) are ignored.
bc36e66a
SK
131.PP
132Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
133or the lunisolar Hindu, are not supported.
4b5a1ab8
SK
134.SH HISTORY
135A cal command appeared in Version 6 AT&T UNIX.
136.SH AVAILABILITY
601d12fb
KZ
137The cal command is part of the util-linux package and is available from
138ftp://ftp.kernel.org/pub/linux/utils/util-linux/.