home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 1 / 1813 / pcal.hlp < prev    next >
Text File  |  1990-12-28  |  7KB  |  179 lines
  1. 1 PCAL
  2.         Pcal  generates  PostScript  to produce landscape or  portrait
  3.     orientated calendars for  any  month  and  year.  The defaults for
  4.     month and year are the current month and year.
  5.  
  6.         VMS Version
  7.         Execution format:
  8.     
  9.             pcal [options] [mm yy] [n]
  10.  
  11.         If a file named CALENDAR.DAT  resides  in  the  caller's  home
  12.     directory (or in a directory defined by the logical name PCAL_DIR,
  13.     if it exists), it will be  searched for  lines with  leading dates
  14.     matching the requested  month  and year (current by default).  Any
  15.     text following the date  will be printed on the calendar under the
  16.     appropriate day of the month.   Dates in the CALENDAR.DAT file may
  17.     consist  of  a  numeric or alpha  month  (at  least  the  first  3
  18.     characters  for  month  names)  followed  by  a  numeric  day  and
  19.     optionally  followed  by  a year.  Any non-numeric  character  may
  20.     separate numeric dates.  Holidays may be flagged by  following the
  21.     date immediately with '*';  this will cause the date to be printed
  22.     in gray.  Lines in the CALENDAR.DAT file consisting of "year xxxx"
  23.     (where  xxxx  is a numeric year) can be used to set the  year  for
  24.     following entries.  This assumes that the following entries do not
  25.     contain a year;  any date entries containing year information will
  26.     set  the  remembered  year  to  that  year.  Lines  consisting  of
  27.     "opt <options>" can be used to  override defaults for all command-
  28.     line flags except -e, -f, -D, and -U; any flags set in this manner
  29.     are themselves  overridden by  flags specified  explicitly  on the
  30.     command line.  Comments ('#' through  end-of-line) are  permitted.
  31.  
  32.     Example:
  33.  
  34.     # sample CALENDAR.DAT file - Raytheon holidays and exempt paydays, 1990
  35.  
  36.     opt -t Helvetica-Bold -d Helvetica-Bold    # override default fonts
  37.  
  38.     year 1990                # set default year
  39.  
  40.     7/4* Independence Day            # '*' flags 7/4 as holiday
  41.     7/12/90 Exempt payday            # full numeric date
  42.     Aug 16 Exempt payday            # alternate date format
  43.     9/3* Labor Day
  44.     9/20 Exempt payday
  45.     10/8* Columbus Day (observed)
  46.     10/25 Exempt payday
  47.     11/20 Exempt payday
  48.     11/22* Thanksgiving
  49.     11/23*
  50.     12/13 Exempt payday
  51.     12/24*
  52.     12/25* Christmas
  53.  
  54.     Release 2.1 of pcal adds rudimentary cpp-like functionality to the
  55.     date file, supporting define|undef, if{n}def ... {else ...} endif,
  56.     and include:
  57.  
  58.     define meetings
  59.  
  60.     ifdef meetings
  61.       include meetings.dat
  62.       undef meetings
  63.     endif
  64.     
  65.     Symbol names are case-insensitive.  It is  not an error to "undef"
  66.     an undefined symbol, nor to "define" a previously-defined one.
  67.  
  68.     "ifdef" alone is always false; "ifndef" alone is always true.
  69.  
  70.     The name of the file in the "include" directive may  optionally be
  71.     surrounded  by either "" or <>, both of which are ignored.  If the
  72.     name is not  an absolute  path, it is taken to be relative  to the
  73.     directory where the file containing the directive is located.
  74.  
  75.     Release 2.1 also  looks  for global  symbol PCAL_OPTS; if defined,
  76.     its contents are parsed as command-line flags.  These override the
  77.     program  defaults,  but are overridden  by any specified via "opt"
  78.     lines in  the date file or on the command line.  Example:
  79.  
  80.     $ define PCAL_OPTS "-n Helvetica -D meetings"      ! login.com
  81.  
  82.     $ pcal -"U" meetings 9 90    ! un-define symbol at runtime
  83.  
  84. 2 parameters
  85.   mm yy n
  86.         "mm" and "yy"  are numeric values of the month (1-12) and year
  87.     (0-99) (i.e., July 1990  would  be 7 90).  If you just include the
  88.     "yy" option, an entire 12  months  of calendars will be generated.
  89.     A specific month can be produced  by including the "mm" parameter.
  90.     The  "n"  parameter will  produce the "n"  consecutive  months  of
  91.     calendars starting with the requested month.
  92.  
  93.         The following flags  may be specified  (in increasing order of
  94.     precedence) in global symbol PCAL_OPTS, in "opt" lines in the date
  95.     file (all but -e, -f, -D, -U), or on the command  line.  Any  flag
  96.     which  normally  takes  an argument  may be specified  without the
  97.     argument;  this resets  its  value  to the  program  default.  (-D
  98.     alone thus clears all defined symbols; -U alone has no effect.)
  99.  
  100.     The '-' flag has  been added to  disambiguate  cases  where an
  101.     argument-less flag has been specified immediately before a numeric
  102.     parameter:
  103.  
  104.     $ pcal -t - 9 90
  105.  
  106. 2 -e
  107.         Print an  empty  calendar (i.e., do not  print entries  from a
  108.     CALENDAR.DAT file.)
  109.  
  110. 2 -f <FILE>
  111.         Directs pcal to use the  file name <FILE> as the input file in
  112.     place  of the  default  CALENDAR.DAT  file  in  the  callers  home
  113.     directory or in the  directory specified by logical name PCAL_DIR.
  114.  
  115. 2 -o <FILE>
  116.         Directs  pcal to  write  the  PostScript  calendar  into  FILE
  117.     (default: CALENDAR.PS in the current directory.)
  118.  
  119. 2 -l
  120.         This will cause the  output  to  come  out  in  landscape mode
  121.     (default).
  122.  
  123. 2 -p
  124.         This will cause  the  output  to  come  out  in  portrait mode
  125.     instead of landscape mode.
  126.  
  127. 2 -b <DAY> | all
  128.         This  will cause  all dates  on weekday  DAY to be  printed in 
  129.     black;  "-b all" causes  all dates  to be printed  in black unless
  130.     explicitly flagged as a holiday.
  131.  
  132. 2 -g <DAY> | all
  133.         This  will cause  all dates  on weekday  DAY to be  printed in 
  134.     gray; "-g all" causes all dates to be printed in gray.  Default is
  135.     to print Saturdays  and Sundays in gray and  other dates in black.
  136.  
  137. 2 -t <FONT>
  138.         This option can  be used to change the font  used to print the
  139.     title (i.e. $ pcal -t "Times-Roman").  The default  is Times-Bold.
  140.  
  141. 2 -d <FONT>
  142.         This option is the same as  -t  except  that  the font used to
  143.     print the  day  numbers is  changed.  The  default is  Times-Bold.
  144.  
  145. 2 -n <FONT>
  146.         This option is the same as  -n  except  that  the font used to
  147.     print the notes in the calendar boxes is  changed.  The default is
  148.     Helvetica-Narrow.
  149.  
  150. 2 -"L" <STRING>
  151.         This will cause  STRING to be  printed as  a left footer.
  152.  
  153. 2 -"C" <STRING>
  154.         This will cause STRING to be printed as a center footer.
  155.  
  156. 2 -"R" <STRING>
  157.         This will cause STRING to be printed as a right footer.
  158.  
  159. 2 -"D" <SYM>
  160.     This will  define symbol  SYM prior to  reading the date file;
  161.     -D alone clears all defined symbols.
  162.  
  163. 2 -"U" <SYM>
  164.     This will undefine symbol  SYM prior to reading the date file.
  165.  
  166. 2 CREDITS
  167.         The original PostScript code  to  generate  the  calendars was
  168.     written by Patrick Wood (Copywrite  (c)  1987  by  Patrick Wood of
  169.     Pipeline  Associates, Inc.), and authorized for  modification  and
  170.     redistribution.    The  CALENDAR.DAT  file  inclusion  code    was
  171.     originally written in "bs(1)" by Bill Vogel of  AT&T.    Patrick's
  172.     original  PostScript  was  modified  and enhanced several times by
  173.     others  whose names  have  regrettably been lost.  Ken Keirnan  of
  174.     Pacific Bell assembled the original "C" version upon which this is
  175.     based;  additional modifications and enhancements were the work of
  176.     Joseph P. Larson, Ed Hand, Andrew W. Rogers,  Mark Kantrowitz, Joe
  177.     Brownlee, and Eric  Hammond.  This  VMS  HELP file was  written by
  178.     Richard Dyson and updated by Andrew W. Rogers.
  179.