usr/src/man/man1/calendar.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH CALENDAR 1 "Feb 1, 1995"
  11 .SH NAME
  12 calendar \- reminder service
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBcalendar\fR [\fB-\fR]
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBcalendar\fR utility consults the file \fBcalendar\fR in the current
  23 directory and writes lines that contain today's or tomorrow's date anywhere in
  24 the line to standard output. Most reasonable month-day dates such as \fBAug.
  25 24\fR, \fBaugust 24\fR, \fB8/24\fR, and so forth, are recognized, but not \fB24
  26 August\fR or \fB24/8\fR. On Fridays and weekends "tomorrow" extends through
  27 Monday. \fBcalendar\fR can be invoked regularly by using the \fBcrontab\fR(1)
  28 or \fBat\fR(1) commands.
  29 .sp
  30 .LP
  31 When the optional argument \fB-\fR is present, \fBcalendar\fR does its job for
  32 every user who has a file \fBcalendar\fR in his or her login directory and
  33 sends them any positive results by \fBmail\fR(1). Normally this is done daily
  34 by facilities in the UNIX operating system (see\fBcron\fR(1M)).
  35 .sp
  36 .LP
  37 If the environment variable \fBDATEMSK\fR is set, \fBcalendar\fR will use its
  38 value as the full path name of a template file containing format strings. The
  39 strings consist of conversion specifications and text characters and are used
  40 to provide a richer set of allowable date formats in different languages by
  41 appropriate settings of the environment variable \fBLANG\fR or \fBLC_TIME\fR;
  42 see \fBenviron\fR(5). See\fBstrftime\fR(3C) for the list of allowable
  43 conversion specifications.
  44 .SH EXAMPLES
  45 .LP
  46 \fBExample 1 \fRPossible contents of a template
  47 .sp
  48 .LP
  49 The following example shows the possible contents of a template:
  50
  51 .sp
  52 .in +2
  53 .nf
  54 %B %eth of the year %Y
  55 .fi
  56 .in -2
  57 .sp
  58
  59 .sp
  60 .LP
  61 \fB%B\fR represents the full month name, \fB%e\fR the day of month and \fB%Y\fR
  62 the year (4 digits).
  63
  64 .sp
  65 .LP
  66 If \fBDATEMSK\fR is set to this template, the following \fBcalendar\fR file
  67 would be valid:
  68
  69 .sp
  70 .in +2
  71 .nf
  72 March 7th of the year 1989 <Reminder>
  73 .fi
  74 .in -2
  75 .sp
  76
  77 .SH ENVIRONMENT VARIABLES
  78 .sp
  79 .LP
  80 See \fBenviron\fR(5) for descriptions of the following environment variables
  81 that affect the execution of \fBcalendar\fR: \fBLC_CTYPE\fR, \fBLC_TIME\fR,
  82 \fBLC_MESSAGES\fR, \fBNLSPATH\fR, and \fBTZ\fR.
  83 .SH EXIT STATUS
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB0\fR \fR
  88 .ad
  89 .RS 7n
  90 Successful completion.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB>0\fR \fR
  97 .ad
  98 .RS 7n
  99 An error occurred.
 100 .RE
 101
 102 .SH FILES
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fB/etc/passwd\fR \fR
 107 .ad
 108 .RS 21n
 109 system password file
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB/tmp/cal*\fR \fR
 116 .ad
 117 .RS 21n
 118 temporary files used by \fBcalendar\fR
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB/usr/lib/calprog\fR \fR
 125 .ad
 126 .RS 21n
 127 program used to determine dates for today and tomorrow
 128 .RE
 129 .SH SEE ALSO
 130 .sp
 131 .LP
 132 \fBat\fR(1), \fBcrontab\fR(1), \fBmail\fR(1), \fBcron\fR(1M), \fBypbind\fR(1M),
 133 \fBstrftime\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5)
 134 .SH NOTES
 135 .sp
 136 .LP
 137 Appropriate lines beginning with white space will not be printed.
 138 .sp
 139 .LP
 140 Your calendar must be public information for you to get reminder service.
 141 .sp
 142 .LP
 143 \fBcalendar\fR's extended idea of ``tomorrow'' does not account for holidays.
 144 .sp
 145 .LP
 146 The \fB-\fR argument works only on calendar files that are local to the
 147 machine; \fBcalendar\fR is intended not to work on calendar files that are
 148 mounted remotely with \fBNFS.\fR Thus, `\fBcalendar \fR\fB-\fR' should be run
 149 only on diskful machines where home directories exist;  running it on a
 150 diskless client has no effect.
 151 .sp
 152 .LP
 153 \fBcalendar\fR is no longer in the default root crontab. Because of the network
 154 burden `\fBcalendar \fR\fB-\fR' can induce, it is inadvisable in an environment
 155 running \fBypbind\fR(1M) with a large passwd.byname map.  If, however, the
 156 usefulness of \fBcalendar\fR outweighs the network impact, the super-user may
 157 run `\fBcrontab\fR \fB-e\fR' to edit the root crontab. Otherwise, individual
 158 users may wish to use `\fBcrontab\fR \fB-e\fR' to edit their own crontabs to
 159 have \fBcron\fR invoke \fBcalendar\fR without the \fB-\fR argument, piping
 160 output to mail addressed to themselves.