home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / s.lbr / SALIAS.HZP / SALIAS.HLP
Encoding:
Text File  |  1991-11-18  |  11.5 KB  |  235 lines

  1. ;
  2.                                   SALIAS.COM                                  
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                8k (62)   0493  1.50       Rob Friefeld 11/90       Z3COM19
  6.  
  7.   1- Syntax  2- File Mode  3- Edit Mode  4- Notes  5- Err Msgs  6- Examples   
  8.  
  9.  
  10.  
  11.    SALIAS creates and modifies alias files with the convenience of full screen
  12. editing.  It requires  TCAP support for CLS, EREOL, and an addressable cursor.
  13. The user's CRT must have  at least  79 columns by 6 lines.  Standout mode must
  14. not use space on the screen.   The help  screen  will not appear if the screen
  15. has less than 24 lines.  WHEEL status is required.
  16.  
  17.    Be sure to see ALIAS.HLP for information on using the alias itself.
  18. :1
  19.  
  20.     Syntax   SALIAS [[du: or dir:]aliasname[.COM] ]
  21.     
  22.    Everything  in [] is  optional.  SALIAS  always assumes  all files are type 
  23. COM.  The specified alias will be loaded  for editing,  or created if  it does
  24. not exist.  If no alias name is given on the command line,  it may be supplied 
  25. on exit.   If you try to edit a file which is not an alias, SALIAS will refuse
  26. to cooperate, rather than just give a warning.
  27.  
  28.    SALIAS uses an  internal  alias  template  of the  ALIAS15  type,  recently
  29. written by Joe Wright.   You can link  SALIAS15.REL with  new alias modules as
  30. they are developed.   One important side effect:   On exiting SALIAS,  GO will
  31. now execute the alias just written rather than rerunning  SALIAS as  you might
  32. expect. 
  33.  Usage - 1/2 
  34.  
  35.    Aliases may be optionally Normal or Recursive.   A recursive  alias flushes
  36. the remainder of the command line  when invoked,  giving a  clean  start  each
  37. time.  (Note that nothing can follow the alias name on the command line.)  Use
  38. these to loop through  a sequence,  such as  an  edit-assemble cycle, until an
  39. exit condition is satisfied.
  40.  
  41.    TAB is intended for visual  indentation  of IF levels.   TAB  looks  like 3
  42. blanks,  but is not actually  added to the script.   A  command line may start
  43. with a REAL blank in  order to invoke the  extended command processor.   Auto-
  44. matic indentation gives the script a Pascal-like appearance.
  45.  
  46.    Command lines longer than the screen width are indicated  with a ">" at the
  47. right margin.   The line will scroll horizontally  when the cursor reaches the
  48. screen boundary.   If you prefer, ^P+ at the start of a line appends it to the
  49. previous line without  a command separator (";").   This option is awkward but
  50. keeps the entire script visible.
  51.  Usage - 2/2 
  52.  
  53.    The "PRINT" function will send the alias script to the printer or to a disk
  54. file (with type .TXT).  The disk file option has two choices of format:
  55.  
  56.     1.  Separate line for each command, like the screen  display.  
  57.         Intended for extracting script to paste into a text file.
  58.     2.  Single multiple  command line.  For importing the  script 
  59.         to an ARUNZ CMD file.
  60.  
  61.    Find/Replace can be used to replicate a string.
  62.  
  63.         Example:   <^Q^A>  <cr> <IF ~NU > will put "IF  ~NU"  at  the 
  64.                    cursor.  Every ^L will produce another copy.
  65.  
  66.    Control character entry uses the  ^P  trigger.   The  character  entered is
  67. displayed in standout video mode.   Controls may be used for printer or screen
  68. control.   Note that the  ^P  BDOS printer toggle does NOT work from within an
  69. alias script.   ^P only works when the DOS has directly taken a line of string
  70. input. 
  71.         Example:  To enter ^Z, use ^P^Z (or ^PZ)
  72.                   ^P@ (null) is not accepted.
  73.  Using SALIAS15.REL - 1/2 
  74.  
  75.    SALIAS 1.5 is  distributed in  M-REL format so that it can easily be linked 
  76. with new or experimental alias modules (and with new system library versions).
  77. The alias actually written to disk makes up the first few records of the prog-
  78. ram.  In this case, it is Joe Wright's alias module from ALIAS 1.5.
  79.  
  80.             SLRNKP SALIAS/N,/A:100/J,ALIAS0,SALIAS,/E
  81.                                or
  82.                      ZML SALIAS=ALIAS0,SALIAS
  83.                                or
  84.                   LINK SALIAS=ALIAS0,SALIAS[NR]
  85.  
  86.    SALIAS contains a .REQUEST op for VLIB,Z3LIB,SYSLIB.
  87.  
  88.    By tradition,  the alias module is  expected to  be 8  records in length or
  89. less.   SALIAS and its installation program require only that the alias module
  90. end on a  record  boundary and  be  no  more  than a few kbytes in size.   The
  91. current ALIAS0 is 7 records, so SALIAS proper begins at 480H.
  92.  Using SALIAS15.REL - 2/2 
  93.  
  94.    SAINST.COM reads the entire SALIAS program, looks for a signature string at
  95. SALIAS's installation table,  then writes back your changes to that particular
  96. record.  In other words, the alias module can change size and the installation
  97. program still works on the SALIAS you generate.   Unfortunately,  M-REL  files
  98. cannot be installed directly.
  99.  
  100.    Any alias experimentation should be  based on ALIAS0.   SALIAS  expects the
  101. general structure and public declarations you will find in this module.
  102.  
  103.    Thanks to  Joe Wright for permission  to  combine his interesting new alias
  104. with the SALIAS editor.
  105. :2
  106.  File Mode 
  107.  
  108.    The alias script is  displayed on screen  with  a  function  menu along the
  109. bottom listing single  letter  commands  which control file maintenance.   The
  110. script is  actually  edited in  Edit  Mode,  described  below.   File  Mode is
  111. intended as an aid to infrequent users.
  112.  
  113.     A   ADD    <-- Add the script of another alias to the current script.
  114.     C    CLEAR  <-- Clear editor.  The alias is not changed.  (UNDO recovers)
  115.     E    EDIT   <-- Enter full-screen editor.
  116.     F    FORMAT <-- Reformat the script, one command per line.
  117.     I    INDENT <-- Format and indent by IF level.
  118.     L    LOAD   <-- Clear script and load an alias for editng.
  119.     M    MODE   <-- Select Normal or Recursive mode (toggle).
  120.     N    NAME   <-- Select a new name (or DIR:) for the script.
  121.     P    PRINT  <-- Send the script to printer or to a text file.
  122.     S    SAVE   <-- Format and WRITE the alias to disk.
  123.     U    UNDO   <-- Cancel unsaved changes to script.
  124. :3
  125.  Edit Mode 
  126. ------------------------------------------------------------------------------
  127.  CURSOR:                                |   INSERTION:
  128.               ^R - top of screen        |      ^V - toggle insert/overwrite
  129.               ^E - line up              |    <CR> - insert line               
  130.                                         |      ^N - insert line
  131.  ^S - char       ^       ^D - char      |   DELETION:
  132.               <  $  >                   |      ^G - delete char at cursor   
  133.  ^A - word       v       ^F - word      |     DEL - delete char left
  134.                                         |      ^T - delete word right
  135.               ^X - line down            |      ^Y - delete line
  136.               ^C - first blank line     |     ^QY - delete to EOLN
  137.                                         |   FIND/REPLACE:
  138.                                         |     ^QF - find string
  139.  ^QS, ^QD - SOLN, EOLN                  |     ^QA - find/replace string
  140.  ^QZ - Clear (Zap) script               |      ^L - repeat find/replace
  141.  TAB - Indent line                      |   CONTROL CHAR ENTRY:
  142.  <ESC> - File mode   ^J - Help          |    ^P^n - ^n is ctl char          
  143. ------------------------------------------------------------------------------
  144.  ^KN - Change Name   ^KR - Read (append) file.  ^KP - Print  ^KZ - Zap (clear) 
  145.  ^KD - Save & Clear  ^KS - Save & Resume  ^KX - Save & Quit  ^KQ - Quit
  146.  ^KF - Format        ^KI - Indent by IF level    ^KU - Undo  ^KM - Toggle Mode
  147. ------------------------------------------------------------------------------
  148. Sample Screen:
  149.  
  150. SALIAS 1.0       Mode: Normal        Free: 148         Alias Name: A15:START
  151. -------------------------------------------------------------------------------
  152. ROOT:
  153. LDR SYS.ENV,SYS.RCP,SYS.FCP,SYS.NDR
  154. PATH TOP ROOT
  155.  
  156.  
  157.  
  158.  
  159. ------------------------------------------------------------------------------
  160. <ESC> - FILE MENU                 -- EDITING --                      INSERT ON
  161.  
  162. Editing the alias START.COM with commands displayed one per line.   This  is a
  163. normal rather than recursive alias.   There is room for another 148 characters
  164. in the command line buffer.   (The  character count includes  the  ";" command
  165. separators although they are not shown.)   The  editor is in  "insert"  rather
  166. than "overwrite"  mode.   Pressing  <ESC> key  will  show  the  single  letter
  167. command options described for "File Mode".   (Another  <ESC> returns  to "Edit
  168. Mode" and repaints the screen.)
  169. :4
  170.  SALIAS Notes - 1/2 
  171.  
  172.    a. Vs. 1.5 updates (11/9/90, Rob Friefeld):
  173.       - Uses new alias  template  by Joe Wright.   It has some  bug  fixes and
  174.         implements some new features.  
  175.       - Fixes bug in find/replace.  It started just after the cursor position,
  176.         so it couldn't replace the current token.
  177.       - Fixes bug in install program which gave prompt to "Save Changes?" when
  178.         there were none.
  179.       - Experiments with the alias  module are likely to continue.   An  M-REL
  180.         version of SALIAS is included  which can  be  linked  with  new  alias
  181.         modules as they appear.
  182.       - Fixes bug in PRINT routine.  Not sure when it appeared.
  183.  
  184.    b. Vs. 1.4b updates (4/30/90, Rob Friefeld):
  185.       - Improved control key encoding scheme.   You can now assign the editing 
  186.         keys to single control keys or to any one of 3 lead-in keys.  There is
  187.         no need for "sub-menus".
  188.       - SALIAS will now accept  a 79 character screen line setting in your ENV
  189.         descriptor.   Although it only used 78 chars, it tested for an 80 char
  190.         screen width.
  191.  SALIAS Notes - 2/2 
  192.  
  193.       - Replace command now has a global option.
  194.       - Fix to help-screen display when using "SALIAS //".
  195.  
  196.    c. Vs. 1.3 updates 
  197.      - Help screen reads the current command key set.   Any patches will auto-
  198.        matically be reflected.   
  199.      - SAINS13.COM installs new command key set.
  200.      - Alias script can be entered in upper or lower case.  Version 1.3 leaves
  201.        the script in lower case if entered that way.
  202. :5
  203.  Error Messages 
  204.  
  205.    Messages which require no response go away when any key is pressed.
  206.  
  207. CL OVERFLOW n CHARS    <-- The command line is too long by n characters.   If
  208.   SAVE ANYWAY?:             SAVE is not aborted, the alias probably won't run.
  209.                             If you have used  script  parameters  such  as  $U 
  210.                             which will require  fewer  characters when "expan-
  211.                             ded", you can choose to over-ride this reminder.
  212.  
  213. NOT AN ALIAS            <-- The specified file is not  an alias  at all.   The
  214.                             name is ignored and replaced with a blank.
  215.  
  216. ALIAS CHOPPED         <-- The alias file has too many commands to fit on the
  217.                             screen.   Could happen when using a smaller screen 
  218.                             or with an alias created with another program.
  219.  
  220. DESTINATION DISK FULL/  <-- Unable to SAVE alias on full disk.  QUIT or RENAME
  221.  DIRECTORY FULL             to a new disk.
  222.  
  223. ... xxxx? (Y/n):        <-- The letter in caps is the default choice.   A <cr>
  224. ... xxxx? (y/N)             selects it.
  225. :6
  226.  Examples of Use 
  227.  
  228.    a. SALIAS            <-- Program comes up with blank alias.  On SAVE, a 
  229.                             filename is demanded.
  230.  
  231.    b. SALIAS ROOT:START <-- Edit the START.COM alias in the ROOT: directory.
  232.  
  233.    c. SALIAS A*         <-- On command line only, can load ambiguous file with 
  234.                             leading letter.
  235.