bday

annotate bday.1 @ 21:cd9bcd5e9027

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