src/usr.bin/calendar/calendar.1 - diff

Return to calendar.1 CVS log

Up to [local] / src / usr.bin / calendar

Diff for /src/usr.bin/calendar/calendar.1 between version 1.4 and 1.43

version 1.4, 1997/08/26 23:37:20

version 1.43, 2018/06/03 06:50:35

Line 11

.\" 2. Redistributions in binary form must reproduce the above copyright

.\" notice, this list of conditions and the following disclaimer in the

.\" documentation and/or other materials provided with the distribution.

.\" 3. All advertising materials mentioning features or use of this software

.\" 3. Neither the name of the University nor the names of its contributors

.\" must display the following acknowledgement:

.\" This product includes software developed by the University of

.\" California, Berkeley and its contributors.

.\" 4. Neither the name of the University nor the names of its contributors

.\" may be used to endorse or promote products derived from this software

.\" without specific prior written permission.

.\"

Line 33

Line 29

.\"

.\" @(#)calendar.1 8.1 (Berkeley) 6/29/93

.\"

.Dd June 29, 1993

.Dd $Mdocdate$

.Dt CALENDAR 1

.Os

.Sh NAME

Line 41

Line 37

.Nd reminder service

.Sh SYNOPSIS

.Nm calendar

.Op Fl a

.Op Fl abw

.Op Fl A Ar num

.Op Fl B Ar num

.Op Fl t Ar [[[yy]yy][mm]]dd

.Op Fl f Ar calendarfile

.Op Fl t Oo Oo Oo Ar cc Oc Ns Ar yy Oc Ns Ar mm Oc Ns Ar dd

.Sh DESCRIPTION

The

.Nm calendar

.Nm

utility checks the current directory or the directory specified by the

.Dq Ev CALENDAR_DIR

.Ev CALENDAR_DIR

environment variable for a file named

.Pa calendar

and displays lines that begin with either today's date

or tomorrow's.

On Fridays, events on Friday through Monday are displayed.

.Pp

The following options are available:

The options are as follows:

.Bl -tag -width Ds

.It Fl a

Process the ``calendar'' files of all users and mail the results

to them.

This requires super-user privileges.

.It Fl A Ar num

print lines from today and next

Print lines from today and next

.Ar num

days (forward, future)

days (forward, future).

.It Fl a

Process the

.Dq calendar

files of all users and mail the results

to them.

This requires superuser privileges.

.It Fl B Ar num

print lines from today and previous

Print lines from today and previous

.Ar num

days (backward, past)

days (backward, past).

.It Fl f Pa calendarfile

.It Fl b

use

Enforce special date calculation mode for Cyrillic calendars.

.Pa calendarfile

.It Fl f Ar calendarfile

as default calendar file.

Use

.It Fl t Ar [[[yy]yy][mm]]dd

.Ar calendarfile

act like the specified value is ``today'' instead of using the current date.

as the default calendar file.

.It Fl t Oo Oo Oo Ar cc Oc Ns Ar yy Oc Ns Ar mm Oc Ns Ar dd

Act like the specified value is

.Dq today

instead of using the current date.

If yy is specified, but cc is not,

a value for yy between 69 and 99 results in a cc value of 19.

Otherwise, a cc value of 20 is used.

.It Fl w

Print day of the week name in front of each event.

.El

.Pp

To handle calendars in your national code table you can specify

.Dq LANG=<locale_name>

in the calendar file as early as possible. To handle national Easter

in the calendar file as early as possible.

names in the calendars

To handle national Easter names in the calendars,

.Dq Easter=<national_name>

(for Catholic Easter) or

.Dq Paskha=<national_name>

(for Orthodox Easter) can be used.

.Pp

The

.Dq CALENDAR

variable can be used to specify the style.

Only

.Sq Julian

and

.Sq Gregorian

styles are currently supported.

Use

.Dq CALENDAR=

to return to the default (Gregorian).

.Pp

To enforce special date calculation mode for Cyrillic calendars

you should specify

.Dq LANG=<local_name>

and

.Dq BODUN=<bodun_prefix>

where <local_name> can be ru_RU.UTF-8, uk_UA.UTF-8 or by_BY.UTF-8.

.Pp

Other lines should begin with a month and day.

They may be entered in almost any format, either numeric or as character

strings.

If proper locale is set, national months and weekdays

names can be used.

A single asterisk (``*'') matches every month.

