| 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@10
|
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@1
|
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@1
|
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@1
|
42 Any other line specifies the name of a person or event, followed by an equals sign and
|
|
meillo@1
|
43 a date and finally some extra options. The date has to be in ISO 8601 date format (YYYY-MM-DD).
|
|
meillo@1
|
44 The extra options are:
|
|
meillo@1
|
45 .TP
|
|
meillo@1
|
46 .B bd
|
|
meillo@1
|
47 This line is a birthday (the default). The year, if given, should be when the person was born. A line designated as a
|
|
meillo@1
|
48 birthday will produce output like
|
|
meillo@1
|
49 .B Erin has a birthday in 3 days' time
|
|
meillo@1
|
50 or
|
|
meillo@1
|
51 .BR "Jemima is 3 in 2 weeks' time" .
|
|
meillo@1
|
52 .TP
|
|
meillo@1
|
53 .B ann
|
|
meillo@1
|
54 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
|
|
meillo@1
|
55 .B Pen exploded 3 years ago tomorrow
|
|
meillo@1
|
56 given a line such as
|
|
meillo@1
|
57 .BR "Pen exploded=1993-09-12 ann" .
|
|
meillo@1
|
58 .TP
|
|
meillo@1
|
59 .B ev
|
|
meillo@1
|
60 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
|
61 be displayed every year. The remaining time is simply appended to the text; for instance, the input
|
|
meillo@1
|
62 .B Easter=1996-04-07 ev
|
|
meillo@1
|
63 would give rise to the text
|
|
meillo@1
|
64 .BR "Easter in 1 week's time" .
|
|
meillo@1
|
65 .TP
|
|
meillo@1
|
66 .BI w n
|
|
meillo@1
|
67 Warn
|
|
meillo@1
|
68 .I n
|
|
meillo@10
|
69 days in advance of the date, rather than the default of 14 days or the number given with the
|
|
meillo@1
|
70 .B -W
|
|
meillo@1
|
71 flag.
|
|
meillo@1
|
72 .TP
|
|
meillo@10
|
73 .BI for\ days
|
|
meillo@4
|
74 The event lasts for
|
|
meillo@4
|
75 .B days
|
|
meillo@4
|
76 days.
|
|
meillo@4
|
77 .TP
|
|
meillo@10
|
78 .BI to\ date
|
|
meillo@1
|
79 The event lasts until
|
|
meillo@1
|
80 .IR date ,
|
|
meillo@1
|
81 which should be in the same format as for the date of the event.
|
|
meillo@1
|
82
|
|
meillo@1
|
83
|
|
meillo@1
|
84
|
|
meillo@1
|
85 .SH EXAMPLE
|
|
meillo@1
|
86
|
|
meillo@1
|
87 Joe Blow=1974-04-25
|
|
meillo@1
|
88
|
|
meillo@1
|
89
|
|
meillo@1
|
90
|
|
meillo@1
|
91 .SH SEE ALSO
|
|
meillo@1
|
92
|
|
meillo@10
|
93 .BR birthday (1),\ cal (1)
|
|
meillo@10
|
94
|
|
meillo@10
|
95
|
|
meillo@1
|
96
|
|
meillo@1
|
97 .SH BUGS
|
|
meillo@1
|
98 The program cannot warn more than one year in advance of anything.
|
|
meillo@1
|
99
|
|
meillo@10
|
100
|
|
meillo@10
|
101
|
|
meillo@1
|
102 .SH CREDITS
|
|
meillo@1
|
103
|
|
meillo@1
|
104 This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy!
|
|
meillo@1
|
105
|
|
meillo@10
|
106
|
|
meillo@10
|
107
|
|
meillo@1
|
108 .SH AUTHOR
|
|
meillo@10
|
109 markus schnalke <meillo@marmaro.de> and Andy Mortimer <andy.mortimer@zetnet.co.uk>
|
