xref: /freebsd/usr.bin/ncal/ncal.1 (revision 9207b4cff7b8d483f4dd3c62266c2b58819eb7f9)
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 December 16, 1997
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 ncal
42.Op Fl jJpwy
43.Op Fl s Ar country_code
44.Oo
45.Op Ar month
46.Ar year
47.Oc
48.Nm ncal
49.Op Fl Jeo
50.Op Ar year
51.Sh DESCRIPTION
52.Nm Cal
53displays a simple calendar in traditional format and
54.Nm ncal
55offers an alternative layout, more options and the date of easter.
56The new format is a little cramped but it makes a year fit
57on a 25x80 terminal.
58If arguments are not specified,
59the current month is displayed.
60.Pp
61The options are as follows:
62.Bl -tag -width indent
63.It Fl J
64Display Julian Calendar, if combined with the
65.Fl e
66option, display date of easter according to the Julian Calendar.
67.It Fl e
68Display date of easter (for western churches).
69.It Fl j
70Display Julian days (days one-based, numbered from January 1).
71.It Fl o
72Display date of orthodox easter (Greek and Russian
73Orthodox Churches).
74.It Fl p
75Print the country codes and switching days from Julian to Gregorian
76Calendar as they are assumed by
77.Nm ncal .
78The country code as determined from the local environment is marked
79with an asterisk.
80.It Fl s Ar country_code
81Assume the switch from Julian to Gregorian Calendar at the date
82associated with the
83.Ar country_code .
84If not specified,
85.Nm ncal
86tries to guess the switch date from the local environment or
87falls back to September 2, 1752. This was when Great
88Britain and her colonies switched to the Gregorian Calendar.
89.It Fl w
90Print the number of the week below each week column.
91.It Fl y
92Display a calendar for the current year.
93.El
94.Pp
95A single parameter specifies the year (1 - 9999) to be displayed;
96note the year must be fully specified:
97.Dq Li cal 89
98will
99.Em not
100display a calendar for 1989.
101Two parameters denote the month (1 - 12) and year.
102.Pp
103A year starts on Jan 1.
104.Sh SEE ALSO
105.Xr calendar 3 ,
106.Xr strftime 3
107.Sh HISTORY
108A
109.Nm
110command appeared in
111.At v6 .
112The
113.Nm ncal
114command appeared in
115.Fx 2.2.6 .
116.Sh AUTHORS
117The
118.Nm ncal
119command and manual were written by
120.An Wolfgang Helbig Aq helbig@FreeBSD.org .
121.Sh BUGS
122The assignment of Julian - Gregorian switching dates to
123country codes is historically naive for many countries.
124