| 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@1
|
4 .SH SYNOPSIS
|
|
meillo@1
|
5 .BR bday\ [ -f
|
|
meillo@1
|
6 .IR file ]
|
|
meillo@1
|
7 .RB [ -W
|
|
meillo@1
|
8 .IR defwarn ]
|
|
meillo@1
|
9 .RB [ -M
|
|
meillo@1
|
10 .IR maxwarn ]
|
|
meillo@1
|
11 .RB [ -m
|
|
meillo@1
|
12 .IR minwarn ]
|
|
meillo@1
|
13
|
|
meillo@1
|
14 .SH DESCRIPTION
|
|
meillo@1
|
15 The
|
|
meillo@1
|
16 .B bday
|
|
meillo@1
|
17 command reads a file, by default
|
|
meillo@1
|
18 .IR ~/.birthdays ,
|
|
meillo@1
|
19 which gives a list of birthdays and events (see section
|
|
meillo@1
|
20 .B FILE FORMAT
|
|
meillo@1
|
21 for details). It produces a list of events which are coming up within the next few weeks.
|
|
meillo@1
|
22
|
|
meillo@1
|
23 .SH OPTIONS
|
|
meillo@1
|
24
|
|
meillo@1
|
25 .TP
|
|
meillo@1
|
26 .BI -f\ file
|
|
meillo@1
|
27 Read the events from
|
|
meillo@1
|
28 .I file
|
|
meillo@1
|
29 rather than
|
|
meillo@1
|
30 .IR ~/.birthdays.
|
|
meillo@1
|
31 If
|
|
meillo@1
|
32 .I file
|
|
meillo@1
|
33 is a single hyphen, read the events from the standard input (usually
|
|
meillo@1
|
34 the terminal).
|
|
meillo@1
|
35
|
|
meillo@1
|
36 .SS List Options
|
|
meillo@1
|
37
|
|
meillo@1
|
38 .TP
|
|
meillo@1
|
39 .BI -W\ warn
|
|
meillo@1
|
40 Warn
|
|
meillo@1
|
41 .I warn
|
|
meillo@1
|
42 days in advance, for entries that have no
|
|
meillo@1
|
43 .B w
|
|
meillo@1
|
44 flag (see
|
|
meillo@1
|
45 .BR FILE\ FORMAT ).
|
|
meillo@1
|
46 If this switch is not specified, it defaults to 21 days.
|
|
meillo@1
|
47 .TP
|
|
meillo@1
|
48 .BI -M\ max
|
|
meillo@1
|
49 Warn at most
|
|
meillo@1
|
50 .I max
|
|
meillo@1
|
51 days in advance. This overrides any flag given in the file.
|
|
meillo@1
|
52 .TP
|
|
meillo@1
|
53 .BI -m\ min
|
|
meillo@1
|
54 Warn at least
|
|
meillo@1
|
55 .I min
|
|
meillo@1
|
56 days in advance. This overrides any flag given in the file.
|
|
meillo@1
|
57
|
|
meillo@1
|
58
|
|
meillo@1
|
59 .SH FILE FORMAT
|
|
meillo@1
|
60
|
|
meillo@1
|
61 Each line beginning with a hash sign,
|
|
meillo@1
|
62 .RB ` # ',
|
|
meillo@1
|
63 is a comment and will be ignored. Lines beginning with an ampersand,
|
|
meillo@1
|
64 .RB ` & ',
|
|
meillo@1
|
65 are directives. Currently there is only one such directive,
|
|
meillo@1
|
66 .B &include
|
|
meillo@1
|
67 .IR file ,
|
|
meillo@1
|
68 which reads in a seperate file from your
|
|
meillo@1
|
69 .I .birthdays
|
|
meillo@1
|
70 file.
|
|
meillo@1
|
71 .I file
|
|
meillo@1
|
72 should be given with an absolute path, which should not use the tilde notation to specify your home directory.
|
|
meillo@1
|
73
|
|
meillo@1
|
74 Any other line specifies the name of a person or event, followed by an equals sign and
|
|
meillo@1
|
75 a date and finally some extra options. The date has to be in ISO 8601 date format (YYYY-MM-DD).
|
|
meillo@1
|
76 The extra options are:
|
|
meillo@1
|
77 .TP
|
|
meillo@1
|
78 .B bd
|
|
meillo@1
|
79 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
|
80 birthday will produce output like
|
|
meillo@1
|
81 .B Erin has a birthday in 3 days' time
|
|
meillo@1
|
82 or
|
|
meillo@1
|
83 .BR "Jemima is 3 in 2 weeks' time" .
|
|
meillo@1
|
84 .TP
|
|
meillo@1
|
85 .B ann
|
|
meillo@1
|
86 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
|
|
meillo@1
|
87 .B Pen exploded 3 years ago tomorrow
|
|
meillo@1
|
88 given a line such as
|
|
meillo@1
|
89 .BR "Pen exploded=1993-09-12 ann" .
|
|
meillo@1
|
90 .TP
|
|
meillo@1
|
91 .B ev
|
|
meillo@1
|
92 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
|
93 be displayed every year. The remaining time is simply appended to the text; for instance, the input
|
|
meillo@1
|
94 .B Easter=1996-04-07 ev
|
|
meillo@1
|
95 would give rise to the text
|
|
meillo@1
|
96 .BR "Easter in 1 week's time" .
|
|
meillo@1
|
97 .TP
|
|
meillo@1
|
98 .BI w n
|
|
meillo@1
|
99 Warn
|
|
meillo@1
|
100 .I n
|
|
meillo@1
|
101 days in advance of the date, rather than the default of 21 days or the number given with the
|
|
meillo@1
|
102 .B -W
|
|
meillo@1
|
103 flag.
|
|
meillo@1
|
104 .TP
|
|
meillo@1
|
105 .BI to date
|
|
meillo@1
|
106 The event lasts until
|
|
meillo@1
|
107 .IR date ,
|
|
meillo@1
|
108 which should be in the same format as for the date of the event.
|
|
meillo@1
|
109 .TP
|
|
meillo@1
|
110 .BI for days
|
|
meillo@1
|
111 The event lasts for
|
|
meillo@1
|
112 .B days
|
|
meillo@1
|
113 days.
|
|
meillo@1
|
114
|
|
meillo@1
|
115 .SH DATE SPECIFICATION
|
|
meillo@1
|
116
|
|
meillo@1
|
117 This version of of the programm is patched to only handle standard ISO 8601 date format now.
|
|
meillo@1
|
118 The intention to do change this behavior was to eliminate all those problems with different date formats.
|
|
meillo@1
|
119 IMHO we have standards to use them. Backward compatibility is not that important here, in my eyes.
|
|
meillo@1
|
120
|
|
meillo@1
|
121 .SH EXAMPLE
|
|
meillo@1
|
122
|
|
meillo@1
|
123 Joe Blow=1974-04-25
|
|
meillo@1
|
124
|
|
meillo@1
|
125 .SH FILES
|
|
meillo@1
|
126
|
|
meillo@1
|
127 .TP
|
|
meillo@1
|
128 .I ~/.birthdays
|
|
meillo@1
|
129 Your default birthdays file.
|
|
meillo@1
|
130
|
|
meillo@1
|
131 .SH SEE ALSO
|
|
meillo@1
|
132
|
|
meillo@1
|
133 .BR birthday (1),
|
|
meillo@1
|
134 cal (1)
|
|
meillo@1
|
135
|
|
meillo@1
|
136 .SH BUGS
|
|
meillo@1
|
137 The program cannot warn more than one year in advance of anything.
|
|
meillo@1
|
138
|
|
meillo@1
|
139 .SH CREDITS
|
|
meillo@1
|
140
|
|
meillo@1
|
141 This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy!
|
|
meillo@1
|
142
|
|
meillo@1
|
143 .SH AUTHOR
|
|
meillo@1
|
144 Andy Mortimer <andy.mortimer@zetnet.co.uk> and markus schnalke <meillo@marmaro.de>
|
