1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/bday.1	Sun Dec 16 22:52:15 2007 +0100
     1.3 @@ -0,0 +1,144 @@
     1.4 +.TH bday 1
     1.5 +.SH NAME
     1.6 +bday \- inform about upcoming birthdays and other events
     1.7 +.SH SYNOPSIS
     1.8 +.BR bday\  [ -f
     1.9 +.IR file ]
    1.10 +.RB [ -W
    1.11 +.IR defwarn ]
    1.12 +.RB [ -M
    1.13 +.IR maxwarn ]
    1.14 +.RB [ -m
    1.15 +.IR minwarn ]
    1.16 +
    1.17 +.SH DESCRIPTION
    1.18 +The 
    1.19 +.B bday
    1.20 +command reads a file, by default
    1.21 +.IR ~/.birthdays ,
    1.22 +which gives a list of birthdays and events (see section
    1.23 +.B FILE FORMAT
    1.24 +for details). It produces a list of events which are coming up within the next few weeks.
    1.25 +
    1.26 +.SH OPTIONS
    1.27 +
    1.28 +.TP
    1.29 +.BI -f\  file
    1.30 +Read the events from
    1.31 +.I file
    1.32 +rather than
    1.33 +.IR ~/.birthdays.
    1.34 +If
    1.35 +.I file
    1.36 +is a single hyphen, read the events from the standard input (usually
    1.37 +the terminal).
    1.38 +
    1.39 +.SS List Options
    1.40 +
    1.41 +.TP
    1.42 +.BI -W\  warn
    1.43 +Warn
    1.44 +.I warn
    1.45 +days in advance, for entries that have no
    1.46 +.B w
    1.47 +flag (see
    1.48 +.BR FILE\ FORMAT ).
    1.49 +If this switch is not specified, it defaults to 21 days.
    1.50 +.TP
    1.51 +.BI -M\  max
    1.52 +Warn at most
    1.53 +.I max
    1.54 +days in advance. This overrides any flag given in the file.
    1.55 +.TP
    1.56 +.BI -m\  min
    1.57 +Warn at least
    1.58 +.I min
    1.59 +days in advance. This overrides any flag given in the file.
    1.60 +
    1.61 +
    1.62 +.SH FILE FORMAT
    1.63 +
    1.64 +Each line beginning with a hash sign, 
    1.65 +.RB ` # ',
    1.66 +is a comment and will be ignored. Lines beginning with an ampersand,
    1.67 +.RB ` & ',
    1.68 +are directives. Currently there is only one such directive,
    1.69 +.B &include
    1.70 +.IR file ,
    1.71 +which reads in a seperate file from your
    1.72 +.I .birthdays
    1.73 +file.
    1.74 +.I file
    1.75 +should be given with an absolute path, which should not use the tilde notation to specify your home directory.
    1.76 +
    1.77 +Any other line specifies the name of a person or event, followed by an equals sign and
    1.78 +a date and finally some extra options. The date has to be in ISO 8601 date format (YYYY-MM-DD).
    1.79 +The extra options are:
    1.80 +.TP
    1.81 +.B bd
    1.82 +This line is a birthday (the default). The year, if given, should be when the person was born. A line designated as a
    1.83 +birthday will produce output like
    1.84 +.B Erin has a birthday in 3 days' time
    1.85 +or
    1.86 +.BR "Jemima is 3 in 2 weeks' time" .
    1.87 +.TP
    1.88 +.B ann
    1.89 +This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like
    1.90 +.B Pen exploded 3 years ago tomorrow
    1.91 +given a line such as
    1.92 +.BR "Pen exploded=1993-09-12 ann" .
    1.93 +.TP
    1.94 +.B ev
    1.95 +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
    1.96 +be displayed every year. The remaining time is simply appended to the text; for instance, the input
    1.97 +.B Easter=1996-04-07 ev
    1.98 +would give rise to the text
    1.99 +.BR "Easter in 1 week's time" .
   1.100 +.TP
   1.101 +.BI w n
   1.102 +Warn
   1.103 +.I n
   1.104 +days in advance of the date, rather than the default of 21 days or the number given with the
   1.105 +.B -W
   1.106 +flag.
   1.107 +.TP
   1.108 +.BI to date
   1.109 +The event lasts until
   1.110 +.IR date ,
   1.111 +which should be in the same format as for the date of the event.
   1.112 +.TP
   1.113 +.BI for days
   1.114 +The event lasts for
   1.115 +.B days
   1.116 +days.
   1.117 +
   1.118 +.SH DATE SPECIFICATION
   1.119 +
   1.120 +This version of of the programm is patched to only handle standard ISO 8601 date format now.
   1.121 +The intention to do change this behavior was to eliminate all those problems with different date formats.
   1.122 +IMHO we have standards to use them. Backward compatibility is not that important here, in my eyes.
   1.123 +
   1.124 +.SH EXAMPLE
   1.125 +
   1.126 +Joe Blow=1974-04-25
   1.127 +
   1.128 +.SH FILES
   1.129 +
   1.130 +.TP
   1.131 +.I ~/.birthdays
   1.132 +Your default birthdays file.
   1.133 +
   1.134 +.SH SEE ALSO
   1.135 +
   1.136 +.BR birthday (1),
   1.137 +cal (1)
   1.138 +
   1.139 +.SH BUGS
   1.140 +The program cannot warn more than one year in advance of anything.
   1.141 +
   1.142 +.SH CREDITS
   1.143 +
   1.144 +This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy!
   1.145 +
   1.146 +.SH AUTHOR
   1.147 +Andy Mortimer <andy.mortimer@zetnet.co.uk> and markus schnalke <meillo@marmaro.de>