A single asterisk (`*') matches every month.

A day without a month matches that day of every week.

A month without a day matches the first of that month.

Two numbers default to the month followed by the day.

Lines with leading tabs default to the last entered date, allowing

multiple line specifications for a single date.

``Easter'', may be followed by an positive or negative integer, is

.Dq Easter

Easter for this year.

(may be followed by a positive or negative integer) is Easter for this year.

``Paskha'', may be followed by an positive or negative integer, is

.Dq Paskha

(may be followed by a positive or negative integer) is

Orthodox Easter for this year.

Weekdays may be followed by ``-4'' ... ``+5'' (aliases

Weekdays may be followed by

last, first, second, third, fourth) for moving events like

.Dq -4

``the last Monday in April''

.Li ...

.Dq +5

(aliases last, first, second, third, fourth) for moving events like

.Dq the last Monday in April .

.Pp

By convention, dates followed by an asterisk are not fixed, i.e., change

By convention, dates followed by an asterisk

.Pq Sq *

are not fixed, i.e., change

from year to year.

.Pp

Day description start after the first <tab> character in the line;

Day descriptions start after the first <tab> character in the line;

if the line not contains <tab> character, it isn't printed out.

if the line does not contain a <tab> character, it isn't printed out.

If the first character in the line is a <tab> character, it is treated as

continue of previous description.

the continuation of the previous description.

.Pp

The ``calendar'' file is preprocessed by

The calendar file is preprocessed by

.Xr cpp 1 ,

allowing the inclusion of shared files such as company holidays or

meetings.

Line 128

Line 160

.Pq Li /* ... */

are ignored.

.Pp

Some possible calendar entries (<tab> characters highlighted by

Some possible calendar entries

\fB\et\fR sequence)

(a \fB\et\fR sequence denotes a <tab> character):

.Bd -unfilled -offset indent

LANG=C

Easter=Ostern

Line 141

Line 173

Jun. 15\fB\et\fRJune 15.

15 June\fB\et\fRJune 15.

Thursday\fB\et\fREvery Thursday.

June\fB\et\fREvery June 1st.

15 *\fB\et\fR15th of every month.

May Sun+2\fB\et\fRsecond Sunday in May (Muttertag)

04/SunLast\fB\et\fRlast Sunday in April,

\fB\et\fRsummer time in Europe

Easter\fB\et\fREaster

Ostern-2\fB\et\fRGood Friday (2 days before Easter)

Paskha\fB\et\fROrthodox Easter

.Ed

.Sh FILES

.Pp

.Bl -tag -width ~/.calendar/calendar -compact

.Bl -tag -width calendar.christian -compact

.It Pa calendar

file in current directory

File in current directory.

.It Pa ~/.calendar

.Pa calendar

Directory in the user's home directory (which

HOME directory.

.Nm

.Nm calendar

changes into, if it exists).

does a chdir into this directory if it exists.

.It Pa ~/.calendar/calendar

calendar file to use if no calendar file exists in the current directory.

File to use if no calendar file exists in the current directory.

.It Pa ~/.calendar/nomail

do not send mail if this file exists.

.Nm

.El

will not send mail if this file exists.

.It Pa calendar.all

The following default calendar files are provided:

International and national calendar files.

.Pp

.Bl -tag -width calendar.christian -compact

.It Pa calendar.birthday

Births and deaths of famous (and not-so-famous) people.

.It Pa calendar.canada

Canadian holidays.

.It Pa calendar.christian

Christian holidays.

Christian holidays (should be updated yearly by the local system administrator

This calendar should be updated yearly by the local system administrator

so that roving holidays are set correctly for the current year).

so that roving holidays are set correctly for the current year.

.It Pa calendar.computer

Days of special significance to computer people.

.It Pa calendar.croatian

Croatian calendar.

.It Pa calendar.discord

Discordian calendar (all rites reversed).

.It Pa calendar.fictional

Fantasy and fiction dates (mostly LOTR).

.It Pa calendar.french

French calendar.

.It Pa calendar.german

German calendar.

.It Pa calendar.history

Everything else, mostly U. S. historical events.

Miscellaneous history.

.It Pa calendar.holiday

Other holidays, including the not-well-known, obscure, and

Other holidays (including the not-well-known, obscure, and

.Em really

obscure.

obscure).

.It Pa calendar.judaic

Jewish holidays.

Jewish holidays (should be updated yearly by the local system administrator

This calendar should be updated yearly by the local system administrator

so that roving holidays are set correctly for the current year).

so that roving holidays are set correctly for the current year.

.It Pa calendar.music

Musical events, births, and deaths.

Musical events, births, and deaths (strongly oriented toward rock 'n' roll).

Strongly oriented toward rock 'n' roll.

.It Pa calendar.nz

New Zealand calendar.

.It Pa calendar.usholiday

.It Pa calendar.openbsd

U.S. holidays.

.Ox

This calendar should be updated yearly by the local system administrator

related events.

so that roving holidays are set correctly for the current year.

.It Pa calendar.pagan

Pagan holidays, celebrations and festivals.

.It Pa calendar.german

German calendar.

.It Pa calendar.russian

Russian calendar.

.It Pa calendar.space

Cosmic history.

.It Pa calendar.uk

UK calendar.

.It Pa calendar.ushistory

U.S. history.

.It Pa calendar.usholiday

U.S. holidays.

.It Pa calendar.world

World wide calendar.

.El

.Sh SEE ALSO

.Xr at 1 ,

.Xr cal 1 ,

.Xr cpp 1 ,

.Xr cron 8 ,

.Xr mail 1 ,

.Xr mail 1

.Xr cron 8

.Sh COMPATIBILITY

.Sh STANDARDS

The

.Nm calendar

.Nm

program previously selected lines which had the correct date anywhere

in the line.

This is no longer true, the date is only recognized when it occurs

This is no longer true: the date is only recognized when it occurs

at the beginning of a line.

.Sh HISTORY

Line 230

Line 267

command appeared in

.At v7 .

.Sh BUGS

.Nm Calendar

.Nm

doesn't handle Jewish holidays and moon phases.

doesn't handle all Jewish holidays or moon phases.