| rev |
line source |
|
meillo@1
|
1 .TH bday 1
|
|
meillo@1
|
2 .SH NAME
|
|
meillo@1
|
3 bday \- inform about upcoming birthdays and other events
|
|
meillo@10
|
4
|
|
meillo@10
|
5
|
|
meillo@10
|
6
|
|
meillo@1
|
7 .SH SYNOPSIS
|
|
meillo@17
|
8 .BR bday\ [ -w
|
|
meillo@1
|
9 .IR defwarn ]
|
|
meillo@1
|
10
|
|
meillo@10
|
11
|
|
meillo@10
|
12
|
|
meillo@1
|
13 .SH DESCRIPTION
|
|
meillo@1
|
14 The
|
|
meillo@1
|
15 .B bday
|
|
meillo@10
|
16 command reads standard input which gives a list of birthdays and events (see section
|
|
meillo@1
|
17 .B FILE FORMAT
|
|
meillo@1
|
18 for details). It produces a list of events which are coming up within the next few weeks.
|
|
meillo@1
|
19
|
|
meillo@10
|
20
|
|
meillo@10
|
21
|
|
meillo@1
|
22 .SH OPTIONS
|
|
meillo@1
|
23
|
|
meillo@1
|
24 .TP
|
|
meillo@17
|
25 .BI -w\ warn
|
|
meillo@1
|
26 Warn
|
|
meillo@1
|
27 .I warn
|
|
meillo@1
|
28 days in advance, for entries that have no
|
|
meillo@17
|
29 .B #w
|
|
meillo@1
|
30 flag (see
|
|
meillo@1
|
31 .BR FILE\ FORMAT ).
|
|
meillo@10
|
32 If this switch is not specified, it defaults to 14 days.
|
|
meillo@10
|
33
|
|
meillo@1
|
34
|
|
meillo@1
|
35
|
|
meillo@1
|
36 .SH FILE FORMAT
|
|
meillo@1
|
37
|
|
meillo@10
|
38 Each line beginning with a hash sign,
|
|
meillo@1
|
39 .RB ` # ',
|
|
meillo@3
|
40 is a comment and will be ignored.
|
|
meillo@1
|
41
|
|
meillo@17
|
42 Any other line specifies a date, optional modifiers, and the
|
|
meillo@17
|
43 name of a person or event.
|
|
meillo@17
|
44 The date has to be in ISO 8601 date format (YYYY-MM-DD).
|
|
meillo@17
|
45 The optional modifiers are words, starting with a hash symbol (#).
|
|
meillo@1
|
46 .TP
|
|
meillo@17
|
47 Without a modifier, the entry is a birthday.
|
|
meillo@17
|
48 The year, if given, should be when the person was born.
|
|
meillo@17
|
49 A line designated as a birthday will produce output like
|
|
meillo@17
|
50 .B In 3 days: Erin has a birthday.
|
|
meillo@17
|
51 .PP
|
|
meillo@17
|
52 The modifiers are:
|
|
meillo@1
|
53 .TP
|
|
meillo@17
|
54 .B #ann
|
|
meillo@1
|
55 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
|
|
meillo@17
|
56 .B Tomorrow: Pen exploded 3 years ago
|
|
meillo@1
|
57 given a line such as
|
|
meillo@17
|
58 .BR "1993-09-12 #ann Pen exploded" .
|
|
meillo@1
|
59 .TP
|
|
meillo@17
|
60 .B #ev
|
|
meillo@1
|
61 This line is an event of some sort. If a year is given, the text will be displayed in that year only; otherwise, it will
|
|
meillo@1
|
62 be displayed every year. The remaining time is simply appended to the text; for instance, the input
|
|
meillo@17
|
63 .B 1996-04-07 #ev Easter
|
|
meillo@1
|
64 would give rise to the text
|
|
meillo@17
|
65 .BR "In 1 week: Easter" .
|
|
meillo@1
|
66 .TP
|
|
meillo@17
|
67 .BI #w n
|
|
meillo@1
|
68 Warn
|
|
meillo@1
|
69 .I n
|
|
meillo@10
|
70 days in advance of the date, rather than the default of 14 days or the number given with the
|
|
meillo@17
|
71 .B -w
|
|
meillo@1
|
72 flag.
|
|
meillo@1
|
73 .TP
|
|
meillo@17
|
74 .BI #for days
|
|
meillo@4
|
75 The event lasts for
|
|
meillo@4
|
76 .B days
|
|
meillo@4
|
77 days.
|
|
meillo@4
|
78 .TP
|
|
meillo@17
|
79 .BI #to date
|
|
meillo@1
|
80 The event lasts until
|
|
meillo@1
|
81 .IR date ,
|
|
meillo@1
|
82 which should be in the same format as for the date of the event.
|
|
meillo@1
|
83
|
|
meillo@1
|
84
|
|
meillo@1
|
85
|
|
meillo@1
|
86 .SH EXAMPLE
|
|
meillo@1
|
87
|
|
meillo@17
|
88 1974-04-25 Joe Blow
|
|
meillo@1
|
89
|
|
meillo@1
|
90
|
|
meillo@1
|
91
|
|
meillo@1
|
92 .SH SEE ALSO
|
|
meillo@1
|
93
|
|
meillo@10
|
94 .BR birthday (1),\ cal (1)
|
|
meillo@10
|
95
|
|
meillo@10
|
96
|
|
meillo@1
|
97
|
|
meillo@1
|
98 .SH BUGS
|
|
meillo@1
|
99 The program cannot warn more than one year in advance of anything.
|
|
meillo@1
|
100
|
|
meillo@10
|
101
|
|
meillo@10
|
102
|
|
meillo@1
|
103 .SH CREDITS
|
|
meillo@1
|
104
|
|
meillo@17
|
105 This Program is heavily based on birthday. But without all non
|
|
meillo@17
|
106 essential stuff. Nevertheless, much thanks for birthday, Andy!
|
|
meillo@1
|
107
|
|
meillo@10
|
108
|
|
meillo@10
|
109
|
|
meillo@1
|
110 .SH AUTHOR
|
|
meillo@17
|
111 markus schnalke <meillo@marmaro.de>
|
|
meillo@17
|
112 and Andy Mortimer <andy.mortimer@zetnet.co.uk>
|
