1 .TH bday 1

2 .SH NAME

3 bday \- inform about upcoming birthdays and other events

4

5

6

7 .SH SYNOPSIS

8 .BR bday\ [ -w

9 .IR defwarn ]

10

11

12

13 .SH DESCRIPTION

14 The

15 .B bday

16 command reads standard input which gives a list of birthdays and events (see section

17 .B FILE FORMAT

18 for details). It produces a list of events which are coming up within the next few weeks.

19

20

21

22 .SH OPTIONS

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 ).

32 If this switch is not specified, it defaults to 14 days.

33

34

35

36 .SH FILE FORMAT

37

38 Each line beginning with a hash sign,

39 .RB ` # ',

40 is a comment and will be ignored.

41

42 Any other line specifies a date, optional modifiers, and the

43 name of a person or event.

44 The date has to be in ISO 8601 date format (YYYY-MM-DD).

45 The optional modifiers are words, starting with a hash symbol (#).

46 .TP

47 Without a modifier, the entry is a birthday.

48 The year, if given, should be when the person was born.

49 A line designated as a birthday will produce output like

50 .B In 3 days: Erin has a birthday.

51 .PP

52 The modifiers are:

53 .TP

54 .B #ann

55 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like

56 .B Tomorrow: Pen exploded 3 years ago

57 given a line such as

58 .BR "1993-09-12 #ann Pen exploded" .

59 .TP

60 .B #ev

61 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

62 be displayed every year. The remaining time is simply appended to the text; for instance, the input

63 .B 1996-04-07 #ev Easter

64 would give rise to the text

65 .BR "In 1 week: Easter" .

66 .TP

67 .BI #w n

68 Warn

69 .I n

70 days in advance of the date, rather than the default of 14 days or the number given with the

71 .B -w

72 flag.

73 .TP

74 .BI #for days

75 The event lasts for

76 .B days

77 days.

78 .TP

79 .BI #to date

80 The event lasts until

81 .IR date ,

82 which should be in the same format as for the date of the event.

83

84

85

86 .SH EXAMPLE

87

88 1974-04-25 Joe Blow

89

90

91

92 .SH SEE ALSO

93

94 .BR birthday (1),\ cal (1)

95

96

97

98 .SH BUGS

99 The program cannot warn more than one year in advance of anything.

100

101

102

103 .SH CREDITS

104

105 This Program is heavily based on birthday. But without all non

106 essential stuff. Nevertheless, much thanks for birthday, Andy!

107

108

109

110 .SH AUTHOR

111 markus schnalke <meillo@marmaro.de>

112 and Andy Mortimer <andy.mortimer@zetnet.co.uk>