home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / UT / UT030.ZIP / ANARKEY3.ZIP / LOAD.DOC < prev    next >
Text File  |  1989-10-01  |  9KB  |  264 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                       LOAD
  10.                                The Anarkey Loader
  11.                                    User Manual
  12.  
  13.                                   Version 3.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                  Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                Introduction
  75.                                ------------
  76.  
  77.    LOAD will read the contents of an ASCII text file and store each line,
  78. unexecuted, into the ANARKEY history buffer.
  79.  
  80.    Although "regular" command lines are not executed before being stored,
  81. lines containing AKA definitions ARE processed as though they had been
  82. entered on the command line.  In other words, the AKA is defined.  UNIX
  83. switchar program names are also processed.  (The processing of an AKA or
  84. UNIX program definition can be suppress by specifying the -D option on the
  85. LOAD command line.  The -D option is explained later in this manual.)
  86.  
  87.    Once ANARKEY is installed, LOAD may be executed at any time and any
  88. number of times.  It will probably be useful to run LOAD immediately after
  89. installing ANARKEY to initialize your starting environment.  For example,
  90. you may define any AKAs and restore the contents of the history buffer from
  91. the previous computer session.  Later, a switch in tasks may warrant the use
  92. of a different set of AKAs.  LOAD can be run again to read and define these
  93. new definitions.
  94.   
  95.  
  96.  
  97.                              Loading a Disk File
  98.                              -------------------
  99.  
  100.    ANARKEY must already be installed in order for LOAD to store lines into
  101. its history buffer.  If ANARKEY is not installed, LOAD will display an error
  102. message and halt execution.
  103.  
  104.    NOTE: If invoked from a multiple-command input line or AKA, LOAD must be
  105. the very last command in the line.
  106.  
  107.    LOAD syntax is:
  108.  
  109.         LOAD [-options] filename [filename...]
  110.  
  111.    If you invoke LOAD with no arguments, a short usage message will be
  112. displayed.
  113.  
  114.    Normally, one or more file names will be specified on the LOAD command
  115. line.  Each file specification may contain the DOS wildcard characters '*'
  116. and '?'.  LOAD will perform the wildcard expansion and process each matching
  117. file in turn.
  118.  
  119.    Each file should contain standard ASCII text characters.  LOAD will read
  120. one line at a time from the file.  Blank lines and lines whose first word is
  121. "REM" are ignored.  Otherwise, the line is stored in the history buffer,
  122. unexecuted.  If there is not enough room in the buffer to store the line,
  123. lines are removed from the top of the buffer to make room.  (This operation
  124. is explained in detail in the "ANARKEY User Manual.")
  125.  
  126.    If the line is an AKA definition (specified by a colon in the first
  127. character position), it will be processed and added to the list of AKAs (or
  128. removed from the list if it is an un-define).  If there is not enough
  129. available AKA space to store the definition, LOAD will beep and display an
  130. error message.
  131.  
  132.    Likewise, a UNIX switchar program name (specified by a single or double
  133. exclamation point) will be processed.  Provided there is enough room to
  134. store the name in the UNIX buffer, it will be saved.  If there is not enough
  135. room, LOAD will beep and display an error message.  If the program name is
  136. to be removed from the buffer, LOAD will do so.
  137.  
  138.    Lines longer than 255 characters and lines containing individual commands
  139. longer than 127 characters will be rejected by LOAD.  An error message
  140. stating the nature of the problem will be displayed and the offending line
  141. will then be discarded.  LOAD will continue reading any remaining lines in
  142. the file.
  143.  
  144.    LOAD assumes that the multiple-commands-per-line feature is active in all
  145. processed lines unless the line contains a SET, PATH or PROMPT command.  If
  146. one of these commands is encountered, LOAD handles it in the same manner as
  147. ANARKEY does, i.e. the remainder of the line is considered a single command.
  148. LOAD also assumes that SET, PATH and PROMPT are not assigned to an AKA, for
  149. example:
  150.  
  151.                               :S      SET
  152.  
  153.  
  154.  
  155.                            Command-Line Options
  156.                            --------------------
  157.  
  158.    Options may appear anywhere on the command line.  Each must be
  159. immediately preceded by a dash (-) character.  Options may be in upper or
  160. lower case.  The supported options are detailed in the remainder of this
  161. section.
  162.  
  163.  
  164. Suppress Processing of AKA and UNIX Definitions
  165. -----------------------------------------------
  166.  
  167.         -D      -- Do Not Process AKA and UNIX Definitions
  168.  
  169.    The -D option instructs LOAD to not process any AKA or UNIX definitions
  170. it encounters in the loaded text file(s).  When -D is specified, AKA and
  171. UNIX definitions will not be stored in the AKA, UNIX or history buffers.
  172.  
  173.    This suppression is useful when loading files which may contain some AKA
  174. or UNIX definitions that were temporarily defined, but are no longer
  175. desirable.  Such instances may occur when loading a saved history-buffer log
  176. file.
  177.  
  178.  
  179. Calculating Required AKA and Switchar Space
  180. -------------------------------------------
  181.  
  182.         -M      -- Display AKA and Switchar Memory Requirements
  183.  
  184.    When -M is included on the command line, LOAD will read the contents of
  185. each specified file and accumulate the number of characters taken up by AKA
  186. and UNIX switchar definitions.  The file's contents are not loaded into the
  187. history buffer, nor are the AKA or switchar definitions processed.
  188.  
  189.    After all of the files have been scanned, LOAD will display the total
  190. amount of space the defined AKAs will require.  This value can then be used
  191. to allocate space for AKAs during ANARKEY installation (see the -A option in
  192. the "ANARKEY User Manual").
  193.  
  194.    If switchar definitions require memory, LOAD will display the total
  195. amount needed.  If there are no switchar definitions, no message will be
  196. displayed.
  197.  
  198.    LOAD does not keep track of AKAs or switchar programs that are defined
  199. more than once nor AKA un-definitions.  Any command read from the disk file
  200. that begins with the AKA definition character (colon, ':') or UNIX switchar
  201. character (single exclamation point, '!') is added to the accumulated total.
  202. Thus, if a disk file contained the following definitions:
  203.  
  204.                :define         rem This is an AKA definition
  205.                :define         rem A new substitution string
  206.                :define
  207.                !abc
  208.                !abc
  209.  
  210. LOAD would include the lengths of all five lines in its total, even though
  211. the net result will require no AKA space and only four switchar characters.
  212. (The above AKA definitions require no space because the second definition
  213. replaces the first one and the third "definition" undefines it completely,
  214. leaving nothing defined.)
  215.  
  216.    ANARKEY does not have to be installed to use LOAD with the -M option.
  217.  
  218.  
  219. Specifying the ANARKEY Process Number
  220. -------------------------------------
  221.  
  222.         -Pn     -- ANARKEY Process Number
  223.  
  224.    This option is identical to the -P option available on the ANARKEY
  225. installation line.  Please refer to the "ANARKEY User Manual" for details
  226. about when to use this option.
  227.  
  228.    The -P option will only be required in extremely rare instances.  If you
  229. installed ANARKEY without it, you will not need to use it for LOAD either.
  230.  
  231.  
  232. Suppressing Run-Time Messages
  233. -----------------------------
  234.  
  235.         -Q      -- Run in Quiet Mode
  236.  
  237.    When LOAD is running in quiet mode, informational messages, such as the
  238. name of the file being processed, are suppressed.  Error messages will still
  239. be displayed.
  240.  
  241.  
  242.  
  243.                            Comments and Suggestions
  244.                            ------------------------
  245.  
  246.    I would love to hear your suggestions, comments, and enhancement ideas
  247. concerning LOAD and the other programs in the ANARKEY software package.
  248. Please send your suggestions to:
  249.  
  250.                                 Steven Calwas
  251.                                Moderne Software
  252.                                 P.O. Box 3638
  253.                           Santa Clara, CA 95055-3638
  254.  
  255.                               _______
  256.                          ____|__     |               (tm)
  257.                       --|       |    |-------------------
  258.                         |   ____|__  |  Association of
  259.                         |  |       |_|  Shareware
  260.                         |__|   o   |    Professionals
  261.                       -----|   |   |---------------------
  262.                            |___|___|    MEMBER
  263.  
  264.