  
  
                                                              15 MAY 81
  
  
                     EE Text Editor Reference Guide
  
  
      This  Editor  allows  the user to modify program source files and
 data files from a VAX terminal. 
  
  
 Starting_the_Editor___________________
  
         The Text Editor can be started by typing the command:  EE from
    VAX command mode.  The full form of the command is: 
  
      EE [file-spec [-NEW]][-I:file][-C:cmds] | -F | -H {'SaveFile'}
  
         This command edits the file(s) specified by  "file-spec",  and
    remembers the  name  of  the  last  file edited.  If "file-spec" is
    omitted, the remembered file will be edited.  The version number of
    the edited file is not remembered.  If the file type is  not  given
    in  "file-spec",  the  Editor  will  try to guess the type from the
    following list, in this order: 
  
            .FLX  .FOR  .COM  .TEX  .MAC  .DAT  .  .LIS  .DEF  .I
  
         If "file-spec" will be a new file, the  parameter  "-NEW"  (or
    "-N")  must  also  be  specified;  otherwise, the Editor will stop.
    Multiple files can be edited since "file-spec" may be a single file
    name  or  several  file  names  separated  by  commas  (wild   card
    characters are also allowed).  Editing is performed on each file in
    succession by typing "RET". 
  
         Other editing options are: 
  
      -INPUT   - (or "-I:file") Read editor input from "file".
      -COMMAND - (or "-C:cmds") Execute "cmds" at the start of edit.
  
         The  parameter  "-F" returns the format of the EE command, and
    "-H" displays help for the command (Note that the  brackets  denote
    an optional parameter, braces ({}) designate a default value for an
    omitted parameter, and the vertical-bar symbol (|) means "or".). 
  
         When the Editor starts, it displays the first line of the edit
    file and  prompts  for commands with ">".  Typing "Q" will quit the
    edit and return to VAX command mode. 
  
  
 Running_the_Editor__________________
  
         The Text Editor is operated  through  a  set  of  English-like
    commands.   The  format  of  these  commands  is  described  in the
    following paragraphs. 
  
    Command Line
  
       An Editor command consists of a  main  verb  or  "command  name"
       followed  by  various  options called "parameters", which may be
       separated by spaces and/or the  Separator  character  (refer  to
       "Metacharacters").  Multiple commands can be entered on one line
       if the command Delimiter character is used between them. 
  
 EE Text Editor                                           Running EE  1
  
  
  
       The command name may be up to 8 characters in length and contain
       any  character  except the digits 0-9, +, -, ., /, the parameter
       Separator, the command Delimiter, and the Null-number character. 
  
    Command Parameters
  
       Command parameters are of the following general types: 
  
        Numeric - consists of +, -, ., 0-9, or the Null-number character
        Word    - any characters except blank, Numeric & Metacharacters
        File    - a VAX file specification (no blanks or Metacharacters)
        String  - contains any character except the command Delimiter
        Quoted  - offset with "quote" characters; may contain Metacharacters
  
       Because of the unique composition of  Numeric,  Word,  and  File
       parameters,  they  may  be  intermixed  on a command line in any
       order without confusion. 
  
    Meta-Characters
  
       The following characters  are  Meta-characters  for  the  Editor
       command language: 
  
          SEPAR - parameter separator character
          DELIM - command delimiter character (separates commands)
          NULL  - null-number character (gives a null value for a number)
  
       These characters can be altered by the "Alter" command. 
  
         Changes  to  files  can  be  made  interactively  by  entering
    commands to the Editor through a  terminal.    However,  batch-mode
    updates  can be made by having the Editor read commands from a disk
    file. 
  
         The Editor commands can be divided into  the  following  major
    categories:    Text-Editing   Commands  and  Meta-Language  Editing
    Commands (commands which deal with the  command  language  itself).
    These commands are explained in the following sections. 
  
  
 Text_Editing_Commands_____________________
  
         The following commands are used to modify the edit file. 
  
  
                         **  Text Editing Commands  **
       
       GET - Get Edit File from Library       MOV - Move Lines
       PUT - Put Edited File into Library     J   - Join from Next Line
       MER - Merge File from Library          A   - Add String to Line
       P   - Print Line                       C   - Change String
       T   - Move to Line# or Top             O   - Overlay String
       N   - Move to Next Line                R   - Replace Line
       U   - Move Up to Line                  TR  - Translate Characters
       BOT - Move to Bottom Line              RES - Restore Line
       L   - Locate String                    SET - Set Switch
       F   - Find String                      SHOW- Show Status
       I   - Insert Line                      INF - Information
       D   - Delete Lines                     H   - Help
       COP - Copy Lines                       Q   - Quit Edit
  
  
 EE Text Editor                                Text Editing Commands  2
  
  
  
 ----------------------------------------------------------------------
 Add String:  A [within-col# {end-of-line}] string
 ----------------------------------------------------------------------
    Adds  the  specified  character  string  after  the  last non-blank
    character of the current line.  The parameter "within-col#" may  be
    specified to add the string to the end of the text within the given
    column number. 
  
 ----------------------------------------------------------------------
 Move to Bottom Line:  BOT
 ----------------------------------------------------------------------
    Sets  the  current  line  pointer  to  the  bottom line in the text
    buffer. 
  
 ----------------------------------------------------------------------
 Change String:  C
   [col#[end#]] /string1/string2 [/[GLOBAL][DEL][VER][#lines[#subs]]]
   (MATCH patterns -  :L=locate  :C=change  ::=ellipsis  :#=auto#)
 ----------------------------------------------------------------------
    changes the first occurrence of the character string  "string1"  to
    "string2" in  "#lines" lines, beginning with the current line.  The
    strings must be delimited by slashes or some  other  character  not
    occurring in  the  strings  themselves.    If  the  second slash is
    omitted, "string2" is assumed to be null, and if the third slash is
    omitted, "string2" is assumed  to  extend  to  the  last  non-blank
    character in  the  command  line.  The third slash must be given if
    options are specified. 
  
    The search for "string1" begins in column 1 of the line and ends at
    the line length, unless the  range  of  column  numbers  "col#"  to
    "end#" is  specified.    If "end#" is omitted, the remainder of the
    line is searched.  Each line changed is printed unless  the  VERIFY
    switch is set to "NO" or the "V" option is used. 
  
    The  "Change-String" command has the following options which may be
    entered in any order: 
  
    GLOBAL - (or "G") (meaning global within  each  line)  applies  the
          change  to  all  occurrences of "string1" in as many lines as
          specified by "#lines". 
    DELETE - (or "D") deletes the remainder of a line  after  the  last
          change on the line. 
    VERIFY - (or "V") alters the setting of the VERIFY switch (refer to
          the "Alter" command) for the duration of the command. 
    #lines [#subs] - requests "#subs" substitutions in each of the next
          "#lines" lines; defaults to 1 for 1 line only. 
  
    MATCH Patterns
  
    The     "Change-String"    command    recognizes    some    special
    character-matching patterns in  "string1"  and  "string2".    These
    patterns  each  consist  of  two  characters - the MATCH character,
    initially a colon (:), and a pattern name character.  Pattern  name
    characters may be given in either upper or lower case: 
  
    L - (pattern ":L") is replaced by the "locate" string, that is, the
         last  string  given  on  a  "Locate-String"  or  "Find-String"
         command. 
    C - (pattern ":C")  is  replaced  in  "string1"  by  the  value  of
         "string1" given  in  the  last  "Change-String"  command.   In
         "string2", it is replaced by the current value of "string1". 
  
 EE Text Editor                                Text Editing Commands  3
  
  
  
    MATCH  -  (pattern  "::")  The  MATCH  character  appearing   twice
         indicates ellipsis.    This will match zero or more characters
         between other characters given in "string1".  Ellipsis is  not
         recognized in "string2". 
    #  -  (pattern  ":#")  is replaced by the current value of the AUTO
         number (refer to the  "Set-Switch"  command),  which  is  then
         incremented for each occurrence of the pattern. 
  
    Patterns are  matched  in a line of text from left to right.  For a
    GLOBAL change, patterns in  "string1"  are  substituted  only  once
    (except   for   ellipsis),   whereas   patterns  in  "string2"  are
    substituted for each occurrence of "string1" found. 
  
    MATCH-pattern substitution can be modified  or  disabled  with  the
    "Set-Switch" command. 
  
 ----------------------------------------------------------------------
 Copy Line(s):  COP [begin-line# [end#] {current-line}]
 ----------------------------------------------------------------------
    Copies the range of lines specified by "begin-line#" through "end#"
    after the  current  line.    If  "end#"  is omitted, only 1 line is
    copied.  If both line numbers are  omitted,  the  current  line  is
    copied. 
  
    The  "begin-line#"  may  be  signed + or -, relative to the current
    line, and "end#", relative to "begin-line#". 
  
 ----------------------------------------------------------------------
 Delete Line(s):  D [#lines {1} | begin-line#[end#] NUM]
 ----------------------------------------------------------------------
    This command has two forms.  The first  form  deletes  a  total  of
    "#lines" lines, beginning with the current line. 
  
    The  second  form  (using  the  parameter "NUM" or "N") deletes the
    range of lines specified by "begin-line#" through "end#"  from  the
    file.  If  "end#"  is  omitted,  only  1  line  is  deleted.    The
    "begin-line#" may be signed + or -, relative to the  current  line,
    and "end#", relative to "begin-line#". 
  
    The  first  line  after the deleted line(s) becomes the new current
    line.  If all lines to the bottom of  the  file  are  deleted,  the
    message  "BOTTOM"  is  printed,  and the current line is set to the
    bottom line. 
  
 ----------------------------------------------------------------------
 Find String:  F [col# {find-col}] [string {previous}]
 ----------------------------------------------------------------------
    finds the next line with "string" in the specified  column  "col#",
    beginning with the next line after the current line. 
  
    If   "string"   is   omitted,   the  string  entered  on  the  last
    "Find-String" or "Locate-String" command is used again. 
  
    If "col#" is  omitted,  the  "find-col"  column  of  each  line  is
    searched.   The  value of "find-col" can be set by the "Set-Switch"
    command.  "Col#" may be entered as + or -, relative to the value of
    "find-col". 
  
    The message "BOTTOM" is printed if the string is not found, and the
    current line is set to the bottom line of the file. 
  
  
 EE Text Editor                                Text Editing Commands  4
  
  
  
 ----------------------------------------------------------------------
 Get File to Edit:  GET [file-spec | filnum #] {edit-file}
 ----------------------------------------------------------------------
    If no parameters are specified, this command gets the last  version
    of  the  edited  file,  replacing the current edit file in the text
    buffer. 
  
    The parameter "file-spec" may be used to get a  different  file  to
    edit.  The "file-spec" then becomes the default edit file. 
  
    A  different  edit file can also be selected by the number "filnum"
    which refers to the position number of a file specification  stored
    in  the  list  of  remembered  files displayed by the "Show-Status"
    command.  The "filnum" may be  signed  +  or  -,  relative  to  the
    position of the current edit file specification in the list. 
  
    If  the  current  edit  file has been modified, but it has not been
    saved in its entirety with a "Put-Edited-File" command, the user is
    warned before the current file is erased. 
  
 ----------------------------------------------------------------------
 Help:  H
   [user-cmd | internal-cmd | macro-name | begin-macro# [end#]]
 ----------------------------------------------------------------------
    If a command name is  specified,  the  help  command  displays  the
    function and parameter format for the given command. 
  
    The  help  command can also be used to show the contents of command
    macros, specified either by macro name  or  by  a  range  of  macro
    numbers.  For specifying macro numbers, "begin-macro#" may be given
    as a negative number relative to the number of the last macro.  The
    "end#" may be given relative to the "begin-macro#". 
  
    Up to eight names are allowed on one help command. 
  
 ----------------------------------------------------------------------
 Information:  INF [topic-prefix-list] [#levels {2} [pagelen {22}]]
 ----------------------------------------------------------------------
    This  command  lists  information for the topics that match "topic-
    prefix-list", which may specify any type of topic grouping such  as
    "COMMAND", "STRING",  "COM  ERR",  or  "META  COM  DESCRIP".  If no
    prefix is given, all topics will be listed. 
  
         Information is displayed a page at a time.  At the end of each
    page typed, the user is prompted with ":".  Valid responses are: 
  
         / - Skip past next page        = - Show current line number
         Q - Quit     ? - Show topic names requested      H - Give help
         Any other response will continue with the next page.
  
    The following list explains the command options: 
  
       #levels  - print "#levels" sub-levels of information; default is 2
       pagelen  - set page length to "pagelen" lines; default is 22
  
 ----------------------------------------------------------------------
 Insert Line:  I [at-col# {insert-col}] string
 ----------------------------------------------------------------------
    inserts a new line with "string" beginning in the specified column. 
  
    If "at-col#" is omitted, the line will begin  in  the  "insert-col"
  
 EE Text Editor                                Text Editing Commands  5
  
  
  
    column.   The  value of "insert-col" can be set by the "Set-Switch"
    command.  "At-col#" may be entered as + or -, relative to the value
    of "insert-col". 
  
 ----------------------------------------------------------------------
 Join from Next Line:  J [to-column#]
 ----------------------------------------------------------------------
    Joins the text from the next line to one space after the end of the
    current line.  The parameter "to-column#" may be specified to  join
    the text in a particular column of the current line. 
  
    The line following the current line is not affected. 
  
 ----------------------------------------------------------------------
 Locate String:  L [col# {1}] [string {previous}]
 ----------------------------------------------------------------------
    locates the next line containing "string" in or after the specified
    column "col#", beginning with the next line after the current line. 
  
    If   "string"   is   omitted,   the  string  entered  on  the  last
    "Locate-String" or "Find-String" command is used again. 
  
    If "col#" is omitted, the search for "string" begins in column 1 of
    each line. 
  
    The message "BOTTOM" is printed if the string is not  located,  and
    the current line is set to the bottom line of the file. 
  
 ----------------------------------------------------------------------
 Merge File:  MER [file-spec | filnum #] [begin# [end#]]
 ----------------------------------------------------------------------
    merges  the  contents of the file indicated by "file-spec" into the
    edit file after the current line.  If "file-spec" is  omitted,  the
    last file merged is used again. 
  
    A  merge  file  can  also be selected by giving the number "filnum"
    followed by the symbol "#", where "filnum" refers to  the  position
    number  of  a  file  specification stored in the list of remembered
    files displayed by the "Show-Status" command.  The "filnum" may  be
    signed  +  or -, relative to the position of the current merge file
    specification in the list. 
  
    A portion of a file can be merged by specifying the range of  lines
    "begin#" to  "end#".    If  "end#" is omitted, the remainder of the
    file is merged. 
  
    The "end#" may be signed +, relative to the "begin#". 
  
 ----------------------------------------------------------------------
 Move Line(s):  MOV [begin-line# [end#] {previous-line}]
 ----------------------------------------------------------------------
    Moves the range of lines specified by "begin-line#" through  "end#"
    to after  the  current  line.  If "end#" is omitted, only 1 line is
    moved.  If both line numbers are  omitted,  the  previous  line  is
    moved after the current line. 
  
    The  "begin-line#"  may  be  signed + or -, relative to the current
    line, and "end#", relative to "begin-line#". 
  
  
  
  
 EE Text Editor                                Text Editing Commands  6
  
  
  
 ----------------------------------------------------------------------
 Move to Next Line:  N [#lines {1}]
 ----------------------------------------------------------------------
    Sets the current line pointer to the next line, or next by "#lines"
    if given. 
  
    If "#lines" points beyond the  bottom  of  the  file,  the  message
    "BOTTOM"  is  printed,  and  the  current line is set to the bottom
    line. 
  
 ----------------------------------------------------------------------
 Overlay String:  O [at-col# {1}] string
 ----------------------------------------------------------------------
    overlays "string" onto the current line at  the  specified  column.
    The column number "at-col#" defaults to 1. 
  
 ----------------------------------------------------------------------
 Print Line(s):  P [#lines {1} [#col {width-col}]] [NUM]
 ----------------------------------------------------------------------
    Prints  a total of "#lines" lines, beginning with the current line.
    If "NUM" or "N" is specified, the "NUMPRT"  switch  is  temporarily
    reversed (refer  to  the  "Set-Switch"  Command).    The  last line
    printed becomes the current line. 
  
    Printed lines can  be  truncated  or  extended  to  length  "#col";
    otherwise, they are printed to the current "WIDTH" column (refer to
    the "Set-Switch" Command). 
  
    The  message  "BOTTOM" is printed if "#lines" exceeds the bottom of
    the file, and the current line is set to the bottom line. 
  
 ----------------------------------------------------------------------
 Put Edited File:  PUT [file-spec | filnum #] [begin-line# [end#]]
 ----------------------------------------------------------------------
    If no parameters are specified, this command puts the  edited  file
    back under a new version number. 
  
    The  parameter "file-spec" may be used to give the file a different
    name, or  to  put  the  file  into  a  different  directory.    The
    "file-spec" then becomes the default name of the edit file. 
  
    A different file can also be selected by giving the number "filnum"
    followed  by  the symbol "#", where "filnum" refers to the position
    number of a file specification stored in  the  list  of  remembered
    files displayed  by the "Show-Status" command.  The "filnum" may be
    signed + or -, relative to the position of the  current  edit  file
    specification in the list. 
  
    A  portion of the edit file may be specified by giving the range of
    lines "begin-line#" to "end#".  If "end#" is omitted, only one line
    is selected. 
  
    The "begin-line#" may be signed + or -,  relative  to  the  current
    line, and "end#", relative to "begin-line#". 
  
 ----------------------------------------------------------------------
 Quit Edit:  Q [OK]
 ----------------------------------------------------------------------
    terminates the Text Editor and returns to VAX command mode. 
  
    If  the  current  edit  file has been modified, but it has not been
  
 EE Text Editor                                Text Editing Commands  7
  
  
  
    saved in its entirety with a "Put-Edited-File" command, the user is
    warned before the Editor terminates with: 
  
                    Current File not Saved, OK to Quit?
  
    A response of "NO" (or  "N")  will  return  to  edit.    Any  other
    response will  quit.    Using  the  parameter  "OK" will bypass the
    warning. 
  
 ----------------------------------------------------------------------
 Replace Line:  R [at-col# {insert-col}] string
 ----------------------------------------------------------------------
    replaces the current line beginning at the  specified  column  with
    "string". 
  
    If  "at-col#"  is  omitted,  the  line  will  be  replaced  at  the
    "insert-col" column.  The value of "insert-col" can be set  by  the
    "Set-Switch" command.  "At-col#" may be entered as + or -, relative
    to the value of "insert-col". 
  
 ----------------------------------------------------------------------
 Restore Line:  RES
 ----------------------------------------------------------------------
    restores the last changed or deleted line over the current line. 
  
    If  multiple  lines  were  changed,  only  the last changed line is
    restored.  If multiple lines were deleted, only the  first  deleted
    line is restored. 
  
 ----------------------------------------------------------------------
 Set Switch:  SET [item-name [value]] {prints all}
 ----------------------------------------------------------------------
    If  no parameters are specified, the current settings of the Editor
    switch items are displayed.  Specifying "item-name" sets the  value
    of one  of  the  following items.  Item names can be abbreviated to
    one letter. 
  
    Mode Switches
  
    The number-print switch "NUMPRT" determines whether text lines will
    be printed  with  line  numbers.    The  substitute-matches  switch
    "SUBMAT"   enables   MATCH   patterns  to  be  substituted  in  the
    "Change-String" command.    The  translation-print  switch  "TRANS"
    determines   whether  lines  will  be  printed  with  non-printable
    characters translated to "^". 
  
    Switches may be set with a YES/NO  value  (Y/N).    If  the  YES/NO
    parameter is omitted, the switch setting is toggled (reversed). 
  
    Column Settings
  
    The   "FIND"   column   is  the  default  column  setting  for  the
    "Find-String" and "Locate-String" commands.  The "INSERT" column is
    the default column setting for the "Insert-Line" and "Replace-Line"
    commands.  The "WIDTH" column defines the width  of  lines  edited;
    any data  outside this column is unaffected by editing.  The column
    setting "value" may be signed +  or  -,  relative  to  the  current
    column setting.  If "value" is omitted, "1" is assumed. 
  
    Change-Command Information
  
  
 EE Text Editor                                Text Editing Commands  8
  
  
  
    The  "MATCH"  character  is  used in the "Change-String" command to
    designate special character-matching patterns.   If  the  character
    "value"  is  omitted from the command, the "MATCH" character is set
    to null and is disabled. 
  
    The auto-number values with "AUTO#" set the initial  and  increment
    values    for   the   auto-number   pattern   recognized   by   the
    "Change-String" command.  Both  values  may  be  set  as  +  or  -,
    relative to  the  current auto-number settings.  If both values are
    omitted, auto numbering will be "1" by "1". 
  
 ----------------------------------------------------------------------
 Show Status:  SHOW
   [COLUMNS [#columns {72}] | FILES [beg#[end#]]] {shows options}
 ----------------------------------------------------------------------
    shows line columns or files used. 
  
    The "COLUMNS" (or "C") option  shows  a  column-indicator  line  of
    length "#columns" (default of 72). 
  
    The  "FILES"  (or "F") option shows a list of files used during the
    current edit session.  Each file specification is listed  with  the
    number  of lines read from or written to the file and the number of
    the last input or output reference that was made to the file. 
  
    A portion of the file list may be specified by giving the range  of
    files "beg#"  to  "end#".    If "end#" is omitted, only one file is
    selected. 
  
    The "beg#" may be signed + or -, relative to the  position  of  the
    current  edit  file specification in the list, and "end#", relative
    to "beg#". 
  
 ----------------------------------------------------------------------
 Move To Line#:  T [line# {0}] | [[previous# {1}] PREV]
 ----------------------------------------------------------------------
    Sets the current-line pointer to the given line# or to the  top  if
    the line  number  is omitted.  The parameter "PREV" (or "P") may be
    specified to set the current-line pointer to  a  previous  position
    ("previous#" may be 1, 2 or 3). 
  
    If  "line#" points beyond the top of the file, the message "TOP" is
    printed, and the current line is set to the top line. 
  
    If "line#" points beyond  the  bottom  of  the  file,  the  message
    "BOTTOM"  is  printed,  and  the  current line is set to the bottom
    line. 
  
 ----------------------------------------------------------------------
 Translate Characters:  TR UP | LOW [beg-col# {1} [end#]]
 ----------------------------------------------------------------------
    translates letters on the current line to upper or lower case. 
  
    The case parameter may be "UP" ("U") or "LOW" ("L").  A portion  of
    the  current  line  may  be  translated  by specifying the range of
    column numbers "beg-col#" to "end#".  If  "end#"  is  omitted,  the
    remainder of the line is translated. 
  
  
  
  
  
 EE Text Editor                                Text Editing Commands  9
  
  
  
 ----------------------------------------------------------------------
 Move Up to Line:  U [#lines {1}]
 ----------------------------------------------------------------------
    Sets  the  current  line  pointer up to the previous line, or up by
    "#lines" if given. 
  
    If "#lines" points beyond the top of the file, the message "TOP" is
    printed, and the current line is set to the top line. 
  
  
 Meta-Language_Editing_Cmds__________________________
  
         The  following  commands  allow  the  Text   Editor   commands
    themselves to be modified. 
  
 ----------------------------------------------------------------------
 Alter:  ALT [meta-char-name [char]] | [mode-name [YES | NO]]
 ----------------------------------------------------------------------
    Alters the command-language meta-characters and mode switches. 
  
    The  meta-characters  are  the  delimiter  "DELIM" (which separates
    multiple commands), the separator "SEPAR" (which separates  command
    parameters),  and  the  null-number character "NULL" (which gives a
    null value to a numeric parameter).  If  the  parameter  "char"  is
    omitted, the meta-character becomes disabled. 
  
    The  mode  switches include the print-verify switch "VERIFY" (which
    controls the printing of a line after a command is processed),  the
    "OK-error"  switch "OKERR" (which continues command processing when
    an error occurs), and the  stop-mode  switch  "STOP"  (which  stops
    command-line, but  not  command-file,  processing at "BOTTOM").  If
    the YES/NO parameter is omitted from the command,  the  mode-switch
    setting is toggled (reversed). 
  
    When  no  parameters  are specified, the "Alter" command prints the
    current values of the meta-characters and mode switches. 
  
 ----------------------------------------------------------------------
 Ask User:  ASK [prompt-message {Y or N}]
 ----------------------------------------------------------------------
    This command is used in conjunction with the  "End-of-Ask"  command
    to  allow  conditional processing of multiple commands on a command
    line. 
  
    When encountered on a  command  line,  this  command  displays  the
    "prompt-message" (default of "Y-or-N") followed by a question mark,
    and pauses command execution.  Valid responses are: 
  
        Yn  -  "yes", execute following commands and continue "n" times
             without asking ("n" defaults to 1)
        Nn - "no", skip following commands to "End-of-Ask" command, and
             continue "n" times without asking
        G - "go", execute following commands without further prompting
        S - "stop", stop command-line processing and return to user
  
    "Ask-User" command sequences can be nested to 11 active levels. 
  
  
  
  
  
  
 EE Text Editor                                  Meta-Language Cmds  10
  
  
  
 ----------------------------------------------------------------------
 End of Ask:  ?  [any-comment]
 ----------------------------------------------------------------------
    Marks the end of an "Ask-User" command sequence, and it is  treated
    as a comment. 
  
 ----------------------------------------------------------------------
 Cmd File Input:  CIN [file-spec | filnum #]
 ----------------------------------------------------------------------
    reads commands  from  the  command file "file-spec".  Command files
    may be nested to 6 levels. 
  
    A command file can also be selected by giving the  number  "filnum"
    followed  by  the symbol "#", where "filnum" refers to the position
    number of a file specification stored in  the  list  of  remembered
    files displayed  by the "Show-Status" command.  The "filnum" may be
    signed + or -, relative to the position of the current command file
    specification in the list. 
  
 ----------------------------------------------------------------------
 Comment:  # [any-comment]
 ----------------------------------------------------------------------
    allows commenting of command files and macros. 
  
 ----------------------------------------------------------------------
 Define Cmd Macro:  DEF [macro-name [/string/] or num-macros OK
 ----------------------------------------------------------------------
    This command has two forms. 
  
    The first form defines a command macro named "macro-name"  to  have
    the contents  "string".   The macro can be executed by entering the
    macro name as a new command.  A macro may contain multiple commands
    since the "string"  is  offset  by  slashes  (or  any  other  alpha
    character).   If  "string"  is  omitted  or all blank, the macro is
    deleted. 
  
    The macro name may be up to 8 characters in length and contain  any
    character  except  the  digits  0-9,  +,  -,  .,  /,  the parameter
    Separator, the command Delimiter, and  the  Null-Number  character.
    If  "macro-name"  refers to an existing macro, the current macro is
    replaced. 
  
    Command macros may contain any command and may define other command
    macros.  There is no limit to macro nesting.  Recursive macros  are
    terminated when encountered. 
  
    The second form of the command sets the number of defined macros to
    "num-macros", deleting  the  rest.    If  "num-macros" is zero, all
    macros are deleted. 
  
 ----------------------------------------------------------------------
 Help:  H
   [user-cmd | internal-cmd | macro-name | begin-macro# [end#]]
 ----------------------------------------------------------------------
    If a command name is  specified,  the  help  command  displays  the
    function and parameter format for the given command. 
  
    The  help  command can also be used to show the contents of command
    macros, specified either by macro name  or  by  a  range  of  macro
    numbers.  For specifying macro numbers, "begin-macro#" may be given
    as a negative number relative to the number of the last macro.  The
  
 EE Text Editor                                  Meta-Language Cmds  11
  
  
  
    "end#" may be given relative to the "begin-macro#". 
  
    Up to eight names are allowed on one help command. 
  
 ----------------------------------------------------------------------
 Rename Cmd:  REN (user-cmd | internal-cmd | macro-name) new-name
 ----------------------------------------------------------------------
    renames a command or command macro to "new-name". 
  
 ----------------------------------------------------------------------
 Repeat Cmd Line:  * repeat# [cmd#-from-left {1}| -#cmds-from-right]
 ----------------------------------------------------------------------
    repeats a command line "repeat#" number of times.  A portion of the
    command  line  can  be repeated by giving either the command number
    from the left of the command line, or a  negative  number  for  the
    number  of  commands  back  from the right ("-1" would refer to the
    command immediately before the "Repeat-Cmd-Line" command). 
  
    Command repeat groups can be nested to 8 levels.  The "repeat#"  is
    limited to 99. 
  
 ----------------------------------------------------------------------
 Return from Macro or Cmd File:  RET [#levels {1}]
 ----------------------------------------------------------------------
    Returns  control  from  a command macro and/or command file through
    "#levels" levels of nesting. 
  
 ----------------------------------------------------------------------
 User Variables:  VAR [ADD MUL DIV EXP][var1 var2 ... var8]
 ----------------------------------------------------------------------
    If no parameters are specified, this command displays the values of
    up to 8 user variables. 
  
    The user variables may be set to absolute unsigned  values  or  set
    relatively by + and -. 
  
    Arithmetic operations  may  be  specified  by:   "ADD" (the default
    operation), "MUL" (multiply times variables),  "DIV"  (divide  into
    variables), and "EXP" (raise variables to exponents).  Examples: 
  
        VAR 47.61 47.61     <--- calculate 47.61*7 and 47.61*9
        VAR 7 9 M; VAR
  
        VAR 769 770 770     <--- calculate 769**2,770**2,770**3
        VAR 2 2 3 EX; VAR
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
 EE Text Editor                                  Meta-Language Cmds  12
  
  
  
 Editor_Command_Macros_____________________
  
         The following commands are macros defined when the Text Editor
    program is started. 
  
  
  
 File Print/Display Macros  ( ] : :P :] :: PP @ )
     
          - a blank line is a "Next"
      ]   - moves up to previous line
      :   - prints next page at the current line (P22)
      :P  - prints current page to the current line
      :]  - prints previous page
      PP  - prints a page from 9 lines up; current line unchanged
      ::  - prints a page as in "PP"; shows columns above line
      @   - prints a page from the top of the file
      [@  - prints a page from the bottom of the file
         Pages are defined by macro ":".
     
  
  
 Show/Information Macros    (CC FF DESC)
     
      CC [#lines]   - Shows columns & then prints "#lines"
      FF            - Shows the list of remembered files
      DESC [cmd-title]  - returns the full description of the specified
                          command by using the "Information" command
     
  
  
 Text-Editing Macros        (AT SP BR VE REQ MOD LOC)
     
      AT [col#]     - Mark current line for split with "%" at col#
      SP [prefix]   - Splits the current line at "%" and puts the optional
                      text "prefix" at the beginning of the 2nd line
     
      BR            - "Brief":  ALT VERIFY NO
      VE            - "Verify":  ALT VERIFY
     
      INP           - Enter multi-line input mode, terminate with ^Z
     
      REQ           - Initiates an Ask sequence with "MOD" & "LOC" macros
      MOD           - macro executed by "REQ" on YES to "OK to Modify?"
      LOC           - macro executed by "REQ" to locate next line to modify
     
  
  
 Editing Environments:  ENV shows environment, CMDS shows macros
  
  
 FLXENV  - FLECS Language Editing Environment
     
      The "FLXENV" macro invokes the "FORENV" macro,
      and defines the following macros:
     
      ISE           - insert "SELECT ("
      ICO           - insert CONDITIONAL stmt
      IOT           - insert (OTHERWISE) stmt
      IFI           - insert FIN
      IEL           - insert ELSE
  
 EE Text Editor                               Editor Command Macros  13
  
  
  
      SPF           - split 1-line FLECS control structure as 2 lines
      SPL           - split line at "%" into col 7
      RECOVER       - recover .FLX source by changing .LIS file
      FLXDEL        - delete FLECS-Editing macros, and set CMDS & ENV
                      macros to "(No Environment Selected)".
  
  
 FORENV  - FORTRAN Language Editing Environment
     
      The "FORENV" macro sets the "FIND" & "INSERT" columns to 7,
      and defines the following macros:
     
      ISU [name]    - insert SUBROUTINE stmt with "name"
      INC [file]    - insert "INCLUDE '"
      IIN [list]    - insert INTEGER stmt with "list"
      ICA [etc]     - insert CALL stmt with "etc"
      IF [etc]      - insert "IF (" with "etc"
      IS [comment]  - insert "C-----" comment to col 50
      ICF [format]  - insert FORMAT stmt continuation
      IRE           - insert RETURN
      IEN           - insert END
      >             - shift current line right 6 spaces
      <             - shift current line left 6 spaces
      >>[col#]      - shift current line right 3 spaces at col#
      <<[col#]      - shift current line left 3 spaces at col#
      STUB [name]   - insert entire subroutine stub with "name"
      FORDEL        - delete FORTRAN-Editing macros, and set CMDS & ENV
                      macros to "(No Environment Selected)".
  
  
 TEXENV  - Text Editing Environment
     
      The "TEXENV" macro sets the "FIND" & "INSERT" columns to 1,
      and defines the following macros:
     
      TABLE         - insert FMT commands for an indented table
      HEAD [title]  - insert section heading named "title"
      DEPARA        - insert FMT cmds to define .para paragraph macro
      TEXDEL        - delete Text-Editing macros, and set CMDS & ENV
                      macros to "(No Environment Selected)".
  
  
 COMENV  - VAX Digital Command Language Editing Environment
     
      The "COMENV" macro sets the "FIND" & "INSERT" columns to 8,
      and defines the following macros:
     
      II            - insert $ command
      IONE          - insert ON-ERROR command
      IONC          - insert ON-Control_Y command
      IGO           - insert GOTO
      IF            - insert IF
      IEX           - insert EXIT
      IOU           - insert Error Message:  Out "       X - X"
      COMDEL        - delete Command-Editing macros, and set CMDS & ENV
                      macros to "(No Environment Selected)".
  
  
  
  
  
  
 EE Text Editor                               Editor Command Macros  14
  
  
  
                              <<< end >>>
