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 2011" "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 .SH DESCRIPTION
  45 .B cal
  46 displays a simple calendar.  If no arguments are specified, the current
  47 month is displayed.
  48 .SH OPTIONS
  49 .TP
  50 \fB\-1\fR, \fB\-\-one\fR
  51 Display single month output.
  52 (This is the default.)
  53 .TP
  54 \fB\-3\fR, \fB\-\-three\fR
  55 Display three months spanning the date.
  56 .TP
  57 \fB\-s\fR, \fB\-\-sunday\fR
  58 Display Sunday as the first day of the week.
  59 .TP
  60 \fB\-m\fR, \fB\-\-monday\fR
  61 Display Monday as the first day of the week.
  62 .TP
  63 \fB\-j\fR, \fB\-\-julian\fR
  64 Display Julian dates (days one-based, numbered from January 1).
  65 .TP
  66 \fB\-y\fR, \fB\-\-year\fR
  67 Display a calendar for the whole year.
  68 .TP
  69 \fB\-w\fR, \fB\-\-week\fR[\fI=number\fR]
  70 Display week numbers in the calendar (US or ISO-8601).
  71 .TP
  72 \fB\-\-color\fR[\fI=when\fR]
  73 Colorize output.  The
  74 .I when
  75 can be
  76 .IR never ,
  77 .IR auto ,
  78 or
  79 .IR always .
  80 Never will turn off colorizing in all situations.  Auto is default, and
  81 it will make colorizing to be in use if output is done to terminal.
  82 Always will allow colors to be outputed when
  83 .B cal
  84 outputs to pipe, or is called from a script.
  85 .TP
  86 \fB\-V\fR, \fB\-\-version\fR
  87 Display version information and exit.
  88 .TP
  89 \fB\-h\fR, \fB\-\-help\fR
  90 Display help text and exit.
  91 .SH PARAMETERS
  92 A single parameter specifies the year to be displayed; note the
  93 year must be fully specified:
  94 .B "cal 89"
  95 will not display a calendar for 1989.
  96 .PP
  97 Two parameters denote the month (1 - 12) and year.
  98 .PP
  99 Three parameters denote the day (1-31), month and year, and the day will be
 100 highlighted if the calendar is displayed on a terminal. If no parameters are
 101 specified, the current month's calendar is displayed.
 102 .PP
 103 A year starts on Jan 1. The first day of the week is determined by the
 104 locale.
 105 .PP
 106 The week numbering depends on the choice of the first day of the week.  If Sunday
 107 (the default) is used for the first day of the week, then the customary North
 108 American numbering will be used, i.e. the first Sunday of the year starts the
 109 first week.  If Monday is selected, then the ISO-8601 standard week numbering
 110 is used, where the first Thursday of the year is in week number 1.
 111 .SH COLORS
 112 Implicit coloring can be disabled as follows:
 113 .RS
 114
 115 .br
 116 .BI "touch /etc/terminal-colors.d/cal.disable"
 117 .br
 118
 119 .RE
 120 For more details see
 121 .BR terminal-colors.d (5).
 122 .SH BUGS
 123 .PP
 124 The
 125 .B cal
 126 program uses the 3rd of September 1752 as the date of the Gregorian calendar
 127 reformation -- that is when it happened in Great Britain and its colonies
 128 (including what is now the USA).  Ten days following that date were eliminated
 129 by this reformation, so the calendar for that month is rather unusual.
 130 The actual historical dates at which the calendar reform happened in all the
 131 different countries (locales) are ignored.
 132 .PP
 133 Alternative calendars, such as the Umm al-Qura, the Solar Hijri, the Ge'ez,
 134 or the lunisolar Hindu, are not supported.
 135 .SH HISTORY
 136 A cal command appeared in Version 6 AT&T UNIX.
 137 .SH AVAILABILITY
 138 The cal command is part of the util-linux package and is available from
 139 ftp://ftp.kernel.org/pub/linux/utils/util-linux/.