usr.bin/ncal/ncal.1

   1 .\" Copyright (c) 1997 Wolfgang Helbig
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 14, 2009
  28 .Dt CAL 1
  29 .Os
  30 .Sh NAME
  31 .Nm cal ,
  32 .Nm ncal
  33 .Nd displays a calendar and the date of easter
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl jy
  37 .Oo
  38 .Op Ar month
  39 .Ar year
  40 .Oc
  41 .Nm
  42 .Op Fl j
  43 .Fl m Ar month
  44 .Op Ar year
  45 .Nm ncal
  46 .Op Fl jJpwy
  47 .Op Fl s Ar country_code
  48 .Oo
  49 .Op Ar month
  50 .Ar year
  51 .Oc
  52 .Nm ncal
  53 .Op Fl Jeo
  54 .Op Ar year
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility displays a simple calendar in traditional format and
  59 .Nm ncal
  60 offers an alternative layout, more options and the date of easter.
  61 The new format is a little cramped but it makes a year fit
  62 on a 25x80 terminal.
  63 If arguments are not specified,
  64 the current month is displayed.
  65 .Pp
  66 The options are as follows:
  67 .Bl -tag -width indent
  68 .It Fl J
  69 Display Julian Calendar, if combined with the
  70 .Fl e
  71 option, display date of easter according to the Julian Calendar.
  72 .It Fl e
  73 Display date of easter (for western churches).
  74 .It Fl j
  75 Display Julian days (days one-based, numbered from January 1).
  76 .It Fl m Ar month
  77 Display the specified
  78 .Ar month .
  79 .It Fl o
  80 Display date of orthodox easter (Greek and Russian
  81 Orthodox Churches).
  82 .It Fl p
  83 Print the country codes and switching days from Julian to Gregorian
  84 Calendar as they are assumed by
  85 .Nm ncal .
  86 The country code as determined from the local environment is marked
  87 with an asterisk.
  88 .It Fl s Ar country_code
  89 Assume the switch from Julian to Gregorian Calendar at the date
  90 associated with the
  91 .Ar country_code .
  92 If not specified,
  93 .Nm ncal
  94 tries to guess the switch date from the local environment or
  95 falls back to September 2, 1752.
  96 This was when Great
  97 Britain and her colonies switched to the Gregorian Calendar.
  98 .It Fl w
  99 Print the number of the week below each week column.
 100 .It Fl y
 101 Display a calendar for the specified year.
 102 .El
 103 .Pp
 104 A single parameter specifies the year (1 - 9999) to be displayed;
 105 note the year must be fully specified:
 106 .Dq Li cal 89
 107 will
 108 .Em not
 109 display a calendar for 1989.
 110 Two parameters denote the month and year; the month is either a number between
 111 1 and 12, or a full or abbreviated name as specified by the current locale.
 112 Month and year default to those of the current system clock and time zone (so
 113 .Dq Li cal -m 8
 114 will display a calendar for the month of August in the current year).
 115 .Pp
 116 A year starts on Jan 1.
 117 .Sh SEE ALSO
 118 .Xr calendar 3 ,
 119 .Xr strftime 3
 120 .Sh HISTORY
 121 A
 122 .Nm
 123 command appeared in
 124 .At v5 .
 125 The
 126 .Nm ncal
 127 command appeared in
 128 .Fx 2.2.6 .
 129 .Sh AUTHORS
 130 The
 131 .Nm ncal
 132 command and manual were written by
 133 .An Wolfgang Helbig Aq helbig@FreeBSD.org .
 134 .Sh BUGS
 135 The assignment of Julian\(emGregorian switching dates to
 136 country codes is historically naive for many countries.