2006-12-06 17:25:32 -06:00
|
|
|
.\" 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
|
|
|
|
.\"
|
2015-06-24 13:58:06 -05:00
|
|
|
.TH CAL 1 "June 2015" "util-linux" "User Commands"
|
2011-08-02 07:55:55 -05:00
|
|
|
.SH NAME
|
2011-08-18 15:18:34 -05:00
|
|
|
cal \- display a calendar
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.B cal
|
2014-12-14 13:45:29 -06:00
|
|
|
[options]
|
|
|
|
.RI [[[ day ] " month" ] " year" ]
|
2016-05-31 11:27:20 -05:00
|
|
|
.br
|
|
|
|
.B cal
|
|
|
|
[options]
|
|
|
|
.RI <timestamp>
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH DESCRIPTION
|
2011-08-18 15:18:34 -05:00
|
|
|
.B cal
|
|
|
|
displays a simple calendar. If no arguments are specified, the current
|
2011-06-11 15:27:18 -05:00
|
|
|
month is displayed.
|
2016-05-31 06:53:58 -05:00
|
|
|
.sp
|
|
|
|
The \fImonth\fR may be specified as a number (1-12) or as a month name according
|
|
|
|
to the current locales.
|
2016-05-31 11:27:20 -05:00
|
|
|
.sp
|
|
|
|
.B cal
|
|
|
|
accepts special placeholders when parsing \fItimestamp\fR, "now" may be used to
|
|
|
|
refer to the current time, "today", "yesterday", "tomorrow" refer to
|
|
|
|
of the current day, the day before or the next day, respectively.
|
|
|
|
.sp
|
|
|
|
The relative date specifications are also accepted, in this case "+" is
|
|
|
|
evaluated to the current time plus the specified time span. Correspondingly, a
|
|
|
|
time span that is prefixed with "-" is evaluated to the current time minus the
|
|
|
|
specified time span, for example '+2days'. Instead of prefixing the time span
|
|
|
|
with "+" or "-", it may also be suffixed with a space and the word "left" or
|
|
|
|
"ago" (for example '1 week ago').
|
|
|
|
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
|
|
\fB\-1\fR, \fB\-\-one\fR
|
2006-12-06 17:25:53 -06:00
|
|
|
Display single month output.
|
|
|
|
(This is the default.)
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-3\fR, \fB\-\-three\fR
|
2013-10-09 13:44:12 -05:00
|
|
|
Display three months spanning the date.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
2015-04-07 06:05:39 -05:00
|
|
|
\fB\-n , \-\-months\fR \fInumber\fR
|
2015-06-24 13:58:06 -05:00
|
|
|
Display \fInumber\fR of months, starting from the month containing the date.
|
2015-04-07 06:05:39 -05:00
|
|
|
.TP
|
2015-10-09 19:39:02 -05:00
|
|
|
\fB\-S, \fB\-\-span\fR
|
|
|
|
Display months spanning the date.
|
|
|
|
.TP
|
2011-06-11 15:27:18 -05:00
|
|
|
\fB\-s\fR, \fB\-\-sunday\fR
|
2006-12-06 17:25:53 -06:00
|
|
|
Display Sunday as the first day of the week.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-m\fR, \fB\-\-monday\fR
|
2006-12-06 17:25:41 -06:00
|
|
|
Display Monday as the first day of the week.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-j\fR, \fB\-\-julian\fR
|
2006-12-06 17:25:41 -06:00
|
|
|
Display Julian dates (days one-based, numbered from January 1).
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-y\fR, \fB\-\-year\fR
|
2013-10-09 13:44:12 -05:00
|
|
|
Display a calendar for the whole year.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
2015-04-07 06:05:39 -05:00
|
|
|
\fB\-Y, \fB\-\-twelve\fR
|
|
|
|
Display a calendar for the next twelve months.
|
|
|
|
.TP
|
2016-03-17 04:54:31 -05:00
|
|
|
\fB\-w\fR, \fB\-\-week\fR[=\fInumber\fR]
|
2013-10-06 13:44:45 -05:00
|
|
|
Display week numbers in the calendar (US or ISO-8601).
|
|
|
|
.TP
|
2016-03-17 04:54:31 -05:00
|
|
|
\fB\-\-color\fR[=\fIwhen\fR]
|
2015-02-25 05:37:55 -06:00
|
|
|
Colorize the output. The optional argument \fIwhen\fP
|
|
|
|
can be \fBauto\fR, \fBnever\fR or \fBalways\fR. If the \fIwhen\fR argument is omitted,
|
2015-06-24 13:58:06 -05:00
|
|
|
it defaults to \fBauto\fR. The colors can be disabled; for the current built-in default
|
|
|
|
see the \fB\-\-help\fR output. See also the \fBCOLORS\fR section.
|
2013-05-01 17:12:16 -05:00
|
|
|
.TP
|
2011-06-11 15:27:18 -05:00
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
2007-09-03 01:25:40 -05:00
|
|
|
Display version information and exit.
|
2011-06-11 15:27:18 -05:00
|
|
|
.TP
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
2013-10-14 14:34:39 -05:00
|
|
|
Display help text and exit.
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH PARAMETERS
|
2013-05-24 17:42:07 -05:00
|
|
|
A single parameter specifies the year to be displayed; note the
|
2011-06-11 15:27:18 -05:00
|
|
|
year must be fully specified:
|
|
|
|
.B "cal 89"
|
|
|
|
will not display a calendar for 1989.
|
|
|
|
.PP
|
2006-12-06 17:25:32 -06:00
|
|
|
Two parameters denote the month (1 - 12) and year.
|
2011-06-11 15:27:18 -05:00
|
|
|
.PP
|
|
|
|
Three parameters denote the day (1-31), month and year, and the day will be
|
2015-06-24 13:58:06 -05:00
|
|
|
highlighted if the calendar is displayed on a terminal. If no parameters are
|
2011-06-11 15:27:18 -05:00
|
|
|
specified, the current month's calendar is displayed.
|
|
|
|
.PP
|
2015-06-24 13:58:06 -05:00
|
|
|
A year starts on January 1. The first day of the week is determined by the
|
2011-06-11 15:27:18 -05:00
|
|
|
locale.
|
|
|
|
.PP
|
2014-01-06 05:40:13 -06:00
|
|
|
The week numbering depends on the choice of the first day of the week. If Sunday
|
|
|
|
(the default) is used for the first day of the week, then the customary North
|
|
|
|
American numbering will be used, i.e. the first Sunday of the year starts the
|
|
|
|
first week. If Monday is selected, then the ISO-8601 standard week numbering
|
|
|
|
is used, where the first Thursday of the year is in week number 1.
|
2014-03-11 04:05:32 -05:00
|
|
|
.SH COLORS
|
|
|
|
Implicit coloring can be disabled as follows:
|
|
|
|
.RS
|
|
|
|
|
|
|
|
.br
|
|
|
|
.BI "touch /etc/terminal-colors.d/cal.disable"
|
|
|
|
.br
|
|
|
|
|
|
|
|
.RE
|
2015-02-25 05:37:55 -06:00
|
|
|
See
|
|
|
|
.BR terminal-colors.d (5)
|
|
|
|
for more details about colorization configuration.
|
2013-12-22 12:06:04 -06:00
|
|
|
.SH BUGS
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.B cal
|
2014-01-06 14:43:44 -06:00
|
|
|
program uses the 3rd of September 1752 as the date of the Gregorian calendar
|
|
|
|
reformation -- that is when it happened in Great Britain and its colonies
|
2015-06-24 13:58:06 -05:00
|
|
|
(including what is now the USA). Starting at that date, eleven days were eliminated
|
2014-01-06 14:43:44 -06:00
|
|
|
by this reformation, so the calendar for that month is rather unusual.
|
|
|
|
The actual historical dates at which the calendar reform happened in all the
|
|
|
|
different countries (locales) are ignored.
|
2013-12-22 12:06:04 -06:00
|
|
|
.PP
|
|
|
|
Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
|
|
|
|
or the lunisolar Hindu, are not supported.
|
2011-06-11 15:27:18 -05:00
|
|
|
.SH HISTORY
|
|
|
|
A cal command appeared in Version 6 AT&T UNIX.
|
|
|
|
.SH AVAILABILITY
|
2010-11-30 04:41:59 -06:00
|
|
|
The cal command is part of the util-linux package and is available from
|
|
|
|
ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
|