ncal.1 (531a1a4b2cdc1420829e631448322c0babc2963b) ncal.1 (0cb2e609d9c2f0ceaf730a57ac5c11580058e7f4)
1.\" Copyright (c) 1997 Wolfgang Helbig
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd March 14, 2009
1/*-
2 * Copyright (c) 1997 Wolfgang Helbig
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $Id$
27 */
28.Dd December 16, 1997
28.Dt CAL 1
29.Os
30.Sh NAME
31.Nm cal ,
32.Nm ncal
29.Dt CAL 1
30.Os
31.Sh NAME
32.Nm cal ,
33.Nm ncal
33.Nd displays a calendar and the date of Easter
34.Nd displays a calendar and the date of easter
34.Sh SYNOPSIS
35.Sh SYNOPSIS
35.Nm
36.Op Fl 3hjy
37.Op Fl A Ar number
38.Op Fl B Ar number
39.Oo
40.Op Ar month
41.Ar year
42.Oc
43.Nm
44.Op Fl 3hj
45.Op Fl A Ar number
46.Op Fl B Ar number
47.Fl m Ar month
48.Op Ar year
36.Nm cal
37.Op Fl jy
38.Op Oo Ar month Oc Ar \ year
49.Nm ncal
39.Nm ncal
50.Op Fl 3hjJpwy
51.Op Fl A Ar number
52.Op Fl B Ar number
53.Op Fl s Ar country_code
54.Oo
55.Op Ar month
56.Ar year
57.Oc
40.Op Fl jJpwy
41.Op Fl s Ar country code
42.Op Oo Ar month Oc Ar \ year
58.Nm ncal
43.Nm ncal
59.Op Fl 3hJeo
60.Op Fl A Ar number
61.Op Fl B Ar number
44.Op Fl Jeo
62.Op Ar year
45.Op Ar year
63.Nm ncal
64.Op Fl CN
65.Op Fl H Ar yyyy-mm-dd
66.Op Fl d Ar yyyy-mm
67.Sh DESCRIPTION
46.Sh DESCRIPTION
68The
69.Nm
70utility displays a simple calendar in traditional format and
47.Nm Cal
48displays a simple calendar in traditional format and
71.Nm ncal
49.Nm ncal
72offers an alternative layout, more options and the date of Easter.
50offers an alternative layout, more options and the date of easter.
73The new format is a little cramped but it makes a year fit
74on a 25x80 terminal.
75If arguments are not specified,
76the current month is displayed.
51The new format is a little cramped but it makes a year fit
52on a 25x80 terminal.
53If arguments are not specified,
54the current month is displayed.
77.Pp
78The options are as follows:
55The options are as follows:
79.Bl -tag -width indent
80.It Fl h
81Turns off highlighting of today.
56.Bl -tag -width Ds
82.It Fl J
83Display Julian Calendar, if combined with the
84.Fl e
57.It Fl J
58Display Julian Calendar, if combined with the
59.Fl e
85option, display date of Easter according to the Julian Calendar.
60option, display date of easter according in the Julian Calendar.
61If not specified, the Gregorian Calendar is assumed after
62the switch date and Julian before. (See below)
86.It Fl e
63.It Fl e
87Display date of Easter (for western churches).
64Display date of easter (for western churches).
88.It Fl j
65.It Fl j
89Display Julian days (days one-based, numbered from January 1).
90.It Fl m Ar month
91Display the specified
92.Ar month .
93If
94.Ar month
95is specified as a decimal number, it may be followed by the letter
96.Ql f
97or
98.Ql p
99to indicate the following or preceding month of that number,
100respectively.
66Display julian days (days one-based, numbered from January 1).
101.It Fl o
67.It Fl o
102Display date of Orthodox Easter (Greek and Russian
68Display date of orthodox easter (Greek and Russian
103Orthodox Churches).
104.It Fl p
69Orthodox Churches).
70.It Fl p
105Print the country codes and switching days from Julian to Gregorian
71Print the country codes and switch dates from Julian to Gregorian
106Calendar as they are assumed by
107.Nm ncal .
72Calendar as they are assumed by
73.Nm ncal .
108The country code as determined from the local environment is marked
109with an asterisk.
110.It Fl s Ar country_code
74.It Fl s Ar country-code
111Assume the switch from Julian to Gregorian Calendar at the date
112associated with the
75Assume the switch from Julian to Gregorian Calendar at the date
76associated with the
113.Ar country_code .
77.Ar country-code .
114If not specified,
115.Nm ncal
78If not specified,
79.Nm ncal
116tries to guess the switch date from the local environment or
117falls back to September 2, 1752.
118This was when Great
119Britain and her colonies switched to the Gregorian Calendar.
80assumes October 4, 1582 (on this day the Catholic Church switched to Gregorian
81Calendar) and
82.Nm cal
83thinks with Great Britain and her colonies that
84September 2, 1752 was the date to switch.
120.It Fl w
85.It Fl w
121Print the number of the week below each week column.
86Print the number of the week in the year below each week displayed.
122.It Fl y
87.It Fl y
123Display a calendar for the specified year.
124.It Fl 3
125Display the previous, current and next month surrounding today.
126.It Fl A Ar number
127Display the
128.Ar number
129of months after the current month.
130.It Fl B Ar number
131Display the
132.Ar number
133of months before the current month.
134.It Fl C
135Switch to
136.Nm cal
137mode.
138.It Fl N
139Switch to
140.Nm ncal
141mode.
142.It Fl d Ar yyyy-mm
143Use
144.Ar yyyy-mm
145as the current date (for debugging of date selection).
146.It Fl H Ar yyyy-mm-dd
147Use
148.Ar yyyy-mm-dd
149as the current date (for debugging of highlighting).
88Display a calendar for the current year.
150.El
151.Pp
89.El
90.Pp
152A single parameter specifies the year (1\(en9999) to be displayed;
91A single parameter specifies the year (1 - 9999) to be displayed;
153note the year must be fully specified:
154.Dq Li cal 89
155will
156.Em not
92note the year must be fully specified:
93.Dq Li cal 89
94will
95.Em not
157display a calendar for 1989. Two parameters denote the month and
158year; the month is either a number between 1 and 12, or a full or
159abbreviated name as specified by the current locale. Month and
160year default to those of the current system clock and time zone (so
161.Dq Li cal -m 8
162will display a calendar for the month of August in the current
163year).
96display a calendar for 1989.
97Two parameters denote the month (1 - 12) and year.
164.Pp
98.Pp
165Not all options can be used together. For example
166.Dq Li -3 -A 2 -B 3 -y -m 7
167would mean:
168show me the three months around the seventh month, three before
169that, two after that and the whole year.
170.Nm ncal
171will warn about these combinations.
99A year starts on Jan 1.
172.Pp
100.Pp
173A year starts on January 1.
174.Sh SEE ALSO
175.Xr calendar 3 ,
176.Xr strftime 3
101.Sh SEE ALSO
102.Xr calendar 3 ,
103.Xr strftime 3
104.Rs
177.Sh HISTORY
178A
105.Sh HISTORY
106A
179.Nm
107.Nm cal
180command appeared in
108command appeared in
181.At v5 .
109.At v6 .
182The
183.Nm ncal
184command appeared in
110The
111.Nm ncal
112command appeared in
185.Fx 2.2.6 .
186.Sh AUTHORS
187The
188.Nm ncal
189command and manual were written by
190.An Wolfgang Helbig Aq helbig@FreeBSD.org .
191.Sh BUGS
192The assignment of Julian\(enGregorian switching dates to country
193codes is historically naive for many countries.
194.Pp
195Not all options are compatible and using them in different orders
196will give varying results.
113.Fx 3.0 .
114.Sh AUTHOR
115This
116manual page and the command was written by
117.An Wolfgang Helbig Aq helbig@FreeBSD.ORG .