freebsd-dev/usr.bin/ncal/ncal.1

.\" Copyright (c) 1997 Wolfgang Helbig
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 14, 2009
.Dt CAL 1
.Os
.Sh NAME
.Nm cal ,
.Nm ncal
.Nd displays a calendar and the date of Easter
.Sh SYNOPSIS
.Nm
.Op Fl hjy
.Oo
.Op Ar month
.Ar year
.Oc
.Nm
.Op Fl hj
.Fl m Ar month
.Op Ar year
.Nm ncal
.Op Fl hjJpwy
.Op Fl s Ar country_code
.Oo
.Op Ar month
.Ar year
.Oc
.Nm ncal
.Op Fl hJeo
.Op Ar year
.Sh DESCRIPTION
The
.Nm
utility displays a simple calendar in traditional format and
.Nm ncal
offers an alternative layout, more options and the date of Easter.
The new format is a little cramped but it makes a year fit
on a 25x80 terminal.
If arguments are not specified,
the current month is displayed.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl h
Turns off highlighting of today.
.It Fl J
Display Julian Calendar, if combined with the
.Fl e
option, display date of Easter according to the Julian Calendar.
.It Fl e
Display date of Easter (for western churches).
.It Fl j
Display Julian days (days one-based, numbered from January 1).
.It Fl m Ar month
Display the specified
.Ar month .
If
.Ar month
is specified as a decimal number, it may be followed by the letter
.Ql f
or
.Ql p
to indicate the following or preceding month of that number,
respectively.
.It Fl o
Display date of Orthodox Easter (Greek and Russian
Orthodox Churches).
.It Fl p
Print the country codes and switching days from Julian to Gregorian
Calendar as they are assumed by
.Nm ncal .
The country code as determined from the local environment is marked
with an asterisk.
.It Fl s Ar country_code
Assume the switch from Julian to Gregorian Calendar at the date
associated with the
.Ar country_code .
If not specified,
.Nm ncal
tries to guess the switch date from the local environment or
falls back to September 2, 1752.
This was when Great
Britain and her colonies switched to the Gregorian Calendar.
.It Fl w
Print the number of the week below each week column.
.It Fl y
Display a calendar for the specified year.
.El
.Pp
A single parameter specifies the year (1\(en9999) to be displayed;
note the year must be fully specified:
.Dq Li cal 89
will
.Em not
display a calendar for 1989.
Two parameters denote the month and year; the month is either a number between
1 and 12, or a full or abbreviated name as specified by the current locale.
Month and year default to those of the current system clock and time zone (so
.Dq Li cal -m 8
will display a calendar for the month of August in the current year).
.Pp
A year starts on January 1.
.Sh SEE ALSO
.Xr calendar 3 ,
.Xr strftime 3
.Sh HISTORY
A
.Nm
command appeared in
.At v5 .
The
.Nm ncal
command appeared in
.Fx 2.2.6 .
.Sh AUTHORS
The
.Nm ncal
command and manual were written by
.An Wolfgang Helbig Aq helbig@FreeBSD.org .
.Sh BUGS
The assignment of Julian\(enGregorian switching dates to
country codes is historically naive for many countries.
Use '.\' and not '/* */' for troff-comments. 1997-12-19 21:41:21 +00:00			`.\" Copyright (c) 1997 Wolfgang Helbig`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
Use '.\' and not '/* */' for troff-comments. 1997-12-19 21:41:21 +00:00			`.\"`
Multibyte character support for cal(1). PR: 131578 2009-03-14 18:55:51 +00:00			`.Dd March 14, 2009`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Dt CAL 1`
			`.Os`
			`.Sh NAME`
			`.Nm cal ,`
			`.Nm ncal`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`.Nd displays a calendar and the date of Easter`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Mention -h in usage() and manpage. Rename term_{r,e} to term_{so,se}. Suggested by: ru Approved by: ed (mentor) 2009-05-02 07:02:31 +00:00			`.Op Fl hjy`
mdoc(7) police: fix the weird construct. 2001-01-15 16:49:28 +00:00			`.Oo`
			`.Op Ar month`
			`.Ar year`
			`.Oc`
Add a `-m month' flag to provide a more convenient interface for displaying a calendar for a specific month of the current year than `cal $(date +"%Y") month'. A few minor code cleanups. Set WARNS=1. (This code is WARNS=5 clean except for "`O' modifier used with `%B' strftime format", which is legal in FreeBSD but GCC doesn't know about.) MFC after: 1 week 2004-11-23 22:57:17 +00:00			`.Nm`
Mention -h in usage() and manpage. Rename term_{r,e} to term_{so,se}. Suggested by: ru Approved by: ed (mentor) 2009-05-02 07:02:31 +00:00			`.Op Fl hj`
Add a `-m month' flag to provide a more convenient interface for displaying a calendar for a specific month of the current year than `cal $(date +"%Y") month'. A few minor code cleanups. Set WARNS=1. (This code is WARNS=5 clean except for "`O' modifier used with `%B' strftime format", which is legal in FreeBSD but GCC doesn't know about.) MFC after: 1 week 2004-11-23 22:57:17 +00:00			`.Fl m Ar month`
			`.Op Ar year`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Nm ncal`
Mention -h in usage() and manpage. Rename term_{r,e} to term_{so,se}. Suggested by: ru Approved by: ed (mentor) 2009-05-02 07:02:31 +00:00			`.Op Fl hjJpwy`
Sync usage and synopsis. Add rcsid. 1998-01-07 07:46:33 +00:00			`.Op Fl s Ar country_code`
mdoc(7) police: fix the weird construct. 2001-01-15 16:49:28 +00:00			`.Oo`
			`.Op Ar month`
			`.Ar year`
			`.Oc`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Nm ncal`
Mention -h in usage() and manpage. Rename term_{r,e} to term_{so,se}. Suggested by: ru Approved by: ed (mentor) 2009-05-02 07:02:31 +00:00			`.Op Fl hJeo`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Op Ar year`
			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility displays a simple calendar in traditional format and`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Nm ncal`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`offers an alternative layout, more options and the date of Easter.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`The new format is a little cramped but it makes a year fit`
			`on a 25x80 terminal.`
			`If arguments are not specified,`
			`the current month is displayed.`
Sync usage and synopsis. Add rcsid. 1998-01-07 07:46:33 +00:00			`.Pp`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`The options are as follows:`
Sync usage and synopsis. Add rcsid. 1998-01-07 07:46:33 +00:00			`.Bl -tag -width indent`
Mention -h in usage() and manpage. Rename term_{r,e} to term_{so,se}. Suggested by: ru Approved by: ed (mentor) 2009-05-02 07:02:31 +00:00			`.It Fl h`
			`Turns off highlighting of today.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl J`
			`Display Julian Calendar, if combined with the`
			`.Fl e`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`option, display date of Easter according to the Julian Calendar.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl e`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`Display date of Easter (for western churches).`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl j`
Use '.\' and not '/* */' for troff-comments. 1997-12-19 21:41:21 +00:00			`Display Julian days (days one-based, numbered from January 1).`
Add a `-m month' flag to provide a more convenient interface for displaying a calendar for a specific month of the current year than `cal $(date +"%Y") month'. A few minor code cleanups. Set WARNS=1. (This code is WARNS=5 clean except for "`O' modifier used with `%B' strftime format", which is legal in FreeBSD but GCC doesn't know about.) MFC after: 1 week 2004-11-23 22:57:17 +00:00			`.It Fl m Ar month`
			`Display the specified`
			`.Ar month .`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`If`
			`.Ar month`
			`is specified as a decimal number, it may be followed by the letter`
			`.Ql f`
			`or`
			`.Ql p`
			`to indicate the following or preceding month of that number,`
			`respectively.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl o`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`Display date of Orthodox Easter (Greek and Russian`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`Orthodox Churches).`
			`.It Fl p`
Use '.\' and not '/* */' for troff-comments. 1997-12-19 21:41:21 +00:00			`Print the country codes and switching days from Julian to Gregorian`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`Calendar as they are assumed by`
			`.Nm ncal .`
Use locale to guess the switch date. Localize formatting of date of easter. Suggested by: ache 1998-01-03 15:10:11 +00:00			`The country code as determined from the local environment is marked`
			`with an asterisk.`
Sync usage and synopsis. Add rcsid. 1998-01-07 07:46:33 +00:00			`.It Fl s Ar country_code`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`Assume the switch from Julian to Gregorian Calendar at the date`
			`associated with the`
Sync usage and synopsis. Add rcsid. 1998-01-07 07:46:33 +00:00			`.Ar country_code .`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`If not specified,`
			`.Nm ncal`
Use locale to guess the switch date. Localize formatting of date of easter. Suggested by: ache 1998-01-03 15:10:11 +00:00			`tries to guess the switch date from the local environment or`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`falls back to September 2, 1752.`
			`This was when Great`
Use locale to guess the switch date. Localize formatting of date of easter. Suggested by: ache 1998-01-03 15:10:11 +00:00			`Britain and her colonies switched to the Gregorian Calendar.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl w`
Use '.\' and not '/* */' for troff-comments. 1997-12-19 21:41:21 +00:00			`Print the number of the week below each week column.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.It Fl y`
Add a `-m month' flag to provide a more convenient interface for displaying a calendar for a specific month of the current year than `cal $(date +"%Y") month'. A few minor code cleanups. Set WARNS=1. (This code is WARNS=5 clean except for "`O' modifier used with `%B' strftime format", which is legal in FreeBSD but GCC doesn't know about.) MFC after: 1 week 2004-11-23 22:57:17 +00:00			`Display a calendar for the specified year.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.El`
			`.Pp`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`A single parameter specifies the year (1\(en9999) to be displayed;`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`note the year must be fully specified:`
			`.Dq Li cal 89`
			`will`
			`.Em not`
			`display a calendar for 1989.`
Teach ncal(1) about month names specified on the command line. Reviewed by: -audit Approved by: silence on -audit MFC after: 3 weeks 2002-10-02 12:31:10 +00:00			`Two parameters denote the month and year; the month is either a number between`
			`1 and 12, or a full or abbreviated name as specified by the current locale.`
Add a `-m month' flag to provide a more convenient interface for displaying a calendar for a specific month of the current year than `cal $(date +"%Y") month'. A few minor code cleanups. Set WARNS=1. (This code is WARNS=5 clean except for "`O' modifier used with `%B' strftime format", which is legal in FreeBSD but GCC doesn't know about.) MFC after: 1 week 2004-11-23 22:57:17 +00:00			`Month and year default to those of the current system clock and time zone (so`
			`.Dq Li cal -m 8`
			`will display a calendar for the month of August in the current year).`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Pp`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`A year starts on January 1.`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`.Sh SEE ALSO`
			`.Xr calendar 3 ,`
			`.Xr strftime 3`
			`.Sh HISTORY`
			`A`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`command appeared in`
Correct History: cal(1) appeared in V5, not V6. 2002-06-03 15:02:02 +00:00			`.At v5 .`
Add new command ncal. 1997-12-15 20:35:22 +00:00			`The`
			`.Nm ncal`
fix ncal.1 grammar PR: 6394 Reviewed by: phk Submitted by: Josh Gilliam <josh@quick.net> 1998-04-26 06:21:29 +00:00			`command appeared in`
			`.Fx 2.2.6 .`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 07:48:45 +00:00			`.Sh AUTHORS`
fix ncal.1 grammar PR: 6394 Reviewed by: phk Submitted by: Josh Gilliam <josh@quick.net> 1998-04-26 06:21:29 +00:00			`The`
			`.Nm ncal`
			`command and manual were written by`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 07:48:45 +00:00			`.An Wolfgang Helbig Aq helbig@FreeBSD.org .`
Use locale to guess the switch date. Localize formatting of date of easter. Suggested by: ache 1998-01-03 15:10:11 +00:00			`.Sh BUGS`
Implement a new feature for the "-m" option: if the month number is followed by 'f' or 'p', use the following or preceding month of that number, respectively. Document this. Also includes other minor grammatical and punctuation fixes to the manual page (capitalize Easter, etc.). MFC after: 1 month 2008-12-22 21:22:42 +00:00			`The assignment of Julian\(enGregorian switching dates to`
Use locale to guess the switch date. Localize formatting of date of easter. Suggested by: ache 1998-01-03 15:10:11 +00:00			`country codes is historically naive for many countries.`