bday

annotate bday.1 @ 3:dc2f94280b01

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