]> git.ipfire.org Git - thirdparty/util-linux.git/blame - misc-utils/cal.1
findmnt: error on --target /non-exist
[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" ]
cd28d6a4
KZ
44.br
45.B cal
46[options]
535fd6d2 47.RI <timestamp|monthname>
4b5a1ab8 48.SH DESCRIPTION
232dc924
BS
49.B cal
50displays a simple calendar. If no arguments are specified, the current
4b5a1ab8 51month is displayed.
731441ac 52.sp
c8805632
KZ
53The \fImonth\fR may be specified as a number (1-12), as a month name or as an
54abbreviated month name according to the current locales.
4b5a1ab8
SK
55.SH OPTIONS
56.TP
57\fB\-1\fR, \fB\-\-one\fR
ffc43748
KZ
58Display single month output.
59(This is the default.)
4b5a1ab8
SK
60.TP
61\fB\-3\fR, \fB\-\-three\fR
233ad1fa 62Display three months spanning the date.
4b5a1ab8 63.TP
7800509b 64\fB\-n , \-\-months\fR \fInumber\fR
e10f0d07 65Display \fInumber\fR of months, starting from the month containing the date.
7800509b 66.TP
ccf3dd50
D
67\fB\-S, \fB\-\-span\fR
68Display months spanning the date.
69.TP
4b5a1ab8 70\fB\-s\fR, \fB\-\-sunday\fR
ffc43748 71Display Sunday as the first day of the week.
4b5a1ab8
SK
72.TP
73\fB\-m\fR, \fB\-\-monday\fR
eb63b9b8 74Display Monday as the first day of the week.
4b5a1ab8
SK
75.TP
76\fB\-j\fR, \fB\-\-julian\fR
eb63b9b8 77Display Julian dates (days one-based, numbered from January 1).
4b5a1ab8
SK
78.TP
79\fB\-y\fR, \fB\-\-year\fR
233ad1fa 80Display a calendar for the whole year.
4b5a1ab8 81.TP
7800509b
MK
82\fB\-Y, \fB\-\-twelve\fR
83Display a calendar for the next twelve months.
84.TP
49b7f95e 85\fB\-w\fR, \fB\-\-week\fR[=\fInumber\fR]
c36c4a4e
TK
86Display week numbers in the calendar (US or ISO-8601).
87.TP
49b7f95e 88\fB\-\-color\fR[=\fIwhen\fR]
5d51dc2a
KZ
89Colorize the output. The optional argument \fIwhen\fP
90can be \fBauto\fR, \fBnever\fR or \fBalways\fR. If the \fIwhen\fR argument is omitted,
e10f0d07
BS
91it defaults to \fBauto\fR. The colors can be disabled; for the current built-in default
92see the \fB\-\-help\fR output. See also the \fBCOLORS\fR section.
e47346ff 93.TP
4b5a1ab8 94\fB\-V\fR, \fB\-\-version\fR
14b22761 95Display version information and exit.
4b5a1ab8
SK
96.TP
97\fB\-h\fR, \fB\-\-help\fR
b4362b6f 98Display help text and exit.
4b5a1ab8 99.SH PARAMETERS
e5927d54
KZ
100.TP
101\fBSingle digits-only parameter (e.g. 'cal 2020')\fR
102Specifies the \fIyear\fR to be displayed; note the year must be fully specified:
4b5a1ab8
SK
103.B "cal 89"
104will not display a calendar for 1989.
e5927d54 105.TP
535fd6d2 106\fBSingle string parameter (e.g. 'cal tomorrow' or 'cal August')\fR
c8805632 107Specifies \fItimestamp\fR or a \fImonth name\fR (or abbreviated name) according to the current
535fd6d2
KZ
108locales.
109.sp
110The special placeholders are accepted when parsing timestamp, "now" may be used
111to refer to the current time, "today", "yesterday", "tomorrow" refer to of the
112current day, the day before or the next day, respectively.
e5927d54
KZ
113.sp
114The relative date specifications are also accepted, in this case "+" is
115evaluated to the current time plus the specified time span. Correspondingly, a
116time span that is prefixed with "-" is evaluated to the current time minus the
117specified time span, for example '+2days'. Instead of prefixing the time span
118with "+" or "-", it may also be suffixed with a space and the word "left" or
119"ago" (for example '1 week ago').
120.TP
121\fBTwo parameters (e.g. 'cal 11 2020')\fR
122Denote the \fImonth\fR (1 - 12) and \fIyear\fR.
123.TP
124\fBThree parameters (e.g. 'cal 25 11 2020')\fR
125Denote the \fIday\fR (1-31), \fImonth and \fIyear\fR, and the day will be
e10f0d07 126highlighted if the calendar is displayed on a terminal. If no parameters are
4b5a1ab8 127specified, the current month's calendar is displayed.
e5927d54 128.SH NOTES
e10f0d07 129A year starts on January 1. The first day of the week is determined by the
4b5a1ab8
SK
130locale.
131.PP
2d4f3bfb
BS
132The week numbering depends on the choice of the first day of the week. If Sunday
133(the default) is used for the first day of the week, then the customary North
134American numbering will be used, i.e. the first Sunday of the year starts the
135first week. If Monday is selected, then the ISO-8601 standard week numbering
136is used, where the first Thursday of the year is in week number 1.
60ec67ff
KZ
137.SH COLORS
138Implicit coloring can be disabled as follows:
139.RS
140
141.br
142.BI "touch /etc/terminal-colors.d/cal.disable"
143.br
144
145.RE
5d51dc2a
KZ
146See
147.BR terminal-colors.d (5)
148for more details about colorization configuration.
bc36e66a
SK
149.SH BUGS
150.PP
151The
152.B cal
cad44d02
BS
153program uses the 3rd of September 1752 as the date of the Gregorian calendar
154reformation -- that is when it happened in Great Britain and its colonies
e10f0d07 155(including what is now the USA). Starting at that date, eleven days were eliminated
cad44d02
BS
156by this reformation, so the calendar for that month is rather unusual.
157The actual historical dates at which the calendar reform happened in all the
158different countries (locales) are ignored.
bc36e66a
SK
159.PP
160Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
161or the lunisolar Hindu, are not supported.
4b5a1ab8
SK
162.SH HISTORY
163A cal command appeared in Version 6 AT&T UNIX.
164.SH AVAILABILITY
601d12fb
KZ
165The cal command is part of the util-linux package and is available from
166ftp://ftp.kernel.org/pub/linux/utils/util-linux/.