home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / deskaces / reminder.arc / REMINDER.MAN < prev    next >
Text File  |  1989-12-08  |  6KB  |  168 lines
  1. NAME
  2.     reminder - events reminder
  3.  
  4. SYNOPSIS
  5.     reminder [ options ] [file...]
  6.  
  7. DESCRIPTION
  8.     Reminder is a program to help mortals keep track of such
  9. mundane things as appointments, scheduled travel, etc.  When
  10. the program is invoked without file names, reminder attempts
  11. to read a file called DATES in the current directory.  If
  12. reminder is invoked with file names, these will be used as the
  13. data files.  The file DATES (or any other data file) must have
  14. a specified format.  Each line is composed of five fields.
  15. Each field is marked by a colon.  There are no colons at the
  16. beginning or end of the line, so there should be four colons
  17. per line.  If a line doesn't have the right number of colons,
  18. the program will print an error message and stop.
  19.  
  20.     The first field is the date or day of the event.
  21. It is of the form mm/dd, mm/dd/yy, dd or ddd where:
  22.  
  23. mm   are one or two digits representing the month (01 or 1 is
  24.      January, 2 is February, etc.).
  25.  
  26. dd   are the one or two digits representing the day of the month.
  27.  
  28. yy   are the number of years since 1900 (e.g. 85 for 1985 or 101
  29.      for 2001).
  30.  
  31. ddd  are the two or more characters representing the day of the week.
  32.      This could be any one of the following (all self-explanatory):
  33.      mon, tu, wed, th, friday, sat, or sun.  They may also
  34.      be in all upper case, as in FRI, or the first letter may be
  35.      upper case, as in Tue.  Anything after the first two
  36.      characters is ignored.
  37.  
  38.      If the year is omitted, reminder will issue a reminder every
  39.      year, as appropriate.  Similarly, if the month is omitted,
  40.      the reminder will be issued every month.  A "c" in the year
  41.      field indicates the current year, and an "n" indicates the
  42.      next year.
  43.  
  44. The next field states the number of days before the event that
  45. reminder will tell you of its occurrence, unless overridden by
  46. options on the command line.
  47.  
  48. The third field is the event itself.  This can be anything, e.g.
  49.  
  50.      Meeting with Mr. Smith,
  51.      0830 staff meeting, or
  52.      presentation.
  53.  
  54. The fourth (optional) field is the receptor of the event, e.g.
  55. Mr.  Jones.
  56.  
  57. The last field is the status field.  It allows you to note
  58. whether or not you want to be reminded of the event.  This is
  59. accomplished by two letters:
  60.  
  61. D    Do not report the occurrence of this event
  62.  
  63. N    Report the occurrence of this event
  64.  
  65. Any line lacking colons completely will be understood to mean
  66. a file name that reminder should read to get more data.
  67.  
  68. The following options are available:
  69. -i    Print each line of output exactly as it appears in the
  70.     input file.
  71.  
  72. -n    Print each line of output in the format:
  73.     "date event" or
  74.     "date receptor's event".
  75.  
  76. If neither -i nor -n is present, then the output format is:
  77.     "n days until event"
  78.     "n days until receptor's event"
  79.     "Today is event"
  80.  
  81. -bdate    Specifies beginning date of a range during which all
  82.     events will be printed.  Date is in the same format
  83.     as used for dates in the input file, as specified above.
  84.  
  85. -edate    Specifies end date of a range during which all events will
  86.     be printed.
  87.  
  88. -fn    Specifies beginning of a range of days from today
  89.     during which all events will be printed.
  90.  
  91. -tn    Specifies end of a range of days from today during
  92.     which all events will be printed.
  93.  
  94. -x    (eXplicit).  Print each line of output in the format:
  95. "yy.mm.dd (ddd) (nnn days) receptor's time event"
  96. The date is in a format suitable for piping to sort, and
  97. both the day of week and the date are given, regardless
  98. of the form in which the event was entered.
  99.  
  100. -p  Include all past events in the output
  101.  
  102. If neither -b nor -f nor -p is present, then events after today
  103. will be printed.  If neither -e nor -t is present, then the
  104. data in the second field of each input line will used to
  105. determine the end of the range of DATES to be checked.
  106.  
  107. FILES
  108.     DATES        current directory appointment book
  109.  
  110. EXAMPLES
  111.     With the following DATES file:
  112.  
  113.      01/13:4:Meeting with Mr. Smith:Mr. Jones:N
  114.      01/19:14:Meeting:Bruce:N
  115.      01/20:5:Equipment Demo:Alex:N
  116.      01/21:5:Conference:Staff Group:N
  117.      20:5:Monthly fire inspection due::D
  118.  
  119. The command:
  120.     reminder
  121.  
  122. would print the following on January 16:
  123.  
  124.     4 days before Mr. Jones's meeting with Mr. Smith
  125.     5 days before Bruce's Meeting
  126.  
  127. On the same date, the command:
  128.  
  129.     reminder  -n -b1/1/c -e3/31/c
  130.  
  131. would print all events occurring during the first quarter of the
  132. current year:
  133.  
  134.      01/13 Mr. Jones's Meeting with Mr. Smith
  135.      01/19 Bruce's Meeting
  136.      01/20 Alex's Equipment Demo
  137.      01/21 Staff Group's Conference
  138.  
  139. Hint: Reminder is most easily used by adding the single line:
  140.     REMINDER
  141. to the user's AUTOEXEC.BAT file, so it is automatically invoked
  142. every time the user powers up his computer.
  143.  
  144. DIAGNOSTICS
  145.     There are two errors that halt the program.  The first is
  146. if the line buffer exceeds its limit (256 characters).  The error
  147. message "Line Buffer format error" is printed.  The second is
  148. when the proper number of colons is confused.  The message will
  149. read "Line buffer division error".
  150.  
  151. BUGS
  152.     The DATES file must end with a newline reminder ignores the
  153. last line.  The "X" option in the Unix version of reminder, to
  154. automatically delete entries from the DATES file, is not
  155. implemented in the MSDOS version.  The user must manually delete
  156. entries using any text editor.  The feature in the Unix version
  157. to allow "quoting" a colon in an entry by using \: is not
  158. implemented in the MSDOS version.
  159.  
  160. SEE ALSO
  161.     REMIND.MAN, EVENT.MAN
  162.  
  163. AUTHOR G. E. Toth wrote original program.
  164.        Glenn Randers-Pehrson added various enhancements.
  165.        Kenneth Van Camp adapted it for MSDOS (under Turbo C).
  166.        Richard J. Reiner <rreiner@vm1.yorku.ca> or
  167.        <grad3077@writer.yorku.ca> added -x and -p (under
  168.        Microsoft C)