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