Annotation of src/usr.bin/cal/cal.1, Revision 1.20
1.20 ! jmc 1: .\" $OpenBSD: cal.1,v 1.19 2008/04/18 14:41:04 pyr Exp $
1.1 deraadt 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.
1.11 millert 18: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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: .\"
1.20 ! jmc 36: .Dd $Mdocdate: April 18 2008 $
1.1 deraadt 37: .Dt CAL 1
38: .Os
39: .Sh NAME
40: .Nm cal
41: .Nd displays a calendar
42: .Sh SYNOPSIS
43: .Nm cal
1.20 ! jmc 44: .Op Fl jmwy
1.15 tom 45: .Op Ar month
46: .Op Ar year
1.1 deraadt 47: .Sh DESCRIPTION
1.8 aaron 48: .Nm
1.1 deraadt 49: displays a simple calendar.
1.13 jmc 50: Calendars may be displayed by month or by year.
1.9 aaron 51: .Pp
1.1 deraadt 52: The options are as follows:
53: .Bl -tag -width Ds
54: .It Fl j
1.9 aaron 55: Display Julian dates (days one-based, numbered from January 1).
1.19 pyr 56: The options
57: .Fl j
58: and
59: .Fl w
60: are mutually exclusive.
1.18 pyr 61: .It Fl m
62: Display weeks starting on Monday instead of Sunday.
1.19 pyr 63: .It Fl w
64: Display week numbers in the month display.
65: If
66: .Fl m
1.20 ! jmc 67: is specified the ISO week format is assumed.
1.19 pyr 68: The options
69: .Fl j
70: and
71: .Fl w
72: are mutually exclusive.
1.1 deraadt 73: .It Fl y
74: Display a calendar for the current year.
75: .El
76: .Pp
1.13 jmc 77: A single numerical parameter specifies the
78: .Ar year
79: (1 \- 9999)
80: to be displayed.
81: The year must be fully specified:
1.1 deraadt 82: .Dq Li cal 89
83: will
84: .Em not
85: display a calendar for 1989.
1.14 tom 86: Two parameters denote the
1.13 jmc 87: .Ar month
1.14 tom 88: (1 \- 12, or a month name or abbreviation thereof)
1.13 jmc 89: and
90: .Ar year .
91: Alternatively,
1.14 tom 92: a single parameter may be given specifying
93: the name or abbreviated name of a month:
1.13 jmc 94: in that case a calendar is displayed for that month of the current year.
1.1 deraadt 95: If no parameters are specified, the current month's calendar is
96: displayed.
97: .Pp
1.9 aaron 98: A year starts on January 1st.
1.1 deraadt 99: .Pp
1.20 ! jmc 100: The Gregorian Reformation is assumed to have occurred in 1752 after the 2nd
1.1 deraadt 101: of September.
102: By this time, most countries had recognized the reformation (although a
1.10 aaron 103: few did not recognize it until the early 1900's).
1.5 deraadt 104: Eleven days following that date were eliminated by the reformation, so the
1.1 deraadt 105: calendar for that month is a bit unusual.
1.9 aaron 106: .Sh SEE ALSO
107: .Xr calendar 1
1.4 denny 108: .Sh STANDARDS
109: The
1.8 aaron 110: .Nm
1.16 jmc 111: utility is compliant with the
112: .St -p1003.1-2004
113: specification.
114: .Pp
115: The flags
1.19 pyr 116: .Op Fl jmwy
1.16 jmc 117: are extensions to that specification.
1.19 pyr 118: .Pp
119: The week number computed by
120: .Fl mw
121: is compliant with the ISO 8601 specification.
1.1 deraadt 122: .Sh HISTORY
123: A
124: .Nm
1.7 aaron 125: command appeared in
1.1 deraadt 126: .At v6 .