misc-utils/cal.1

   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 .TH CAL 1 "June 2015" "util-linux" "User Commands"
  38 .SH NAME
  39 cal \- display a calendar
  40 .SH SYNOPSIS
  41 .B cal
  42 [options]
  43 .RI [[[ day ] " month" ] " year" ]
  44 .br
  45 .B cal
  46 [options]
  47 .RI <timestamp|monthname>
  48 .SH DESCRIPTION
  49 .B cal
  50 displays a simple calendar.  If no arguments are specified, the current
  51 month is displayed.
  52 .sp
  53 The \fImonth\fR may be specified as a number (1-12), as a month name or as an
  54 abbreviated month name according to the current locales.
  55 .SH OPTIONS
  56 .TP
  57 \fB\-1\fR, \fB\-\-one\fR
  58 Display single month output.
  59 (This is the default.)
  60 .TP
  61 \fB\-3\fR, \fB\-\-three\fR
  62 Display three months spanning the date.
  63 .TP
  64 \fB\-n , \-\-months\fR \fInumber\fR
  65 Display \fInumber\fR of months, starting from the month containing the date.
  66 .TP
  67 \fB\-S, \fB\-\-span\fR
  68 Display months spanning the date.
  69 .TP
  70 \fB\-s\fR, \fB\-\-sunday\fR
  71 Display Sunday as the first day of the week.
  72 .TP
  73 \fB\-m\fR, \fB\-\-monday\fR
  74 Display Monday as the first day of the week.
  75 .TP
  76 \fB\-j\fR, \fB\-\-julian\fR
  77 Display Julian dates (days one-based, numbered from January 1).
  78 .TP
  79 \fB\-y\fR, \fB\-\-year\fR
  80 Display a calendar for the whole year.
  81 .TP
  82 \fB\-Y, \fB\-\-twelve\fR
  83 Display a calendar for the next twelve months.
  84 .TP
  85 \fB\-w\fR, \fB\-\-week\fR[=\fInumber\fR]
  86 Display week numbers in the calendar (US or ISO-8601).
  87 .TP
  88 \fB\-\-color\fR[=\fIwhen\fR]
  89 Colorize the output.  The optional argument \fIwhen\fP
  90 can be \fBauto\fR, \fBnever\fR or \fBalways\fR.  If the \fIwhen\fR argument is omitted,
  91 it defaults to \fBauto\fR.  The colors can be disabled; for the current built-in default
  92 see the \fB\-\-help\fR output.  See also the \fBCOLORS\fR section.
  93 .TP
  94 \fB\-V\fR, \fB\-\-version\fR
  95 Display version information and exit.
  96 .TP
  97 \fB\-h\fR, \fB\-\-help\fR
  98 Display help text and exit.
  99 .SH PARAMETERS
 100 .TP
 101 \fBSingle digits-only parameter (e.g. 'cal 2020')\fR
 102 Specifies the \fIyear\fR to be displayed; note the year must be fully specified:
 103 .B "cal 89"
 104 will not display a calendar for 1989.
 105 .TP
 106 \fBSingle string parameter (e.g. 'cal tomorrow' or 'cal August')\fR
 107 Specifies \fItimestamp\fR or a \fImonth name\fR (or abbreviated name) according to the current
 108 locales.
 109 .sp
 110 The special placeholders are accepted when parsing timestamp, "now" may be used
 111 to refer to the current time, "today", "yesterday", "tomorrow" refer to of the
 112 current day, the day before or the next day, respectively.
 113 .sp
 114 The relative date specifications are also accepted, in this case "+" is
 115 evaluated to the current time plus the specified time span. Correspondingly, a
 116 time span that is prefixed with "-" is evaluated to the current time minus the
 117 specified time span, for example '+2days'. Instead of prefixing the time span
 118 with "+" or "-", it may also be suffixed with a space and the word "left" or
 119 "ago" (for example '1 week ago').
 120 .TP
 121 \fBTwo parameters (e.g. 'cal 11 2020')\fR
 122 Denote the \fImonth\fR (1 - 12) and \fIyear\fR.
 123 .TP
 124 \fBThree parameters (e.g. 'cal 25 11 2020')\fR
 125 Denote the \fIday\fR (1-31), \fImonth and \fIyear\fR, and the day will be
 126 highlighted if the calendar is displayed on a terminal.  If no parameters are
 127 specified, the current month's calendar is displayed.
 128 .SH NOTES
 129 A year starts on January 1.  The first day of the week is determined by the
 130 locale.
 131 .PP
 132 The week numbering depends on the choice of the first day of the week.  If Sunday
 133 (the default) is used for the first day of the week, then the customary North
 134 American numbering will be used, i.e. the first Sunday of the year starts the
 135 first week.  If Monday is selected, then the ISO-8601 standard week numbering
 136 is used, where the first Thursday of the year is in week number 1.
 137 .SH COLORS
 138 Implicit coloring can be disabled as follows:
 139 .RS
 140
 141 .br
 142 .BI "touch /etc/terminal-colors.d/cal.disable"
 143 .br
 144
 145 .RE
 146 See
 147 .BR terminal-colors.d (5)
 148 for more details about colorization configuration.
 149 .SH BUGS
 150 .PP
 151 The
 152 .B cal
 153 program uses the 3rd of September 1752 as the date of the Gregorian calendar
 154 reformation -- that is when it happened in Great Britain and its colonies
 155 (including what is now the USA).  Starting at that date, eleven days were eliminated
 156 by this reformation, so the calendar for that month is rather unusual.
 157 The actual historical dates at which the calendar reform happened in all the
 158 different countries (locales) are ignored.
 159 .PP
 160 Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
 161 or the lunisolar Hindu, are not supported.
 162 .SH HISTORY
 163 A cal command appeared in Version 6 AT&T UNIX.
 164 .SH AVAILABILITY
 165 The cal command is part of the util-linux package and is available from
 166 https://www.kernel.org/pub/linux/utils/util-linux/.