xref: /openbsd/usr.bin/cal/cal.1 (revision 891d7ab6)
1.\"	$OpenBSD: cal.1,v 1.24 2010/09/03 11:09:28 jmc Exp $
2.\"	$NetBSD: cal.1,v 1.6 1995/09/02 05:34:20 jtc Exp $
3.\"
4.\" Copyright (c) 1989, 1990, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" Kim Letkeman.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)cal.1	8.2 (Berkeley) 4/28/95
35.\"
36.Dd $Mdocdate: September 3 2010 $
37.Dt CAL 1
38.Os
39.Sh NAME
40.Nm cal
41.Nd displays a calendar
42.Sh SYNOPSIS
43.Nm cal
44.Op Fl jmwy
45.Op Ar month
46.Op Ar year
47.Sh DESCRIPTION
48.Nm
49displays a simple calendar.
50Calendars may be displayed by month or by year.
51.Pp
52The options are as follows:
53.Bl -tag -width Ds
54.It Fl j
55Display Julian dates (days one-based, numbered from January 1).
56The options
57.Fl j
58and
59.Fl w
60are mutually exclusive.
61.It Fl m
62Display weeks starting on Monday instead of Sunday.
63.It Fl w
64Display week numbers in the month display.
65If
66.Fl m
67is specified the ISO week format is assumed.
68The options
69.Fl j
70and
71.Fl w
72are mutually exclusive.
73.It Fl y
74Display a calendar for the current year.
75.El
76.Pp
77A single numerical parameter specifies the
78.Ar year
79(1 \- 9999)
80to be displayed.
81The year must be fully specified:
82.Dq Li cal 89
83will
84.Em not
85display a calendar for 1989.
86Two parameters denote the
87.Ar month
88(1 \- 12, or a month name or abbreviation thereof)
89and
90.Ar year .
91Alternatively,
92a single parameter may be given specifying
93the name or abbreviated name of a month:
94in that case a calendar is displayed for that month of the current year.
95If no parameters are specified, the current month's calendar is
96displayed.
97.Pp
98A year starts on January 1st.
99.Pp
100The Gregorian Reformation is assumed to have occurred in 1752 after the 2nd
101of September.
102By this time, most countries had recognized the reformation (although a
103few did not recognize it until the early 1900's).
104Eleven days following that date were eliminated by the reformation, so the
105calendar for that month is a bit unusual.
106.Sh EXIT STATUS
107.Ex -std cal
108.Sh SEE ALSO
109.Xr calendar 1
110.Sh STANDARDS
111The
112.Nm
113utility is compliant with the
114.St -xpg4
115specification.
116.Pp
117The flags
118.Op Fl jmwy
119are extensions to that specification.
120.Pp
121The week number computed by
122.Fl mw
123is compliant with the ISO 8601 specification.
124.Sh HISTORY
125A
126.Nm
127command appeared in
128.At v6 .
129