]> git.ipfire.org Git - thirdparty/util-linux.git/blame - misc-utils/cal.1
cal: clean up few coding style issues
[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.\"
37.Dd June 6, 1993
38.Dt CAL 1
39.Os
40.Sh NAME
41.Nm cal
42.Nd displays a calendar
43.Sh SYNOPSIS
44.Nm cal
ffc43748 45.Op Fl smjy13
eb339585 46.Op [ [ Ar day ] Ar month ] Ar year
6dbe3af9
KZ
47.Sh DESCRIPTION
48.Nm Cal
49displays a simple calendar.
50If arguments are not specified,
51the current month is displayed.
52The options are as follows:
53.Bl -tag -width Ds
66ee8158 54.It Fl 1
ffc43748
KZ
55Display single month output.
56(This is the default.)
66ee8158 57.It Fl 3
ffc43748
KZ
58Display prev/current/next month output.
59.It Fl s
60Display Sunday as the first day of the week.
5c36a0eb 61.It Fl m
eb63b9b8 62Display Monday as the first day of the week.
6dbe3af9 63.It Fl j
eb63b9b8 64Display Julian dates (days one-based, numbered from January 1).
6dbe3af9
KZ
65.It Fl y
66Display a calendar for the current year.
14b22761
LZ
67.It Fl V
68Display version information and exit.
6dbe3af9
KZ
69.El
70.Pp
71A single parameter specifies the year (1 - 9999) to be displayed;
72note the year must be fully specified:
73.Dq Li cal 89
74will
75.Em not
76display a calendar for 1989.
77Two parameters denote the month (1 - 12) and year.
d7a92b89
PB
78Three parameters denote the day (1-31), month and year,
79and the day will be highlighted if the calendar is displayed on a terminal.
6dbe3af9
KZ
80If no parameters are specified, the current month's calendar is
81displayed.
82.Pp
0a9bead0 83A year starts on Jan 1. The first day of the week is determined by the locale.
6dbe3af9
KZ
84.Pp
85The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd
86of September.
87By this time, most countries had recognized the reformation (although a
88few did not recognize it until the early 1900's.)
89Ten days following that date were eliminated by the reformation, so the
90calendar for that month is a bit unusual.
91.Sh HISTORY
92A
93.Nm
94command appeared in Version 6 AT&T UNIX.
86d62711 95.Sh AVAILABILITY
601d12fb
KZ
96The cal command is part of the util-linux package and is available from
97ftp://ftp.kernel.org/pub/linux/utils/util-linux/.