home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: InfoMgt / InfoMgt.zip / APPT.ZIP / APPT.DOC < prev    next >
Text File  |  1990-06-19  |  6KB  |  127 lines
  1.  
  2. NAME
  3.         appt - display an appointments calendar
  4.  
  5. SYNOPSIS
  6.         appt [weeks] [-weeksback] [-current or -all]  [source-file]
  7.  
  8. DESCRIPTION
  9.         Appt reads in the source file (APPT.DAT is the default), compiles
  10.         it into calendar form and displays a portion of the calendar on the
  11.         standard output.  If a positive number (greater than zero) is given
  12.         on the command line, that is taken to be the number of weeks of the
  13.         calendar to show (default is 2, unless the environment variable
  14.         APPTLENGTH is set, in which case its value is used instead as the
  15.         default calendar length, again in weeks).  A non-positive number
  16.         (less than or equal to zero) specifies the starting point of the
  17.         output in number of weeks from current (default is zero).  So the
  18.         command "appt cal -2 3" would print out three weeks worth of
  19.         appointments starting two week ago and going through the current
  20.         week (the displayed calendar always starts on a Sunday).  Note that
  21.         the order of the command arguments is arbitrary.
  22.  
  23.         An entry in the source file is of the form "month/day <time>
  24.         [repeat] ;message" or "daylist <time> [which] ;message" or simply
  25.         ";message".  The characters <,>,[,] and ; are part of the entry and
  26.         must be included (see examples below) if the time or a repeat
  27.         factor are desired.
  28.  
  29.         In the first case, month may be the numbers 1-12, the names
  30.         "january" - "december" (or nonambiguous abbreviations) or '*',
  31.         which means every month. Similarly, day may be the numbers 1-31,
  32.         '*', or '$', which means the last day of the month. Thus, '*/$'
  33.         means the last day of every month.  Time is in 24 hr time, and is
  34.         optional. Some sample times are '<15>', '<15-18>', 1:15-1:45am, and
  35.         3:15-3:45am.  Note that it is also possible to use <11am-1pm> and
  36.         <11Am-1:00pm> to specify 11:00am to 1:00pm. Repeat indicates to
  37.         repeat the message every n days in the listed months, where n is a
  38.         number optionally followed by a comma-separated list of months (see
  39.         examples below).  The months, if present, are given by name, not
  40.         number. The repeat field may be omitted. It is useful for payday,
  41.         as in "1/4 [14] Pay Day!!!", which says that every 14 days after
  42.         Jan 4 is a pay day. Message is any length message beginning with a
  43.         semicolon (the semicolon is not displayed on the printed calendar).
  44.         Any words longer than 10 letters will be truncated, however.
  45.  
  46.         The second form is of particular use for holidays.  A daylist is a
  47.         comma-separated list of days or '*' which means every day. A day is
  48.         any unambiguous representation of a day of the week (ambiguity is
  49.         shared between month names and week- day names). 'T' for example,
  50.         would be ambiguous, but month names.  Time is the same as above.
  51.         'Which' can specify which day of the month this message should be
  52.         shown.  For Thanksgiving, the 4th Thursday of Nov, the entry could
  53.         be "Th [nov,4] Thanksgiving" or "thur [fourth,no]".  The message
  54.         field is the same as above, also.
  55.  
  56.         By default, appointments which have expired (their ending time, if
  57.         given, has already passed) are not displayed.  You may override
  58.         this by one of two ways: define an evironment variable named
  59.         "APPTALL" set to anything, or specify the "- all" flag with the
  60.         command.  If you have "APPTALL" defined but for some reason do not
  61.         want old appointments shown, use the "-current" flag on the command
  62.         line.  If more than one "-all" or "-current" is given, the last one
  63.         specified is used.  A weeksback flag implies an "-all" flag (which
  64.         may be overridden by subsequent flags).
  65.  
  66.         An entry containing only a message (prefixed by a semicolon and
  67.         ended with a newline) is treated as a comment and is not dislayed.
  68.         Whitespace (spaces, tabs and newlines) is generally ignored by
  69.         appt, except in messages.
  70.  
  71.         Syntax errors are reported.  Semantic errors, like scheduling an
  72.         appointment for the 7th thursday in month 13, are also diagnosed.
  73.  
  74. EXAMPLES
  75.         Here is a short .appt file:
  76.  
  77.             ;******Birthdays*******
  78.  
  79.             10/28                   ;Adam's Birthday
  80.             7/1                     ;Rita's Birthday
  81.  
  82.             ;******Holidays********
  83.  
  84.             mon     [May,last]      ;Memorial Day
  85.             Sund    [May,2]         ;Mother's Day
  86.             july/4                  ;Fireworks
  87.             12/25                   ;Christmas
  88.             *       [last,june]     ;Vacation
  89.  
  90.             ;******Anniversaries****
  91.  
  92.             7/14                    ;Jim and Chris' Anniv.
  93.  
  94.             ;****** Business *******
  95.  
  96.             1/10 [14]               ;Pay day!!
  97.             1/17 [14]               ;Pay day w/P.S.!!
  98.             Wednesday <14>  [first] ;Meeting with group
  99.             Thursday [3,jun,dec]    ;Semi annual profit share check
  100.             3/7  <8-930>  [7,mar,april]  ;strategy meeting
  101.  
  102.             ;***** Miscellaneous ***
  103.  
  104.             */$                     ;Make house payment
  105.             */15                    ;House payment due!!!
  106.             */26                    ;Car payment
  107.             tuesday   <1930>        ;Recorder group practice
  108.             monday,wednesday,friday  <16-19>   [sept,oct,nov,dec]  ;AI class
  109.  
  110. FILES
  111.         APPT.DAT
  112.  
  113. DIAGNOSTICS
  114.         If it cannot find a file to read from it will complain.  Syntax
  115.         errors are diagnosed and zeros used to fill in missing quantities.
  116.         No guarantees on calendar accuracy if there are syntax or semantic
  117.         errors. In fact, there are no guarantees at all for this program.
  118.  
  119. AUTHOR
  120.         Jonathan W. Krueger
  121.         Ron Bemis - conversion to VAX/VMS
  122.         Ron Bemis - conversion to IBM PC
  123.         Ron Bemis - conversion to OS/2
  124.  
  125. BUGS
  126.         Are you kidding?  They're all FEATURES!
  127.