home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / zsys / znode-12 / s / z3help09.lbr / SALIAS.HZP / SALIAS.HLP
Encoding:
Text File  |  1993-06-12  |  8.9 KB  |  194 lines
  1. ;
  2.                                   SALIAS.COM                                  
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                9k (65)   F4CA  1.3        Rob Friefeld 2/89        Z3COM8
  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  80 columns by 6 lines.  Standout mode must 
  14. not use space on the screen.  WHEEL status is required.
  15. :1
  16.  
  17.    Syntax:  SALIAS [ [du: or dir:]aliasname[.COM] ]
  18.     
  19.    Everything  in [] is  optional.  SALIAS  always assumes  all files are type 
  20. COM.  The specified alias will be loaded  for editing,  or created if  it does
  21. not exist.  If no alias name is given on the command line,  it may be supplied 
  22. on exit.   If you try to edit a file which is not an alias, SALIAS will refuse
  23. to cooperate, rather than just give a warning.
  24.  
  25.    SALIAS uses  an internal alias template of the VALIAS1 type.  These aliases 
  26. may  be  optionally  Normal  or Recursive.   A  recursive  alias  flushes  the 
  27. remainder  of the command line when invoked,  giving a clean start each  time.
  28. (Note  that nothing can follow the alias name on the command line.)  Use these 
  29. to  loop through a sequence,  such as an edit-assemble cycle,  until  an  exit 
  30. condition is satisfied.
  31. :2
  32.  
  33. File Mode:
  34.  
  35.     A   ADD    <-- Add the script of another alias to the current script.
  36.     C    CLEAR  <-- Clear editor.  The alias is not changed.  (UNDO recovers)
  37.     E    EDIT   <-- Enter edit mode.
  38.     F    FORMAT <-- Redisplay edit buffer as it would be written to an alias.
  39.     I    INDENT <-- Format and redisplay with indentation of IF levels.
  40.     L    LOAD   <-- Load a file for editing.  The user is prompted for an
  41.            unambiguous file name (.COM type is assumed).
  42.     M    MODE   <-- Select Normal or Recursive mode (toggle).
  43.     N    NAME   <-- Select a new name (or just DU:) for the current edit.
  44.     P    PRINT  <-- Send the alias script to the list device.
  45.     S    SAVE   <-- Format and WRITE the alias to disk.
  46.     U    UNDO   <-- Reload edit buffer from memory image of alias.
  47. :3
  48. Edit Mode:
  49. ------------------------------------------------------------------------------
  50.  CURSOR:                                |   INSERTION:
  51.               ^R - top of screen        |      ^V - toggle insert/overwrite
  52.               ^E - line up              |    <CR> - insert line (insert mode)
  53.                                         |      ^N - insert line
  54.  ^S - char       ^       ^D - char      |   DELETION:
  55.  ^H - char    <  $  >                   |      ^G - delete char under cursor
  56.  ^A - word       v       ^F - word      |     DEL - delete char left
  57.                                         |      ^T - delete word right
  58.               ^X - line down            |      ^Y - delete line
  59.               ^C - first blank line     |     ^QY - delete to EOLN
  60.                                         |   FIND/REPLACE:
  61.  ^QS, ^QD - cursor to SOLN/ EOLN        |     ^QF - find string
  62.  ^J - EOLN, SOLN toggle (see below)     |     ^QA - find and replace string
  63.  TAB - insert a block of high bit marked|      ^L - repeat last find/replace
  64.     blanks.  Ignored on formatting.     |   CONTROL CHAR ENTRY:
  65. <ESC> - Exit to FILE mode               |    ^P^n - ^n is ctl char or letter
  66. ------------------------------------------------------------------------------
  67.  ^KN - Change Name   ^KR - Read (append) file.  ^KP - Print  ^KZ - Zap (clear) 
  68.  ^KD - Save & Clear  ^KS - Save & Resume  ^KX - Save & Quit  ^KQ - Quit
  69.  ^KF - Format        ^KI - Format & Indent IF's  ^KU - Undo  ^KM - Toggle Mode
  70. ------------------------------------------------------------------------------
  71. Sample Screen:
  72.  
  73. SALIAS 1.0       Mode: Normal        Free: 148         Alias Name: A15:START
  74. -------------------------------------------------------------------------------
  75. ROOT:
  76. LDR SYS.ENV,SYS.RCP,SYS.FCP,SYS.NDR
  77. PATH TOP ROOT
  78.  
  79.  
  80.  
  81.  
  82. ------------------------------------------------------------------------------
  83. <ESC> - FILE MENU                 -- EDITING --                      INSERT ON
  84.  
  85. Editing the alias START.COM with commands displayed one per line.  This is a
  86. normal rather than recursive alias.  There is room for another 148 characters
  87. in the command line buffer.  (The character count includes the ";" command
  88. separators although they are not shown.)  The editor is in "insert" rather
  89. than "overwrite" mode.  Pressing <ESC> key will show the single letter
  90. command options described for "File Mode".  (Another <ESC> returns to "Edit
  91. Mode" and repaints the screen.)
  92. :4
  93.  
  94. SALIAS Notes:
  95.  
  96.    a. With version 1.3,  the help screen reads  the current command  key  set.  
  97.       Any patches will automatically  be reflected.   SAINS13.COM installs new
  98.       command key set.
  99.  
  100.    b. Alias script  can be entered in upper or lower case.  Version 1.3 leaves
  101.       the script in lower case if entered that way.
  102.  
  103.    c. TAB  is intended for visual formatting, e.g. to indent IF levels.  There
  104.       are no tab stops.  Note that tabs are not counted in the "Free" display.
  105.       FORMAT strips tabs out.  Commands may start with real blanks.
  106.  
  107.    d. Control character entry  uses  the ^P trigger.  Lower case  letters  can 
  108.       also  be  deliberately  entered  this  way.  The  character  entered  is 
  109.       displayed in standout video mode.
  110.  
  111.       Example:  To enter ^P, use ^P^P (or ^PP).  To enter "a", ^Pa.
  112.       ^P@ (null) is not accepted because it is used as a string terminator.
  113.  
  114.  
  115. SALIAS Notes (cont'd):
  116.  
  117.    d. Find/Replace can be used to replicate a string.
  118.  
  119.       Example: < ^Q^A, <cr>, IF ~NU > sequence will put string "IF ~NU" at the
  120.       cursor.  Every ^L will produce another copy.
  121.  
  122.    e. ^J gets a help screen if running the help version of SALIAS.  Otherwise,
  123.       it is used as a convenient toggle to end-of-line/start-of-line.
  124.  
  125.    f. ^P+ at  the start  of  a line appends it  to the previous line without a 
  126.       command separator (";").  Use this to  build long single commands.  When 
  127.       SALIAS reads  a file  with long commands, it  automatically formats them 
  128.       this way.
  129.                  Example:  MCOPY WORK:=FILE1,FILE2,FILE3,FILE4
  130.                            +,FILE5,FILE6
  131.  
  132.          would load as...  MCOPY WORK:=FILE1,FILE2,FILE3,FILE4,FILE5,FILE6
  133.  
  134.  
  135. SALIAS Notes (cont'd):
  136.  
  137.    g. The display format  is  one command  per line.  When there  are  no more 
  138.       lines, the last line is filled.  If there are  still more commands, they 
  139.       will be lost.
  140.  
  141.    h. Commands longer than  the screen  width are indicated with  a ">" at the
  142.       apparent  end of the line.   The line  will scroll horizontally when the
  143.       cursor reaches the screen boundary.
  144.  
  145.    i. The "PRINT" function will send  the alias script to the printer or to  a
  146.       disk file (with type .TXT).   The latter can use separate lines for each
  147.       command (as in the screen display), or create a single command line.
  148.  
  149.  
  150. SALIAS Notes (cont'd):
  151.  
  152.    j. The following sequence  will "clone" SALIAS with new default modes.  (It
  153.       is distributed in insert mode, normal alias.)
  154.  
  155.       >SALIAS                ; call it up
  156.       ^V                ; toggle insert
  157.       ESC                ; exit edit mode
  158.       M                        ; toggle mode
  159.       X                        ; exit SALIAS
  160.       >SAVE 28 SALIAS10.COM    ; keep the change ... OR
  161.       >SAVE 32 SA10-HLP.COM    ; help screen version
  162. :5
  163. Error Messages:
  164.  
  165.    Messages which require no response will remain until any key is pressed.
  166.  
  167. CL OVERFLOW n CHARS    <-- The command line is too long by n characters.  
  168.                             SAVE aborted.
  169.  
  170. NOT AN ALIAS            <-- The specified file is not an alias at all.  
  171.                             If the file is the one being edited, a SAVE 
  172.                             will destory the original file.
  173.  
  174. ALIAS CHOPPED         <-- The alias file has too many commands to fit on the
  175.                             screen.  Could happen when using a smaller screen 
  176.                             or with an alias created with another program.
  177.  
  178. DESTINATION DISK FULL/ DIRECTORY FULL   <-- Unable to SAVE alias on full disk.
  179.                                             QUIT or RENAME to a new disk.
  180.  
  181. ... xxxx? (Y/n):  or ... xxxx? (y/N)     <-- The letter in caps is the default 
  182.                                             choice.  Any response other than
  183.                                             the alternate choice will do xxxx.
  184. :6
  185. Examples of Use:
  186.  
  187.    a. SALIAS            <-- Program comes up with blank alias.  On SAVE, a 
  188.                             filename is demanded.
  189.  
  190.    b. SALIAS ROOT:START <-- Edit the START.COM alias in the ROOT: directory.
  191.  
  192.    c. SALIAS A*         <-- On command line only, can load ambiguous file with 
  193.                             leading letter.
  194.