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 [\fIoptions\fR] [[[\fIday\fR] \fImonth\fR] \fIyear\fR]
  43 .SH DESCRIPTION
  44 .B cal
  45 displays a simple calendar.  If no arguments are specified, the current
  46 month is displayed.
  47 .SH OPTIONS
  48 .TP
  49 \fB\-1\fR, \fB\-\-one\fR
  50 Display single month output.
  51 (This is the default.)
  52 .TP
  53 \fB\-3\fR, \fB\-\-three\fR
  54 Display three months spanning the date.
  55 .TP
  56 \fB\-s\fR, \fB\-\-sunday\fR
  57 Display Sunday as the first day of the week.
  58 .TP
  59 \fB\-m\fR, \fB\-\-monday\fR
  60 Display Monday as the first day of the week.
  61 .TP
  62 \fB\-j\fR, \fB\-\-julian\fR
  63 Display Julian dates (days one-based, numbered from January 1).
  64 .TP
  65 \fB\-y\fR, \fB\-\-year\fR
  66 Display a calendar for the whole year.
  67 .TP
  68 \fB\-\-color\fR [\fIwhen\fR]
  69 Colorize output.  The
  70 .I when
  71 can be
  72 .IR never ,
  73 .IR auto ,
  74 or
  75 .IR always .
  76 Never will turn off colorizing in all situations.  Auto is default, and
  77 it will make colorizing to be in use if output is done to terminal.
  78 Always will allow colors to be outputed when
  79 .B cal
  80 outputs to pipe, or is called from a script.
  81 .TP
  82 \fB\-V\fR, \fB\-\-version\fR
  83 Display version information and exit.
  84 .TP
  85 \fB\-h\fR, \fB\-\-help\fR
  86 Display help screen and exit.
  87 .SH PARAMETERS
  88 A single parameter specifies the year to be displayed; note the
  89 year must be fully specified:
  90 .B "cal 89"
  91 will not display a calendar for 1989.
  92 .PP
  93 Two parameters denote the month (1 - 12) and year.
  94 .PP
  95 Three parameters denote the day (1-31), month and year, and the day will be
  96 highlighted if the calendar is displayed on a terminal. If no parameters are
  97 specified, the current month's calendar is displayed.
  98 .PP
  99 A year starts on Jan 1. The first day of the week is determined by the
 100 locale.
 101 .PP
 102 The Gregorian Reformation is assumed to have occurred in 1752 on the 3rd of
 103 September. By this time, most countries had recognized the reformation
 104 (although a few did not recognize it until the early 1900's). Ten days
 105 following that date were eliminated by the reformation, so the calendar for
 106 that month is a bit unusual.
 107 .SH HISTORY
 108 A cal command appeared in Version 6 AT&T UNIX.
 109 .SH AVAILABILITY
 110 The cal command is part of the util-linux package and is available from
 111 ftp://ftp.kernel.org/pub/linux/utils/util-linux/.