home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / USCX / STEVEUT.ZIP / EDITOR.DOC < prev    next >
Text File  |  1984-05-23  |  12KB  |  258 lines
  1.  
  2.                      Editor version V1.1 Informtion for use.
  3.  
  4.                    A brief description of the files required:
  5.  
  6.  
  7.           Volume in drive B is MSB-PASWRK
  8.           Directory of  B:\
  9.  
  10.           NAME-OF  DSK       13   5-16-84  12:10a
  11.           MSBEDIT  EXE    54784   5-19-84   1:02a
  12.           EDIT-MOD PAS    21192   5-19-84  12:46a
  13.           DIR      LST        0   5-19-84  10:14p
  14.           EDT-MAIN PAS    24596   5-19-84
  15.                   7 File(s)     60416 bytes free
  16.  
  17.               MSBEDIT.EXE is the editor, you may rename this to any file
  18.          name you desire to call it.  EDIT-MOD.PAS is the source code of
  19.          the module it contains approx 600 lines of source code.
  20.          EDT-MAIN.PAS is the source code of the main module, also about
  21.          600 lines long.  This if for some reason you modify it, you
  22.          must recompile and link these modules together with the linker.
  23.          You must also include CLS.OBJ in the link command or delete the
  24.          line " Procedure cls;  external;  " from the source program so
  25.          the linker does not expect to find it.  I included mine, as
  26.          well as the .ASM source so you can decide.
  27.  
  28.  
  29.                        *** SUMMARY OF EDITOR COMMANDS ***
  30.                            --------------------------
  31.  
  32.               All editor commands are recognized by their first letter.
  33.          Users have the choice of using the first letter, or by typing
  34.          the entire command.  Commands will NOT be recognized by a
  35.          partial command if more than the first letter is used.
  36.  
  37.               Ex:  f for find.  Commands currently must be typed in
  38.          lower case, if you desire, change the table to uppercase and
  39.          recompile.
  40.  
  41.                  *** COMMANDS WHICH ACT ON THE CURRENT LINE ***
  42.                      --------------------------------------
  43. B[OTTOM]        | Reset the current line pointer to point at the last li
  44.                   line in the file.  The last line is printed.  The
  45.                   message "EMPTY INPUT FILE" is printed if the file is
  46.                   empty. |
  47.  
  48.                   EX:   > b
  49.                         > bottom
  50.  
  51. F[IND][-]/string[/]     | Find the first occurrence of the string in the
  52.                           edit file, starting the search at the line
  53.                           following the current line.  If the string is
  54.                           found, the line containing string is printed.
  55.                           Otherwise, STRING NOT FOUND is printed, and
  56.                           the pointer is not reset.  If the string is
  57.                           preceded with a -, the search is performed
  58.                           backward through the file.
  59.  
  60.                           Ex:  > f/this string/
  61.                                > f-;strings may be any length;
  62.                                > find/.
  63.  
  64. N[EXT][<NUMBER>] | The simplest form (just n), the line following the
  65.                    current one is printed.  If there is a positive
  66.                    number or negative integer in the command stream
  67.                    the current line is moved forward or backward that
  68.                    many, or as many to the end or top of file.  If there
  69.                    is no next line then a message "END OF INPUT FILE" or
  70.                    "TOP OF INPUT FILE" is printed and the pointer is not
  71.                    moved. |
  72.  
  73.                    EX:  > n
  74.                         > n3
  75.                         > n-2
  76.  
  77. [T]OP   |  Make the first line the current one and print it.
  78.            "EMPTY INPUT FILE " is printed if there are no lines
  79.             in the buffer. |
  80.  
  81.                    EX:  > t
  82.                         > top
  83.  
  84.                             *** EDITOR DIRECTIVES ***
  85.                                 -----------------
  86.  
  87. A[PPEND]/STRING/[<COLUMN NUMBER>]
  88.  
  89.                 |  Append the string to the end of the current line
  90.            (if no column number is specified) and print the
  91.            new line.  If column number is specified, append
  92.            the string to the line starting in that column.
  93.            Any characters after the inserted string are lost. |
  94.  
  95.                    (assume current line = "MARY HAD A LITTLE")
  96.            EX:          > a/la/
  97.                           MARY HAD A LITTLE la
  98.                         > a/mb/
  99.                           MARY HAD A LITTLE lamb
  100.                         > a/./5
  101.                           MARY.
  102.  
  103. C[HANGE]/OLD STRING/NEW STRING/
  104.  
  105.                 |  Change the first occurrance of old string to
  106.                    new string.  If old string is not present in the
  107.                    line an appropriate message is printed.  If the
  108.                    new string is not specified the old string is
  109.                    replaced with the null string.  Assume that a null
  110.                    string precedes all lines.   |
  111.  
  112.           EX:
  113.                   Jack be mimble, jack be quick
  114.                   > c/mi/ni/
  115.                   Jack be nimble, jack be quick
  116.                   > c/jack/Jack/
  117.                   Jack be nimble, Jack be quick
  118.                   > c//Black/
  119.                   BlackJack be nimble ....
  120.  
  121. D[ELETE][<STRING>|<NUMBER>]
  122.                 |  Delete the current line (if optional string or
  123.                    number is not specified) and reset the current line
  124.                    pointer to the line following the one deleted.
  125.                    If the last line is deleted, the message "BOTTOM OF
  126.                    "FILE" is printed.  If d{number} is used, that many
  127.                    lines is deleted from the current line.  By using
  128.                    d<string> will delete line, and all following lines
  129.                    until string is found.  |
  130.  
  131.                 EX:  > d    { delete only the current line }
  132.                      > d2   { delete current line and one following }
  133.                      > d-2  { delete current line and one previous  }
  134.                      > d/it/ {delete current line and all following
  135.                               until "it" is found               }
  136.                      > ^d!  { delete all lines in buffer  }
  137.                      > d!   { delete current and all following lines }
  138.  
  139. I[NSERT]        |  Enter the insert mode.  Lines are inserted after the
  140.                    current line.  The input prompt is the * To exit the
  141.                    insert mode type a backslash with nothing else on the
  142.                    line (\).   |
  143.  
  144.                    EX:  > i   {  message displayed:  MODE> INSERT  }
  145.                         * <type new text here><cr>
  146.                         * \
  147.                         MODE> COMMAND
  148.                         >    {   back to command level  }
  149.                         the last inserted line is the current line, and
  150.                         is printed.
  151.  
  152. P[RINT][<STRING> | <NUMBER>]
  153.                 |  Print the current line.  If a number is specified
  154.                    the current line plus that number is displayed.
  155.                    The current line pointer not moved.
  156.                    p<string> prints the first line containing string
  157.                    if found.     |
  158.  
  159.                    EX:  > p
  160.                         > p2
  161.                         > p/THIS
  162.                         > p-/THAT
  163.                         > ^p!  { print whole buffer   }
  164.  
  165. R[EPLACE]       |  The current line is deleted and the editor enters
  166.                    insert mode.  (See insert command for more
  167.                    information on insert).  The last line entered is
  168.                    the new current line.  It is printed.   |
  169.  
  170.                 EX:         > r
  171.                             * new line
  172.                             * newer line
  173.                             * \
  174.                             MODE> COMMAND
  175.                             newer line
  176.                             >
  177.  
  178.                             *** SYSTEM DIRECTIVES ***
  179.                                 -----------------
  180.  
  181. A[BORT]        |   Cancel the current edit file.  Do NOT update the
  182.                    external edit file.  This command must be spelled
  183.                    out because of the append command.   |
  184.  
  185.                    EX:
  186.  
  187.                    > abort
  188.  
  189. S[TOP]         |   Stop the current session.  Write the internal buffer
  190.                    out the external disk file, named on entry.    |
  191.  
  192.                    EX:
  193.                    > s
  194.                    > stop
  195.  
  196.                          *** ENVIRONMENT DIRECTIVES ***
  197.                              ----------------------
  198.  
  199. H[EADER]<COLUMNS>   |  This procedure displays a column of numbers
  200.                        1 .. <columns>; if columns is > 72 then only
  201.                        72 are displayed.  This is useful for finding
  202.                        which column characters should be aligned in.
  203.                        this line is never inserted into the file.
  204.  
  205. V[ERIFY]    |   The verify flag is toggled on or off.  The verify flag
  206.                 is used by directives such as change or next to display
  207.                 their results.  The verify flag is initialized to on
  208.                 when the editor is first loaded.   |
  209.  
  210.                 EX:  > v
  211.                      > verify
  212.  
  213.               Any edit directive can be preceded by plus or minus some
  214.          integer.  This will add (or subtract) that number to (or from)
  215.          the current line pointer before applying the edit directive.
  216.          For example:
  217.       > +2p   :  prints the second line past the current line.
  218.       > -1i   :  insertion mode is entered; insertion before the current
  219.                  line.
  220.  
  221.               The editor places special significance on the following
  222.          symbols:  ^ = reference to the TOF mark.  !  = process as
  223.          infinity (maxint).  For delete, print and anywhere that a
  224.          number may appear.
  225.  
  226.               The editor does not display any line numbers because line
  227.          numbers are not an intrinsic part of the file.  However, you
  228.          may still use line numbers to reference any line.  For example:
  229.          > 10c/it/is will change it to is on line 10.  Delimiters at the
  230.          end of a command are optional.
  231.  
  232.               Example:  f/this stiring/ is equivelent to f/this string
  233.          if both delimiters are used they must be identical, and should
  234.          not appear in the string.
  235.  
  236.               To start the editor:  at the DOS prompt type:  MSBEDIT
  237.          <FILENAME>, if you enter MSBEDIT without the file name you will
  238.          be prompted by system:  "EDFILE:", type the filename to be used
  239.          here.  This is because DOS needs a default name in case the
  240.          program passes a bad one.  You will be prompted by the PASCAL
  241.          program to enter the filename again.  If you use the filename
  242.          as a command parm then the system prompt will not appear.
  243.  
  244.  
  245.               If you plan to do any work to the source code I suggest
  246.          that you read and understand what the code is doing before you
  247.          modify it.  I was unable to leave the comments in it I
  248.          orignially planned on because I was running out of free space
  249.          on disk and compilations, and .LST files were getting out of
  250.          hand with it.  Sorry it is so bulky.
  251.  
  252.               I would not recommend it on very large files, say more
  253.          that 600 lines unless you have more that 128 bytes of memory.
  254.          I have 128Kb and under DOS 2.00 found operation fairly slow
  255.          with large files.  Especially on find or change commands.
  256.          However it works quite nicely on small to medium files.  I
  257.          believe it is somewhat better that EDLIN at least.
  258.