xref: /freebsd/usr.bin/ncal/ncal.1 (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
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 October 23, 2005
28.Dt CAL 1
29.Os
30.Sh NAME
31.Nm cal ,
32.Nm ncal
33.Nd displays a calendar and the date of Easter
34.Sh SYNOPSIS
35.Nm
36.Op Fl jy
37.Oo
38.Op Ar month
39.Ar year
40.Oc
41.Nm
42.Op Fl j
43.Fl m Ar month
44.Op Ar year
45.Nm ncal
46.Op Fl jJpwy
47.Op Fl s Ar country_code
48.Oo
49.Op Ar month
50.Ar year
51.Oc
52.Nm ncal
53.Op Fl Jeo
54.Op Ar year
55.Sh DESCRIPTION
56The
57.Nm
58utility displays a simple calendar in traditional format and
59.Nm ncal
60offers an alternative layout, more options and the date of Easter.
61The new format is a little cramped but it makes a year fit
62on a 25x80 terminal.
63If arguments are not specified,
64the current month is displayed.
65.Pp
66The options are as follows:
67.Bl -tag -width indent
68.It Fl J
69Display Julian Calendar, if combined with the
70.Fl e
71option, display date of Easter according to the Julian Calendar.
72.It Fl e
73Display date of Easter (for western churches).
74.It Fl j
75Display Julian days (days one-based, numbered from January 1).
76.It Fl m Ar month
77Display the specified
78.Ar month .
79If
80.Ar month
81is specified as a decimal number, it may be followed by the letter
82.Ql f
83or
84.Ql p
85to indicate the following or preceding month of that number,
86respectively.
87.It Fl o
88Display date of Orthodox Easter (Greek and Russian
89Orthodox Churches).
90.It Fl p
91Print the country codes and switching days from Julian to Gregorian
92Calendar as they are assumed by
93.Nm ncal .
94The country code as determined from the local environment is marked
95with an asterisk.
96.It Fl s Ar country_code
97Assume the switch from Julian to Gregorian Calendar at the date
98associated with the
99.Ar country_code .
100If not specified,
101.Nm ncal
102tries to guess the switch date from the local environment or
103falls back to September 2, 1752.
104This was when Great
105Britain and her colonies switched to the Gregorian Calendar.
106.It Fl w
107Print the number of the week below each week column.
108.It Fl y
109Display a calendar for the specified year.
110.El
111.Pp
112A single parameter specifies the year (1\(en9999) to be displayed;
113note the year must be fully specified:
114.Dq Li cal 89
115will
116.Em not
117display a calendar for 1989.
118Two parameters denote the month and year; the month is either a number between
1191 and 12, or a full or abbreviated name as specified by the current locale.
120Month and year default to those of the current system clock and time zone (so
121.Dq Li cal -m 8
122will display a calendar for the month of August in the current year).
123.Pp
124A year starts on January 1.
125.Sh SEE ALSO
126.Xr calendar 3 ,
127.Xr strftime 3
128.Sh HISTORY
129A
130.Nm
131command appeared in
132.At v5 .
133The
134.Nm ncal
135command appeared in
136.Fx 2.2.6 .
137.Sh AUTHORS
138The
139.Nm ncal
140command and manual were written by
141.An Wolfgang Helbig Aq helbig@FreeBSD.org .
142.Sh BUGS
143The assignment of Julian\(enGregorian switching dates to
144country codes is historically naive for many countries.
145.Pp
146The
147.Nm
148utility does not recognize multibyte characters.
149