 |
Click this button to go to the index for this section. |
calendar(1)
NAME
calendar - Writes reminder messages to standard output
SYNOPSIS
calendar [-]
STANDARDS
Interfaces documented on this reference page conform to industry standards
as follows:
calendar: XPG4, XPG4-UNIX
Refer to the standards(5) reference page for more information about
industry standards and associated tags.
OPTIONS
- [DIGITAL] Calls calendar for all users who have a calendar file in
their home directories and sends reminders by mail.
This flag is usually used only by the superuser as part of daily
administrative procedures.
DESCRIPTION
The calendar command reads a file named calendar in your current (usually
home) directory and writes to standard output any line in the file that
contains the current date or the next day's date.
The calendar command recognizes date formats such as Dec. 7 or 12/7. It
also recognizes the special character * (asterisk) to match any month. For
example, it interprets */7 or * 7 as the seventh day of every month.
On Fridays, calendar writes all lines containing the dates for Friday,
Saturday, Sunday, and Monday. It does not recognize holidays, so if the
next day is a holiday calendar prints lines for that day, rather than for
the next working day.
For you to get reminder service when other users run calendar -, your
calendar file must be readable by others (see the chmod command).
NOTES
The calendar utility is marked to be withdrawn from a future issue of the
XPG4 and XPG4-UNIX standards.
EXIT STATUS
The following exit values are returned:
0 Successful completion.
>0 An error occurred.
EXAMPLES
1. To display information in the calendar file that pertains to today and
tomorrow, enter:
calendar
2. A typical calendar file might look like this:
*/25 - Prepare monthly report
Aug. 12 - Fly to Denver
aug 23 - board meeting
Martha out of town - 8/23, 8/24, 8/25
8/24 - Mail car payment
sat aug/25 - beach trip
August 27 - Meet with Simmons
August 28 - Meet with Wilson
If today is Friday, August 24, then the calendar command displays:
*/25 - Prepare monthly report
Martha out of town - 8/23, 8/24, 8/25
8/24 - Mail car payment
sat aug/25 - beach trip
August 27 - Meet with Simmons
ENVIRONMENT VARIABLES
The following environment variables affect the execution of calendar:
DATEMSK
[DIGITAL] If this variable is set, the calendar command uses its value
as the full pathname of a template file that contains format strings.
The strings consist of field descriptors and text characters which are
used to provide a more robust set of allowable date formats in
different languages using the appropriate settings of the environment
variables LANG or LC_TIME. See environ(5) for more information. The
list of allowable field descriptions is provided in the date(1)
reference page.
LANG
Provides a default value for the internationalization variables that
are unset or null. If LANG is unset or null, the corresponding value
from the default locale is used. If any of the internationalization
variables contain an invalid setting, the utility behaves as if none of
the variables had been defined.
LC_ALL
If set to a non-empty string value, overrides the values of all the
other internationalization variables.
LC_CTYPE
Determines the locale for the interpretation of sequences of bytes of
text data as characters (for example, single-byte as opposed to
multibyte characters in input files).
LC_MESSAGES
Determines the locale for the format and contents of diagnostic
messages written to standard error.
LC_TIME
Determines the format of date strings recognized by the calendar
command.
NLSPATH
Determines the location of message catalogues for the processing of
LC_MESSAGES.
FILES
$HOME/calendar
Contains user calendar entries.
/usr/lbin/calprog
Determines dates.
/etc/passwd
Contains user information.
SEE ALSO
Commands: chmod(1), date(1), mail(1), mailx(1)
Environment: environ(5)
Standards: standards(5)