bday

changeset 10:6d25afd91132

adjusted manpage
author meillo@marmaro.de
date Wed, 19 Dec 2007 01:26:56 +0100
parents 4f48b4f86e3d
children 9bd926eb89fa
files bday.1
diffstat 1 files changed, 23 insertions(+), 33 deletions(-) [+]
line diff
     1.1 --- a/bday.1	Wed Dec 19 01:19:57 2007 +0100
     1.2 +++ b/bday.1	Wed Dec 19 01:26:56 2007 +0100
     1.3 @@ -1,35 +1,27 @@
     1.4  .TH bday 1
     1.5  .SH NAME
     1.6  bday \- inform about upcoming birthdays and other events
     1.7 +
     1.8 +
     1.9 +
    1.10  .SH SYNOPSIS
    1.11 -.BR bday\  [ -f
    1.12 -.IR file ]
    1.13 -.RB [ -W
    1.14 +.BR bday\  [ -W
    1.15  .IR defwarn ]
    1.16  
    1.17 +
    1.18 +
    1.19  .SH DESCRIPTION
    1.20  The 
    1.21  .B bday
    1.22 -command reads a file, by default
    1.23 -.IR ~/.birthdays ,
    1.24 -which gives a list of birthdays and events (see section
    1.25 +command reads standard input which gives a list of birthdays and events (see section
    1.26  .B FILE FORMAT
    1.27  for details). It produces a list of events which are coming up within the next few weeks.
    1.28  
    1.29 +
    1.30 +
    1.31  .SH OPTIONS
    1.32  
    1.33  .TP
    1.34 -.BI -f\  file
    1.35 -Read the events from
    1.36 -.I file
    1.37 -rather than
    1.38 -.IR ~/.birthdays.
    1.39 -If
    1.40 -.I file
    1.41 -is a single hyphen, read the events from the standard input (usually
    1.42 -the terminal).
    1.43 -
    1.44 -.TP
    1.45  .BI -W\  warn
    1.46  Warn
    1.47  .I warn
    1.48 @@ -37,12 +29,13 @@
    1.49  .B w
    1.50  flag (see
    1.51  .BR FILE\ FORMAT ).
    1.52 -If this switch is not specified, it defaults to 21 days.
    1.53 +If this switch is not specified, it defaults to 14 days.
    1.54 +
    1.55  
    1.56  
    1.57  .SH FILE FORMAT
    1.58  
    1.59 -Each line beginning with a hash sign, 
    1.60 +Each line beginning with a hash sign,
    1.61  .RB ` # ',
    1.62  is a comment and will be ignored.
    1.63  
    1.64 @@ -73,47 +66,44 @@
    1.65  .BI w n
    1.66  Warn
    1.67  .I n
    1.68 -days in advance of the date, rather than the default of 21 days or the number given with the
    1.69 +days in advance of the date, rather than the default of 14 days or the number given with the
    1.70  .B -W
    1.71  flag.
    1.72  .TP
    1.73 -.BI for days
    1.74 +.BI for\   days
    1.75  The event lasts for
    1.76  .B days
    1.77  days.
    1.78  .TP
    1.79 -.BI to date
    1.80 +.BI to\  date
    1.81  The event lasts until
    1.82  .IR date ,
    1.83  which should be in the same format as for the date of the event.
    1.84  
    1.85 -.SH DATE SPECIFICATION
    1.86  
    1.87 -This version of of the programm is patched to only handle standard ISO 8601 date format now.
    1.88 -The intention to do change this behavior was to eliminate all those problems with different date formats.
    1.89 -IMHO we have standards to use them. Backward compatibility is not that important here, in my eyes.
    1.90  
    1.91  .SH EXAMPLE
    1.92  
    1.93  Joe Blow=1974-04-25
    1.94  
    1.95 -.SH FILES
    1.96  
    1.97 -.TP
    1.98 -.I ~/.birthdays
    1.99 -Your default birthdays file.
   1.100  
   1.101  .SH SEE ALSO
   1.102  
   1.103 -.BR birthday (1),
   1.104 -cal (1)
   1.105 +.BR birthday (1),\  cal (1)
   1.106 +
   1.107 +
   1.108  
   1.109  .SH BUGS
   1.110  The program cannot warn more than one year in advance of anything.
   1.111  
   1.112 +
   1.113 +
   1.114  .SH CREDITS
   1.115  
   1.116  This Program is heavily based on birthday. But without all non essential stuff. Nevertheless, much thanks for birthday, Andy!
   1.117  
   1.118 +
   1.119 +
   1.120  .SH AUTHOR
   1.121 -Andy Mortimer <andy.mortimer@zetnet.co.uk> and markus schnalke <meillo@marmaro.de>
   1.122 +markus schnalke <meillo@marmaro.de> and Andy Mortimer <andy.mortimer@zetnet.co.uk>