[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 mjy13
.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 (use if cal was built with -3 as default to get 
older traditional output)
.It Fl 3
Display prev/current/next month output (use if cal was built with traditional
-1 as default to get newer improved output)
.It Fl m
Display Monday as the first day of the week.
(The default is Sunday.)
.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.
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
66ee8158	45	.Op Fl mjy13
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 KZ	54	.It Fl 1
	55	Display single month output (use if cal was built with -3 as default to get
	56	older traditional output)
	57	.It Fl 3
	58	Display prev/current/next month output (use if cal was built with traditional
	59	-1 as default to get newer improved output)
5c36a0eb	60	.It Fl m
eb63b9b8 KZ	61	Display Monday as the first day of the week.
eb63b9b8 KZ	62	(The default is Sunday.)
6dbe3af9	63	.It Fl j
eb63b9b8	64	Display Julian dates (days one-based, numbered from January 1).
6dbe3af9 KZ	65	.It Fl y
	66	Display a calendar for the current year.
	67	.El
	68	.Pp
	69	A single parameter specifies the year (1 - 9999) to be displayed;
	70	note the year must be fully specified:
	71	.Dq Li cal 89
	72	will
	73	.Em not
	74	display a calendar for 1989.
	75	Two parameters denote the month (1 - 12) and year.
	76	If no parameters are specified, the current month's calendar is
	77	displayed.
	78	.Pp
	79	A year starts on Jan 1.
	80	.Pp
	81	The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd
	82	of September.
	83	By this time, most countries had recognized the reformation (although a
	84	few did not recognize it until the early 1900's.)
	85	Ten days following that date were eliminated by the reformation, so the
	86	calendar for that month is a bit unusual.
	87	.Sh HISTORY
	88	A
	89	.Nm
	90	command appeared in Version 6 AT&T UNIX.