bday
diff bday.1 @ 17:d18a3b2b76bd
updated man page; s/-W/-w/
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Mon, 24 Feb 2014 21:22:21 +0100 |
parents | 6d25afd91132 |
children | c1cd1d444353 |
line diff
1.1 --- a/bday.1 Mon Feb 24 21:11:38 2014 +0100 1.2 +++ b/bday.1 Mon Feb 24 21:22:21 2014 +0100 1.3 @@ -5,7 +5,7 @@ 1.4 1.5 1.6 .SH SYNOPSIS 1.7 -.BR bday\ [ -W 1.8 +.BR bday\ [ -w 1.9 .IR defwarn ] 1.10 1.11 1.12 @@ -22,11 +22,11 @@ 1.13 .SH OPTIONS 1.14 1.15 .TP 1.16 -.BI -W\ warn 1.17 +.BI -w\ warn 1.18 Warn 1.19 .I warn 1.20 days in advance, for entries that have no 1.21 -.B w 1.22 +.B #w 1.23 flag (see 1.24 .BR FILE\ FORMAT ). 1.25 If this switch is not specified, it defaults to 14 days. 1.26 @@ -39,43 +39,44 @@ 1.27 .RB ` # ', 1.28 is a comment and will be ignored. 1.29 1.30 -Any other line specifies the name of a person or event, followed by an equals sign and 1.31 -a date and finally some extra options. The date has to be in ISO 8601 date format (YYYY-MM-DD). 1.32 -The extra options are: 1.33 +Any other line specifies a date, optional modifiers, and the 1.34 +name of a person or event. 1.35 +The date has to be in ISO 8601 date format (YYYY-MM-DD). 1.36 +The optional modifiers are words, starting with a hash symbol (#). 1.37 .TP 1.38 -.B bd 1.39 -This line is a birthday (the default). The year, if given, should be when the person was born. A line designated as a 1.40 -birthday will produce output like 1.41 -.B Erin has a birthday in 3 days' time 1.42 -or 1.43 -.BR "Jemima is 3 in 2 weeks' time" . 1.44 +Without a modifier, the entry is a birthday. 1.45 +The year, if given, should be when the person was born. 1.46 +A line designated as a birthday will produce output like 1.47 +.B In 3 days: Erin has a birthday. 1.48 +.PP 1.49 +The modifiers are: 1.50 .TP 1.51 -.B ann 1.52 +.B #ann 1.53 This line is an anniversary. The year, if given, should be the year in which the thing happened, producing output like 1.54 -.B Pen exploded 3 years ago tomorrow 1.55 +.B Tomorrow: Pen exploded 3 years ago 1.56 given a line such as 1.57 -.BR "Pen exploded=1993-09-12 ann" . 1.58 +.BR "1993-09-12 #ann Pen exploded" . 1.59 .TP 1.60 -.B ev 1.61 +.B #ev 1.62 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.63 be displayed every year. The remaining time is simply appended to the text; for instance, the input 1.64 -.B Easter=1996-04-07 ev 1.65 +.B 1996-04-07 #ev Easter 1.66 would give rise to the text 1.67 -.BR "Easter in 1 week's time" . 1.68 +.BR "In 1 week: Easter" . 1.69 .TP 1.70 -.BI w n 1.71 +.BI #w n 1.72 Warn 1.73 .I n 1.74 days in advance of the date, rather than the default of 14 days or the number given with the 1.75 -.B -W 1.76 +.B -w 1.77 flag. 1.78 .TP 1.79 -.BI for\ days 1.80 +.BI #for days 1.81 The event lasts for 1.82 .B days 1.83 days. 1.84 .TP 1.85 -.BI to\ date 1.86 +.BI #to date 1.87 The event lasts until 1.88 .IR date , 1.89 which should be in the same format as for the date of the event. 1.90 @@ -84,7 +85,7 @@ 1.91 1.92 .SH EXAMPLE 1.93 1.94 -Joe Blow=1974-04-25 1.95 +1974-04-25 Joe Blow 1.96 1.97 1.98 1.99 @@ -101,9 +102,11 @@ 1.100 1.101 .SH CREDITS 1.102 1.103 -This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy! 1.104 +This Program is heavily based on birthday. But without all non 1.105 +essential stuff. Nevertheless, much thanks for birthday, Andy! 1.106 1.107 1.108 1.109 .SH AUTHOR 1.110 -markus schnalke <meillo@marmaro.de> and Andy Mortimer <andy.mortimer@zetnet.co.uk> 1.111 +markus schnalke <meillo@marmaro.de> 1.112 +and Andy Mortimer <andy.mortimer@zetnet.co.uk>