xref: /dragonfly/usr.bin/ncal/ncal.1 (revision 9ddb8543)
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: src/usr.bin/ncal/ncal.1,v 1.8.2.7 2002/10/23 08:10:00 roam Exp $
26.\" $DragonFly: src/usr.bin/ncal/ncal.1,v 1.4 2005/07/31 11:46:52 asmodai Exp $
27.\"
28.Dd March 12, 2009
29.Dt CAL 1
30.Os
31.Sh NAME
32.Nm cal ,
33.Nm ncal
34.Nd displays a calendar and the date of easter
35.Sh SYNOPSIS
36.Nm
37.Op Fl jy
38.Op Fl m Ar month
39.Oo
40.Op Ar month
41.Ar year
42.Oc
43.Nm ncal
44.Op Fl jJpwy
45.Op Fl m Ar month
46.Op Fl s Ar country_code
47.Oo
48.Op Ar month
49.Ar year
50.Oc
51.Nm ncal
52.Op Fl Jeo
53.Op Ar year
54.Sh DESCRIPTION
55The
56.Nm
57utility displays a simple calendar in traditional format and
58.Nm ncal
59offers an alternative layout, more options and the date of easter.
60The new format is a little cramped but it makes a year fit
61on a 25x80 terminal.
62If arguments are not specified,
63the current month is displayed.
64.Pp
65The options are as follows:
66.Bl -tag -width indent
67.It Fl J
68Display Julian Calendar, if combined with the
69.Fl e
70option, display date of easter according to the Julian Calendar.
71.It Fl e
72Display date of easter (for western churches).
73.It Fl j
74Display Julian days (days one-based, numbered from January 1).
75.It Fl m Ar month
76Display the specified
77.Ar month .
78.It Fl o
79Display date of orthodox easter (Greek and Russian
80Orthodox Churches).
81.It Fl p
82Print the country codes and switching days from Julian to Gregorian
83Calendar as they are assumed by
84.Nm ncal .
85The country code as determined from the local environment is marked
86with an asterisk.
87.It Fl s Ar country_code
88Assume the switch from Julian to Gregorian Calendar at the date
89associated with the
90.Ar country_code .
91If not specified,
92.Nm ncal
93tries to guess the switch date from the local environment or
94falls back to September 2, 1752. This was when Great
95Britain and her colonies switched to the Gregorian Calendar.
96.It Fl w
97Print the number of the week below each week column.
98.It Fl y
99Display a calendar for the current year.
100.El
101.Pp
102A single parameter specifies the year (1 - 9999) to be displayed;
103note the year must be fully specified.
104Two parameters denote the month and year; the
105.Ar month
106is either a number between
1071 and 12, or a full or abbreviated name as specified by the current locale.
108A single dot,
109.Ql \&. ,
110for the
111.Ar year
112parameter refers to the current year.
113.Pp
114A year starts on Jan 1.
115.Sh DIAGNOSTICS
116The
117.Nm
118utility returns 0 on success or >0 if an error occurred.
119.Sh SEE ALSO
120.Xr calendar 3 ,
121.Xr strftime 3
122.Sh STANDARDS
123The
124.Nm
125utility conforms to
126.St -p1003.1-2004
127and is ahead of the standard with locale-specific Gregorian adoption details.
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 - Gregorian switching dates to
144country codes is historically naive for many countries.
145