bday
view bday.1 @ 24:c621d710d12e
added VERSION to man page
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Mon, 24 Feb 2014 21:44:02 +0100 |
parents | c1cd1d444353 |
children |
line source
1 .TH bday 1 VERSION
2 .SH NAME
3 bday \- inform about upcoming birthdays and anniversaries
7 .SH SYNOPSIS
8 .BR bday\ [ -w
9 .IR defwarn ]
13 .SH DESCRIPTION
14 The
15 .B bday
16 command reads standard input which gives a list of birthdays and anniversaries.
17 It produces a list of events which are coming up within the next few weeks.
21 .SH OPTIONS
23 .TP
24 .BI -w\ warn
25 Warn
26 .I warn
27 days in advance, for entries that have no
28 .B #w
29 flag.
30 If this switch is not specified, it defaults to 14 days.
34 .SH FILE FORMAT
36 Each line beginning with a hash sign,
37 .RB ` # ',
38 is a comment and will be ignored.
40 Any other line specifies a date, optional modifiers, and the
41 name of a person or event.
42 The date has to be in ISO 8601 date format (YYYY-MM-DD).
43 The optional modifiers are words, starting with a hash symbol (#).
44 .TP
45 Without a modifier, the entry is a birthday.
46 The year, if given, should be when the person was born.
47 A line designated as a birthday will produce output like
48 .B In 3 days: Erin has a birthday.
49 .PP
50 The modifiers are:
51 .TP
52 .B #ann
53 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
54 .B Tomorrow: Pen exploded 3 years ago
55 given a line such as
56 .BR "1993-09-12 #ann Pen exploded" .
57 .TP
58 .BI #w n
59 Warn
60 .I n
61 days in advance of the date, rather than the default of 14 days or the number given with the
62 .B -w
63 flag.
67 .SH EXAMPLE
69 1974-04-25 Joe Blow
73 .SH SEE ALSO
75 .BR birthday (1),\ cal (1)
79 .SH BUGS
80 The program cannot warn more than one year in advance of anything.
84 .SH CREDITS
86 This Program is heavily based on birthday. But without all non
87 essential stuff. Nevertheless, much thanks for birthday, Andy!
91 .SH AUTHOR
92 markus schnalke <meillo@marmaro.de>
93 and Andy Mortimer <andy.mortimer@zetnet.co.uk>