Mercurial > bday

annotate bday.1 @ 19:eb4620a01023

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated the copyright note
author markus schnalke <meillo@marmaro.de>
date Mon, 24 Feb 2014 21:32:38 +0100
parents c1cd1d444353
children c621d710d12e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
1 .TH bday 1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
2 .SH NAME
18
c1cd1d444353 removed the type event: bday is only for birthdays and anniversaries
markus schnalke <meillo@marmaro.de>
parents: 17
diff changeset
3 bday \- inform about upcoming birthdays and anniversaries
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
4
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
5
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
6
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
7 .SH SYNOPSIS
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
8 .BR bday\ [ -w
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
9 .IR defwarn ]
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
10
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
11
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
12
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
13 .SH DESCRIPTION
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
14 The
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
15 .B bday
18
c1cd1d444353 removed the type event: bday is only for birthdays and anniversaries
markus schnalke <meillo@marmaro.de>
parents: 17
diff changeset
16 command reads standard input which gives a list of birthdays and anniversaries.
c1cd1d444353 removed the type event: bday is only for birthdays and anniversaries
markus schnalke <meillo@marmaro.de>
parents: 17
diff changeset
17 It produces a list of events which are coming up within the next few weeks.
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
18
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
19
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
20
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
21 .SH OPTIONS
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
22
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
23 .TP
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
24 .BI -w\ warn
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
25 Warn
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
26 .I warn
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
27 days in advance, for entries that have no
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
28 .B #w
18
c1cd1d444353 removed the type event: bday is only for birthdays and anniversaries
markus schnalke <meillo@marmaro.de>
parents: 17
diff changeset
29 flag.
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
30 If this switch is not specified, it defaults to 14 days.
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
31
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
32
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
33
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
34 .SH FILE FORMAT
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
35
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
36 Each line beginning with a hash sign,
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
37 .RB ` # ',
3
dc2f94280b01 new Makefile; removed MinWarn and MaxWarn; adjusted manpage
meillo@marmaro.de
parents: 1
diff changeset
38 is a comment and will be ignored.
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
39
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
40 Any other line specifies a date, optional modifiers, and the
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
41 name of a person or event.
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
42 The date has to be in ISO 8601 date format (YYYY-MM-DD).
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
43 The optional modifiers are words, starting with a hash symbol (#).
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
44 .TP
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
45 Without a modifier, the entry is a birthday.
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
46 The year, if given, should be when the person was born.
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
47 A line designated as a birthday will produce output like
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
48 .B In 3 days: Erin has a birthday.
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
49 .PP
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
50 The modifiers are:
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
51 .TP
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
52 .B #ann
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
53 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
54 .B Tomorrow: Pen exploded 3 years ago
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
55 given a line such as
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
56 .BR "1993-09-12 #ann Pen exploded" .
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
57 .TP
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
58 .BI #w n
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
59 Warn
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
60 .I n
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
61 days in advance of the date, rather than the default of 14 days or the number given with the
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
62 .B -w
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
63 flag.
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
64
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
65
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
66
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
67 .SH EXAMPLE
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
68
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
69 1974-04-25 Joe Blow
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
70
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
71
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
72
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
73 .SH SEE ALSO
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
74
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
75 .BR birthday (1),\ cal (1)
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
76
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
77
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
78
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
79 .SH BUGS
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
80 The program cannot warn more than one year in advance of anything.
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
81
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
82
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
83
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
84 .SH CREDITS
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
85
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
86 This Program is heavily based on birthday. But without all non
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
87 essential stuff. Nevertheless, much thanks for birthday, Andy!
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
88
10
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
89
6d25afd91132 adjusted manpage
meillo@marmaro.de
parents: 4
diff changeset
90
1
8534f0e3a0db added manpage; adjusted makefile
meillo@marmaro.de
parents:
diff changeset
91 .SH AUTHOR
17
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
92 markus schnalke <meillo@marmaro.de>
d18a3b2b76bd updated man page; s/-W/-w/
markus schnalke <meillo@marmaro.de>
parents: 10
diff changeset
93 and Andy Mortimer <andy.mortimer@zetnet.co.uk>