[thirdparty/util-linux.git] / misc-utils / cal.1

.\" Copyright (c) 1989, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Kim Letkeman.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
.\"
.\"     @(#)cal.1	8.1 (Berkeley) 6/6/93
.\"
.Dd June 6, 1993
.Dt CAL 1
.Os
.Sh NAME
.Nm cal
.Nd displays a calendar
.Sh SYNOPSIS
.Nm cal
.Op Fl smjy13
.Op [ Ar month ] Ar year
.Sh DESCRIPTION
.Nm Cal
displays a simple calendar.
If arguments are not specified,
the current month is displayed.
The options are as follows:
.Bl -tag -width Ds
.It Fl 1
Display single month output.
(This is the default.)
.It Fl 3
Display prev/current/next month output.
.It Fl s
Display Sunday as the first day of the week.
(This is the default.)
.It Fl m
Display Monday as the first day of the week.
.It Fl j
Display Julian dates (days one-based, numbered from January 1).
.It Fl y
Display a calendar for the current year.
.El
.Pp
A single parameter specifies the year (1 - 9999) 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 (1 - 12) and year.
If no parameters are specified, the current month's calendar is
displayed.
.Pp
A year starts on Jan 1.
.Pp
The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd
of September.
By this time, most countries had recognized the reformation (although a
few did not recognize it until the early 1900's.)
Ten days following that date were eliminated by the reformation, so the
calendar for that month is a bit unusual.
.Sh HISTORY
A
.Nm
command appeared in Version 6 AT&T UNIX.
.Sh OTHER VERSIONS
Several much more elaborate versions of this program exist,
with support for colors, holidays, birthdays, reminders and
appointments, etc. For example, try the cal from
http://home.sprynet.com/~cbagwell/projects.html
or GNU gcal.
.Sh AVAILABILITY
The cal command is part of the util-linux-ng package and is available from
ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
Commit	Line	Data
6dbe3af9 KZ	1	.\" Copyright (c) 1989, 1990, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Kim Letkeman.
	6	.\"
	7	.\" Redistribution and use in source and binary forms, with or without
	8	.\" modification, are permitted provided that the following conditions
	9	.\" are met:
	10	.\" 1. Redistributions of source code must retain the above copyright
	11	.\" notice, this list of conditions and the following disclaimer.
	12	.\" 2. Redistributions in binary form must reproduce the above copyright
	13	.\" notice, this list of conditions and the following disclaimer in the
	14	.\" documentation and/or other materials provided with the distribution.
	15	.\" 3. All advertising materials mentioning features or use of this software
	16	.\" must display the following acknowledgement:
	17	.\" This product includes software developed by the University of
	18	.\" California, Berkeley and its contributors.
	19	.\" 4. Neither the name of the University nor the names of its contributors
	20	.\" may be used to endorse or promote products derived from this software
	21	.\" without specific prior written permission.
	22	.\"
	23	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	24	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	25	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	26	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	27	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	28	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	29	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	30	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	31	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	32	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	33	.\" SUCH DAMAGE.
	34	.\"
	35	.\" @(#)cal.1 8.1 (Berkeley) 6/6/93
	36	.\"
	37	.Dd June 6, 1993
	38	.Dt CAL 1
	39	.Os
	40	.Sh NAME
	41	.Nm cal
	42	.Nd displays a calendar
	43	.Sh SYNOPSIS
	44	.Nm cal
ffc43748	45	.Op Fl smjy13
364cda48	46	.Op [ Ar month ] Ar year
6dbe3af9 KZ	47	.Sh DESCRIPTION
	48	.Nm Cal
	49	displays a simple calendar.
	50	If arguments are not specified,
	51	the current month is displayed.
	52	The options are as follows:
	53	.Bl -tag -width Ds
66ee8158	54	.It Fl 1
ffc43748 KZ	55	Display single month output.
ffc43748 KZ	56	(This is the default.)
66ee8158	57	.It Fl 3
ffc43748 KZ	58	Display prev/current/next month output.
	59	.It Fl s
	60	Display Sunday as the first day of the week.
	61	(This is the default.)
5c36a0eb	62	.It Fl m
eb63b9b8	63	Display Monday as the first day of the week.
6dbe3af9	64	.It Fl j
eb63b9b8	65	Display Julian dates (days one-based, numbered from January 1).
6dbe3af9 KZ	66	.It Fl y
	67	Display a calendar for the current year.
	68	.El
	69	.Pp
	70	A single parameter specifies the year (1 - 9999) to be displayed;
	71	note the year must be fully specified:
	72	.Dq Li cal 89
	73	will
	74	.Em not
	75	display a calendar for 1989.
	76	Two parameters denote the month (1 - 12) and year.
	77	If no parameters are specified, the current month's calendar is
	78	displayed.
	79	.Pp
	80	A year starts on Jan 1.
	81	.Pp
	82	The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd
	83	of September.
	84	By this time, most countries had recognized the reformation (although a
	85	few did not recognize it until the early 1900's.)
	86	Ten days following that date were eliminated by the reformation, so the
	87	calendar for that month is a bit unusual.
	88	.Sh HISTORY
	89	A
	90	.Nm
	91	command appeared in Version 6 AT&T UNIX.
ffc43748 KZ	92	.Sh OTHER VERSIONS
	93	Several much more elaborate versions of this program exist,
	94	with support for colors, holidays, birthdays, reminders and
	95	appointments, etc. For example, try the cal from
	96	http://home.sprynet.com/~cbagwell/projects.html
	97	or GNU gcal.
86d62711 KZ	98	.Sh AVAILABILITY
	99	The cal command is part of the util-linux-ng package and is available from
	100	ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.