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: src/usr.bin/ncal/ncal.1,v 1.8.2.7 2002/10/23 08:10:00 roam Exp $
  26 .\"
  27 .Dd March 12, 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 .Op Fl m Ar month
  38 .Oo
  39 .Op Ar month
  40 .Ar year
  41 .Oc
  42 .Nm ncal
  43 .Op Fl jJpwy
  44 .Op Fl m Ar month
  45 .Op Fl s Ar country_code
  46 .Oo
  47 .Op Ar month
  48 .Ar year
  49 .Oc
  50 .Nm ncal
  51 .Op Fl Jeo
  52 .Op Ar year
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility displays a simple calendar in traditional format and
  57 .Nm ncal
  58 offers an alternative layout, more options and the date of easter.
  59 The new format is a little cramped but it makes a year fit
  60 on a 25x80 terminal.
  61 If arguments are not specified,
  62 the current month is displayed.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width indent
  66 .It Fl J
  67 Display Julian Calendar, if combined with the
  68 .Fl e
  69 option, display date of easter according to the Julian Calendar.
  70 .It Fl e
  71 Display date of easter (for western churches).
  72 .It Fl j
  73 Display Julian days (days one-based, numbered from January 1).
  74 .It Fl m Ar month
  75 Display the specified
  76 .Ar month .
  77 .It Fl o
  78 Display date of orthodox easter (Greek and Russian
  79 Orthodox Churches).
  80 .It Fl p
  81 Print the country codes and switching days from Julian to Gregorian
  82 Calendar as they are assumed by
  83 .Nm ncal .
  84 The country code as determined from the local environment is marked
  85 with an asterisk.
  86 .It Fl s Ar country_code
  87 Assume the switch from Julian to Gregorian Calendar at the date
  88 associated with the
  89 .Ar country_code .
  90 If not specified,
  91 .Nm ncal
  92 tries to guess the switch date from the local environment or
  93 falls back to September 2, 1752. This was when Great
  94 Britain and her colonies switched to the Gregorian Calendar.
  95 .It Fl w
  96 Print the number of the week below each week column.
  97 .It Fl y
  98 Display a calendar for the current year.
  99 .El
 100 .Pp
 101 A single parameter specifies the year (1 - 9999) to be displayed;
 102 note the year must be fully specified.
 103 Two parameters denote the month and year; the
 104 .Ar month
 105 is either a number between
 106 1 and 12, or a full or abbreviated name as specified by the current locale.
 107 A single dot,
 108 .Ql \&. ,
 109 for the
 110 .Ar year
 111 parameter refers to the current year.
 112 .Pp
 113 A year starts on Jan 1.
 114 .Sh DIAGNOSTICS
 115 The
 116 .Nm
 117 utility returns 0 on success or >0 if an error occurred.
 118 .Sh SEE ALSO
 119 .Xr calendar 3 ,
 120 .Xr strftime 3
 121 .Sh STANDARDS
 122 The
 123 .Nm
 124 utility conforms to
 125 .St -p1003.1-2004
 126 and is ahead of the standard with locale-specific Gregorian adoption details.
 127 .Sh HISTORY
 128 A
 129 .Nm
 130 command appeared in
 131 .At v5 .
 132 The
 133 .Nm ncal
 134 command appeared in
 135 .Fx 2.2.6 .
 136 .Sh AUTHORS
 137 The
 138 .Nm ncal
 139 command and manual were written by
 140 .An Wolfgang Helbig Aq Mt helbig@FreeBSD.org .
 141 .Sh BUGS
 142 The assignment of Julian - Gregorian switching dates to
 143 country codes is historically naive for many countries.