home *** CD-ROM | disk | FTP | other *** search
/ Boldly Go Collection / version40.iso / TS / 17A / CAL201.ZIP / CALV201.DOC < prev    next >
Text File  |  1991-10-10  |  15KB  |  411 lines

  1. ┌──────────────────────────────────────────────────────────────┐
  2. │  CAL.EXE -- Version 2.0 -- (C) 1991 New Day Software (NDS)   │
  3. └──────────────────────────────────────────────────────────────┘
  4. All Rights Reserved. Use of this program in a manner not granted
  5. by New Day Software is a violation of applicable copyright laws.
  6.  
  7.  
  8.      CAL is a best friend to those of us who have more things to
  9. do than we have fingers to tie string around.  Placed in your
  10. AUTOEXEC file, he will remind you of appointments, birthdays, tax
  11. time (ugh!) and other important dates.  You can have Cal give you
  12. your schedule at any time by simply typing CAL at the DOS prompt.
  13.  
  14.  
  15.                           FILE FORMAT:
  16.  
  17.      The file CAL.DAT is a free-format schedule file.  Each line
  18. makes up one entry.  An active entry is a line containing a
  19. sequence of characters that Cal recognizes as a date.  The format
  20. of these entrys follow.  They may be placed anywhere on the line,
  21. but the position may affect the way the line is treated. Please
  22. note that Cal only recognizes CAPITAL letters.
  23.  
  24.  
  25.      mm/dd/yy{+|-##}
  26.  
  27.      This format allows the user to set a range of dates for the
  28.      entry  to appear on.  The range is calculated from the base
  29.      mm/dd/yy and is RR days in length.  If the '+' option is
  30.      used, the range will begin on mm/dd/yy and will continue for
  31.      ## days following.  If the '-' option is used, then the
  32.      range will begin ## days prior to mm/dd/yy and will continue
  33.      until that date.  Each field must have exactly two digits,
  34.      (except for the range ## which may be any number of digits),
  35.      and may not contain spaces.
  36.  
  37.           10/31/90+61  Halloween, 1990 until New Years Day, 1991  
  38.           01/01/91-61  This is the same as the above entry.
  39.           12/09/??     This will show up on Dec 9 of every year
  40.           02/16/68-5   My Birthday! Send money.
  41.           1/2/89  + 100 Invalid Entry.
  42.  
  43.  
  44.      EACH
  45.  
  46.      The keyword EACH in all caps will cause the line to be
  47.      displayed  EACH time the program is executed.  If the word
  48.      occupies positions  1-4 of the line, the keyword will not be
  49.      displayed.
  50.  
  51.            This line will appear EACH day.
  52.            This line won't appear because 'each' is in lower case      mmm dd
  53.  
  54.      Using the three letter abbreviation of any month, in all
  55.      caps,  followed by the date will cause the entry to appear
  56.      each year on  that date.  The space is necessary, but a one
  57.      digit date field is  sufficient.
  58.  
  59.           NOV 23  This entry will show up on November 23
  60.           MAR 1   This entry will show up on March 1
  61.           APR14   This entry will not show up because there is no 
  62.                   space between APR and 14
  63.  
  64.  
  65.      www n
  66.  
  67.      The three letter abbreviation of any weekday immediately
  68.      followed  by a number from 1 to 5 causes that line to appear
  69.      on the n'th  weekday.
  70.  
  71.           WED 3    This will show up the 3rd Wed of each month   
  72.           FRI 5    This will show up the 5th Fri of each month 
  73.           FRI ?    This will show up on every Friday
  74.  
  75.  
  76.      DAY nn
  77.  
  78.      The keyword DAY followed by a number from 1..31 will cause 
  79.      the line to appear on the nn'th day of the month.  
  80.  
  81.           DAY 29 Run End-of-month backups.
  82.           DAY 1  Pay computer payment.
  83.  
  84.  
  85.      BEFORE and AFTER
  86.  
  87.      These keywords modify other date keywords.  Using BEFORE on
  88.      a line  causes that line to show up every day until the date
  89.      on that line.  Similarly, AFTER will wait until the date on
  90.      the line, and then  will display the line until it is
  91.      deleted from the file.
  92.  
  93.           BEFORE APRIL 15  Buy Mom's birthday present.
  94.           AFTER JAN 1   Get Tax stuff together
  95.  
  96.  
  97.  
  98.      RUN
  99.  
  100.      When CAL encounters the keyword RUN on a line with a valid
  101.      date or  keyword, the remainder of the line is passed to
  102.      COMMAND.COM for execution.  For instance, this command line
  103.      allows you to run weekly backups:
  104.  
  105.           FRI ? RUN BACKUP C: /f /s /l
  106.  
  107.      The RUN command is affected by the setting of the PROMPT FOR
  108.      RUN  PARAMETERS switch on the configuration screen. (See
  109.      CONFIGURING YOUR PROGRAM below for more information.)
  110.  
  111.  
  112.  
  113.      !
  114.  
  115.      The '!' symbol, when included as one of the LAST TWO
  116.      characters of  a line, causes the line to be displayed in
  117.      high video when the line  is displayed on the screen.  It
  118.      has no effect on printer output  when used with the PRINT
  119.      command line option.
  120.  
  121.      This will display EACH day in High Video!
  122.  
  123.  
  124.      $
  125.  
  126.      The Dollar character, placed as one of the last two
  127.      characters of a line marks the line as a 'Personal Item'.
  128.      These lines will not show  up on a normal execution of CAL. 
  129.      In order to view these entries, include your password,
  130.      entered in the configuration session, on the  command line
  131.      like so:
  132.  
  133.           CAL MyPassword
  134.  
  135.      This would cause the following line to appear:
  136.  
  137.           EACH    This is a personal entry.  $
  138.  
  139.  
  140.      ?
  141.  
  142.      The '?' character functions as a wildcard character much the
  143.      same way as it does in MS-DOS.  It replaces the field with
  144.      the current value for that field.  For instance, if the date
  145.      is 12 July 1991, then this date format will match:
  146.  
  147.           12/07/??  Dawn's Birthday!                       COMMAND LINE OPTIONS:
  148.  
  149.      HELP      Displays a quick reference Help Screen
  150.  
  151.      CONFIG    Rebuilds the configuration file with new
  152.                defaults
  153.  
  154.      EDIT      Allows you to edit the datafile by having Cal
  155.                invoke your favorite editor.  The default editor
  156.                is MS-DOS 5.0's EDIT command.
  157.  
  158.      LIST      Displays the line number before each line for use
  159.                with the HISTORY and DELETE commands.
  160.  
  161.      PRINT     Sends the output to the printer ( PRN: ).
  162.  
  163.      DELETE    Allows the deletion of lines from the datafile 
  164.      or DEL    without using the editor.  To use this option, get
  165.                a display with line numbers.  Use the LIST option
  166.                if necessary.  Then type:
  167.  
  168.                     CAL DELETE n1 n2 n3 n4 ... nx 
  169.  
  170.                Where n1 .. nx  are the numbers shown beside the
  171.                lines to be deleted.  WARNING!  If you use this
  172.                option and then decide to delete more lines, get a
  173.                NEW display of the line numbers.  The DELETE
  174.                command will re-sequence the datafile and the
  175.                lines you wish to delete may now have a different
  176.                location in the file, and therefore a different
  177.                number.  
  178.  
  179.      HISTORY   This option works the same as the DELETE, but 
  180.      or HIST   instead of deleting the lines, moves them to a
  181.                file named CAL.HIS in the CAL directory.  This
  182.                file will be appended to each time the HISTORY
  183.                command is used. The same syntax and warnings as
  184.                the DELETE command apply.
  185.  
  186.      PAST n    Shows all entries for today and for the past n
  187.      or LAST   days. Ranges will appear normally, but entries
  188.                such as FRI, DAYnn, etc. will not appear unless
  189.                they normally would.
  190.  
  191.      NEXT n    Works like PAST, but shows the next n days.
  192.      or FUTURE
  193.  
  194.      WITHIN    Combines PAST and NEXT and shows all entries for
  195.      or CIRCA  the current date +/- n days.
  196.  
  197.      USE fn    Sets the datafile to fn.CAL instead of the default
  198.                CAL.DAT.  This allows several people using the
  199.                same computer to have their own personal
  200.                datafiles.
  201.  
  202.  
  203.  
  204.  
  205.                     CONFIGURING YOUR PROGRAM:
  206.  
  207.      Several CAL settings may be changed by the command CAL
  208. CONFIG. These changes are stored directly in the .EXE file, so
  209. YOU SHOULD NEVER !EVER! RUN A COMPRESSION PROGRAM SUCH AS
  210. LZESHELL OR PKLITE ON CAL.EXE!
  211.  
  212. At the DOS prompt, type CAL CONFIG to get to the configuration
  213. screens. The following options are available:
  214.  
  215. A. NAME
  216.      Enter your first name (10 chars. max).  This will be
  217.      displayed on CAL's status bar.
  218.  
  219.  
  220. B. LOCATION OF DATAFILES
  221.  
  222.      Enter the name of the directory where you wish to store your 
  223.        datafiles.  Do NOT include the name CAL.DAT.
  224.  
  225.  
  226. C. EDITOR
  227.  
  228.      Enter the name of your text editor.  This can be any editor
  229.      that produces plain ASCII text and accepts a filename from
  230.      the command line.  If the editor is in a directory that is
  231.      in the DOS PATH, then the name alone is sufficient. 
  232.      Otherwise, include the pathname and extension.
  233.  
  234.  
  235. D. CHANGE PASSWORD
  236.  
  237.      Changes the password used to display personal entries and to
  238.      protect the EDIT and CONFIG modes of Cal.  The password is
  239.      not echoed to the screen, so you will be asked to enter the
  240.      password twice for verification.
  241.  
  242.  
  243. E. DISPLAY LINE NUMBERS
  244.  
  245.      When this is set to OFF, Cal functions normally.  If set to
  246.      ON, the line numbers will appear in the left column of the
  247.      screen by default and the LIST command will inhibit the
  248.      display of line numbers.
  249.  
  250.  
  251. F. CALENDARS IN TITLES
  252.  
  253.      When this field is set to ON, the calendars for the last,
  254.      current, and next months will appear in the title bar. 
  255.      Otherwise, the calendars are not displayed and only the
  256.      small status bar appears.
  257.  
  258.  
  259. G. PROTECT EDIT MODE
  260.  
  261.      When this field is set to ON, the user must enter the
  262.      password in order to enter edit mode.
  263.  
  264.  
  265. H. PROTECT CONFIG MODE
  266.  
  267.      When this field is set to ON, the user must enter the
  268.      password in order to enter the configuration mode.
  269.  
  270.  
  271. I. SOUND
  272.  
  273.      When this field is set to ON, the warning beeps and screen   
  274.      announcements are enabled.  Otherwise, Cal runs silently.
  275.  
  276.  
  277. J. DOUBLE SPACING
  278.  
  279.      When this field is set to ON, Cal will double space its
  280.      output.  Otherwise, Cal single spaces.
  281.  
  282.  
  283. K. COOKIE
  284.  
  285.      Cal has a database of almost 1000 one-liners, cliches, words
  286.      of wisdom, and other B.S.  When this field is set to ON, Cal
  287.      will pick one of these at random to be displayed after the
  288.      datafile is processed.
  289.  
  290. L. PAUSE AFTER xx LINES
  291.  
  292.      This field determines how many lines Cal will print before
  293.      pausing.  If for some reason you do not want Cal to pause,
  294.      simply enter a huge number here. M. DEFAULT PAST VALUE
  295.  
  296.      This field tells Cal how many days in the past to look by
  297.      default.  This may be overridden from the command line with
  298.      the PAST command.
  299.  
  300. N. DEFAULT NEXT VALUE
  301.  
  302.      This field tells Cal how many days in the future to look by
  303.      default.  This may be overridden from the command line with
  304.      the NEXT command.
  305.  
  306. O. PAUSE FOR RUN PARMS
  307.  
  308.      When this field is set to ON and a RUN command is
  309.      encountered in the datafile, Cal will pause and ask you for
  310.      parameters to pass to the program being called.  Otherwise,
  311.      Cal runs the program immediately.
  312.  
  313. P. MULTI-LINE ENTRYS
  314.  
  315.      When this field is set to ON, entries may consist of more
  316.      than one line.  The following specifications apply:
  317.  
  318.           I. The keyword or date MUST be on the first line of the
  319.           entry.     
  320.  
  321.           II. The end of an entry is marked by a blank line.
  322.  
  323.      When this field is set to OFF, entries are only one line in
  324.      length.  If a Multi-line entry exists in the datafile, only
  325.      the line with the date will appear.
  326.  
  327.  
  328. S. EXIT AND SAVE
  329.  
  330.      This command saves your changes in CAL.EXE and exits
  331.      configuration mode.
  332.  
  333.  
  334. Q. EXIT AND ABORT CHANGES
  335.  
  336.      This command exits configuration mode without saving any
  337.      changes.                         GETTING STARTED:
  338.  
  339. Getting started with Cal is simple.  Simply COPY CAL.EXE to a
  340. directory in your path.  When you run Cal for the first time, use
  341. the CONFIG option to install your name, the path for your
  342. datafiles, and the name of your editor.  Save the changes, and
  343. run Cal with the EDIT option. This should automatically create
  344. the datafile CAL.DAT in the directory you specified.  Type in
  345. your appointments using the date formats shown above.  Don't
  346. forget that Cal requires uppercase!  Save the file, and exit. 
  347. Cal will automatically run when you exit your editor.  The
  348. appointments you entered that match today's date should be
  349. displayed.
  350.  
  351.  
  352.                            LEGAL STUFF
  353.  
  354.  CAL.EXE, the documentation, and example datafile are copyrighted
  355. materials.  NO ONE except New Day software and it's
  356. representatives and programmers has the right to charge for Cal.
  357. Recognized User Groups and Computer Clubs have the right to
  358. recover an amount not to exceed $10.00 (U.S. Funds) for
  359. distribution disks.  Copies may be freely distributed so long as
  360. the files CAL20.DOC, CAL.EXE, and the demonstration CAL.DAT file
  361. remain intact.  ANY DISASSEMBLY OR OTHER FORMS OF REVERSE
  362. ENGINEERING PERFORMED ON THIS SOFTWARE IS STRICTLY PROHIBITED AND
  363. WILL BE CONSIDERED A VIOLATION OF THE RIGHTS OF NDS!
  364.  
  365.                            DISCLAIMER
  366.  
  367.  Although NDS tries to present you with high quality, bug free
  368. and virus free software, NEW DAY SOFTWARE MAKES NO WARRANTY OF
  369. ANY KIND. ANY DAMAGES ARISING FROM THE USE OF, OR INABILITY TO
  370. USE THIS SOFTWARE IS THE SOLE RESPONSIBILITY OF THE USER.  NDS
  371. PRESENTS THIS SOFTWARE ON AN "AS-IS" BASIS.  USE THIS SOFTWARE AT
  372. YOUR OWN RISK!
  373.  
  374.                    SO HOW MUCH IS IT ANYWAY??
  375.  
  376.  This section is for all of us users that flinch at the prices of
  377. some of today's "Shareware" that is priced at a "reasonable"
  378. $99.95. Cal is yours for the low, low price of $0.00.  That's
  379. right, true believers. Cal is marketed under the concept of
  380. FAIRWARE.  You are not obligated to pay NDS a cent for Cal, so
  381. you don't have to worry about your conscience bothering you
  382. because you didn't register.  However, if Cal makes your day
  383. easier, and saves you time, NDS would appreciate a contribution
  384. of whatever you feel that time is worth.  (We think that's fair.) 
  385. Contributions will greatly increase the chances of more FAIRWARE
  386. releases from NDS in the future.
  387.  
  388.      Those contributing $20.00 or more will be sent the next
  389. version of Cal.  Those contributing $50.00 or more will be sent
  390. the Turbo Pascal source code for Cal, along with the COMPILED
  391. version of several supporting TP55 Units with full documentation.
  392. Those contributing $100.00 or more will be not be sent anything
  393. above this, but will have the eternal gratitude of NDS. ;-)
  394.  
  395.      New Day Software reserves the right to charge for this, or
  396. any subsequent version of this software.
  397.  
  398.  
  399.                         TECHNICAL NOTES:
  400.  
  401. CAL VERSION 2.0
  402. (C) 1991 New Day Software
  403. All Rights Reserved
  404.  
  405. DEVELOPER:     TERRY L. LEWIS
  406. LANGUAGES:     BORLAND'S TURBO PASCAL VER. 5.5
  407.                TASM (TURBO ASSEMBLER VER. 1.01)
  408.  
  409. TURBO PASCAL and TASM are
  410. Registered Trademarks of Borland International, INC.
  411.