]> git.ipfire.org Git - thirdparty/util-linux.git/blame - misc-utils/cal.1
losetup: remove warning for unsupported -e and -E
[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.\"
232dc924 37.TH CAL 1 "June 2011" "util-linux" "User Commands"
b881ebc6 38.SH NAME
232dc924 39cal \- display a calendar
4b5a1ab8
SK
40.SH SYNOPSIS
41.B cal
42[\fIoptions\fR] [[[\fIday\fR] \fImonth\fR] \fIyear\fR]
43.SH DESCRIPTION
232dc924
BS
44.B cal
45displays a simple calendar. If no arguments are specified, the current
4b5a1ab8
SK
46month is displayed.
47.SH OPTIONS
48.TP
49\fB\-1\fR, \fB\-\-one\fR
ffc43748
KZ
50Display single month output.
51(This is the default.)
4b5a1ab8
SK
52.TP
53\fB\-3\fR, \fB\-\-three\fR
233ad1fa 54Display three months spanning the date.
4b5a1ab8
SK
55.TP
56\fB\-s\fR, \fB\-\-sunday\fR
ffc43748 57Display Sunday as the first day of the week.
4b5a1ab8
SK
58.TP
59\fB\-m\fR, \fB\-\-monday\fR
eb63b9b8 60Display Monday as the first day of the week.
4b5a1ab8
SK
61.TP
62\fB\-j\fR, \fB\-\-julian\fR
eb63b9b8 63Display Julian dates (days one-based, numbered from January 1).
4b5a1ab8
SK
64.TP
65\fB\-y\fR, \fB\-\-year\fR
233ad1fa 66Display a calendar for the whole year.
4b5a1ab8 67.TP
af7c483e 68\fB\-w\fR, \fB\-\-week\fR[\fI=number\fR]
c36c4a4e
TK
69Display week numbers in the calendar (US or ISO-8601).
70.TP
e47346ff
SK
71\fB\-\-color\fR [\fIwhen\fR]
72Colorize output. The
73.I when
74can be
75.IR never ,
76.IR auto ,
77or
78.IR always .
79Never will turn off colorizing in all situations. Auto is default, and
80it will make colorizing to be in use if output is done to terminal.
81Always will allow colors to be outputed when
82.B cal
83outputs to pipe, or is called from a script.
84.TP
4b5a1ab8 85\fB\-V\fR, \fB\-\-version\fR
14b22761 86Display version information and exit.
4b5a1ab8
SK
87.TP
88\fB\-h\fR, \fB\-\-help\fR
b4362b6f 89Display help text and exit.
4b5a1ab8 90.SH PARAMETERS
3fe71c46 91A single parameter specifies the year to be displayed; note the
4b5a1ab8
SK
92year must be fully specified:
93.B "cal 89"
94will not display a calendar for 1989.
95.PP
6dbe3af9 96Two parameters denote the month (1 - 12) and year.
4b5a1ab8
SK
97.PP
98Three parameters denote the day (1-31), month and year, and the day will be
99highlighted if the calendar is displayed on a terminal. If no parameters are
100specified, the current month's calendar is displayed.
101.PP
102A year starts on Jan 1. The first day of the week is determined by the
103locale.
104.PP
105The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd of
106September. By this time, most countries had recognized the reformation
107(although a few did not recognize it until the early 1900's). Ten days
108following that date were eliminated by the reformation, so the calendar for
109that month is a bit unusual.
c36c4a4e
TK
110.PP
111The week numbering depends on the first day of the week. If Sunday (the
112default) is used for the first day of the week, then the customary North
113American numbering will be used, i.e. first Sunday of the week starts the
114first week. If Monday is selected, then the ISO-8601 standard week numbering
115is used, where the first Thursday is in week number 1.
4b5a1ab8
SK
116.SH HISTORY
117A cal command appeared in Version 6 AT&T UNIX.
118.SH AVAILABILITY
601d12fb
KZ
119The cal command is part of the util-linux package and is available from
120ftp://ftp.kernel.org/pub/linux/utils/util-linux/.