meillo@1: .TH bday 1
meillo@1: .SH NAME
meillo@1: bday \- inform about upcoming birthdays and other events
meillo@1: .SH SYNOPSIS
meillo@1: .BR bday\  [ -f
meillo@1: .IR file ]
meillo@1: .RB [ -W
meillo@1: .IR defwarn ]
meillo@1: 
meillo@1: .SH DESCRIPTION
meillo@1: The 
meillo@1: .B bday
meillo@1: command reads a file, by default
meillo@1: .IR ~/.birthdays ,
meillo@1: which gives a list of birthdays and events (see section
meillo@1: .B FILE FORMAT
meillo@1: for details). It produces a list of events which are coming up within the next few weeks.
meillo@1: 
meillo@1: .SH OPTIONS
meillo@1: 
meillo@1: .TP
meillo@1: .BI -f\  file
meillo@1: Read the events from
meillo@1: .I file
meillo@1: rather than
meillo@1: .IR ~/.birthdays.
meillo@1: If
meillo@1: .I file
meillo@1: is a single hyphen, read the events from the standard input (usually
meillo@1: the terminal).
meillo@1: 
meillo@1: .TP
meillo@1: .BI -W\  warn
meillo@1: Warn
meillo@1: .I warn
meillo@1: days in advance, for entries that have no
meillo@1: .B w
meillo@1: flag (see
meillo@1: .BR FILE\ FORMAT ).
meillo@1: If this switch is not specified, it defaults to 21 days.
meillo@1: 
meillo@1: 
meillo@1: .SH FILE FORMAT
meillo@1: 
meillo@1: Each line beginning with a hash sign, 
meillo@1: .RB ` # ',
meillo@3: is a comment and will be ignored.
meillo@1: 
meillo@1: Any other line specifies the name of a person or event, followed by an equals sign and
meillo@1: a date and finally some extra options. The date has to be in ISO 8601 date format (YYYY-MM-DD).
meillo@1: The extra options are:
meillo@1: .TP
meillo@1: .B bd
meillo@1: 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: birthday will produce output like
meillo@1: .B Erin has a birthday in 3 days' time
meillo@1: or
meillo@1: .BR "Jemima is 3 in 2 weeks' time" .
meillo@1: .TP
meillo@1: .B ann
meillo@1: This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
meillo@1: .B Pen exploded 3 years ago tomorrow
meillo@1: given a line such as
meillo@1: .BR "Pen exploded=1993-09-12 ann" .
meillo@1: .TP
meillo@1: .B ev
meillo@1: 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: be displayed every year. The remaining time is simply appended to the text; for instance, the input
meillo@1: .B Easter=1996-04-07 ev
meillo@1: would give rise to the text
meillo@1: .BR "Easter in 1 week's time" .
meillo@1: .TP
meillo@1: .BI w n
meillo@1: Warn
meillo@1: .I n
meillo@1: days in advance of the date, rather than the default of 21 days or the number given with the
meillo@1: .B -W
meillo@1: flag.
meillo@1: .TP
meillo@1: .BI to date
meillo@1: The event lasts until
meillo@1: .IR date ,
meillo@1: which should be in the same format as for the date of the event.
meillo@1: .TP
meillo@1: .BI for days
meillo@1: The event lasts for
meillo@1: .B days
meillo@1: days.
meillo@1: 
meillo@1: .SH DATE SPECIFICATION
meillo@1: 
meillo@1: This version of of the programm is patched to only handle standard ISO 8601 date format now.
meillo@1: The intention to do change this behavior was to eliminate all those problems with different date formats.
meillo@1: IMHO we have standards to use them. Backward compatibility is not that important here, in my eyes.
meillo@1: 
meillo@1: .SH EXAMPLE
meillo@1: 
meillo@1: Joe Blow=1974-04-25
meillo@1: 
meillo@1: .SH FILES
meillo@1: 
meillo@1: .TP
meillo@1: .I ~/.birthdays
meillo@1: Your default birthdays file.
meillo@1: 
meillo@1: .SH SEE ALSO
meillo@1: 
meillo@1: .BR birthday (1),
meillo@1: cal (1)
meillo@1: 
meillo@1: .SH BUGS
meillo@1: The program cannot warn more than one year in advance of anything.
meillo@1: 
meillo@1: .SH CREDITS
meillo@1: 
meillo@1: This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy!
meillo@1: 
meillo@1: .SH AUTHOR
meillo@1: Andy Mortimer <andy.mortimer@zetnet.co.uk> and markus schnalke <meillo@marmaro.de>