home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / APOG / EDIT.ZIP / EDITDOC2.PRN < prev    next >
Encoding:
Text File  |  1985-03-01  |  18.7 KB  |  343 lines

  1.         Command Overview                                                  2-1
  2.  
  3.  
  4.         2.  COMMAND OVERVIEW
  5.         2.  COMMAND OVERVIEW
  6.             
  7.         One of the nice things about EDIT is how easy  it  is  to  use.    To
  8.         create a document named memo1, the user types
  9.             
  10.             edit memo1
  11.             
  12.         waits  for  EDIT  to  start executing, and then simply starts typing.
  13.         There is no need to wade through a hierarchy of  menus  just  to  get
  14.         started.   To delete a character, the user presses the backspace key.
  15.         To move the cursor, the user presses one of the the arrow keys on the
  16.         right side of the keyboard.  EDIT's commands are simple, and they are
  17.         easy to use (just one or two keystrokes), but they are powerful.
  18.             
  19.             
  20.         2.1.  Basic Concepts
  21.         2.1.  Basic Concepts
  22.             
  23.         EDIT is a program that runs on an IBM-PC  compatible  computer.    It
  24.         allows  a user to create and edit documents containing arbitary text.
  25.         To do this, EDIT must first be started (explained  in  section  2.2).
  26.         Once  EDIT  is  started,  it  allows  the  user  to  type text at the
  27.         keyboard.  As each character is typed, EDIT displays it  on  the  CRT
  28.         screen  of  the  computer.    The  place  where the character will be
  29.         displayed is indicated by the small, blinking  dash  on  the  screen.
  30.         This  line is called the "cursor".  After the character is displayed,
  31.         the cursor moves one position to the right.  When the user types  the
  32.         Enter key, the cursor moves one line down and to the left side of the
  33.         Enter                                                                
  34.         screen (like pressing the return key on a typewriter).
  35.             
  36.         EDIT also stores each character the user types  in  a  large  storage
  37.         area  in  the computer called its "editing buffer", or just "buffer".
  38.         The buffer holds many more characters than EDIT can  display  on  the
  39.         screen at once, so EDIT is limited to only displaying 23 lines of the
  40.         text at any one time.  When the user types more lines  of  text  than
  41.         will  fit  on  the  sreen, the cursor can no longer be moved down, so
  42.         instead, all the lines on the screen are "scrolled" up one line,  the
  43.         top  line  disappears,  and the cursor stays on the bottom line.  The
  44.         user need not worry about the line that disappears from  the  top  of
  45.         the screen.  It is still stored in the editing buffer.
  46.             
  47.         EDIT  also  allows  the  user  to  modify the text he has typed.  For
  48.         example, when  the  user  types  the  Backspace  key,  the  character
  49.                                               Backspace                      
  50.         immediately to the left of the cursor will be erased from the screen,
  51.         and the cursor will move one position to the left.  In fact, all EDIT
  52.         commands  that modify the text affect only the characters immediately
  53.         adjacent to the cursor.
  54.             
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                   EDIT Users Manual                          
  62.         Command Overview                                                  2-2
  63.  
  64.  
  65.         EDIT includes commands for moving the cursor around the screen.  This
  66.         allows  the user to go back to characters typed previously and delete
  67.         them, or insert new text.    Whenever  the  user  gives  some  cursor
  68.         command  that  would  move  the  cursor  off the top or bottom of the
  69.         screen (like the up command when the cursor is on the top line of the
  70.                          up                                                  
  71.         screen),  the  screen  is  scrolled  up  or down instead, so that the
  72.         cursor always stays on the screen.  EDIT also includes  commands  for
  73.         moving  the  cursor  to  any  point in the text stored in the editing
  74.         buffer.  When the  user  gives  one  of  these  commands,  EDIT  will
  75.         completely  update  the  text displayed on the screen, so that the 23
  76.         lines adjacent to the cursor are displayed.
  77.             
  78.         As explained above, EDIT stores all the text the user is  editing  in
  79.         its  editing  buffer.    However,  this  storage  of the text is only
  80.         temporary, while the user is running EDIT.    For  a  more  long-term
  81.         storage  of  the  text,  the  user  must save it in a DOS file.  EDIT
  82.         includes commands to save text  in  a  file  and  retrieve  the  text
  83.         previously  saved in a file.  EDIT will warn a user if he attempts to
  84.         do anything that will lose the text in the editing buffer if  it  has
  85.         not been saved in a file.
  86.             
  87.             
  88.         2.2.  How to Start EDIT
  89.         2.2.  How to Start EDIT
  90.             
  91.         The command to start EDIT has the following basic form:
  92.                                 
  93.             edit [ filename ]
  94.  
  95.         To  start EDIT, this command should be entered in response to the DOS
  96.         prompt.  The brackets around "filename" indicate  that  the  file  is
  97.         optional.   The user should not type the brackets.  The user does not
  98.         actually type "filename".  Instead, he should type the actual name of
  99.         a DOS file he wishes to edit.
  100.             
  101.         If  no  file  is  supplied,  EDIT  will  be initialized with an empty
  102.         editing buffer and the message "No file specified"  is  displayed  in
  103.         the lower left corner of the screen.
  104.             
  105.         If  the  file  already  exists, it is read into EDIT's buffer and the
  106.         cursor is positioned at the beginning of the file.  EDIT displays the
  107.         message "Editing: filename" in the lower left corner of the screen.
  108.             
  109.         If  the  file  does  not yet exist, EDIT is initialized with an empty
  110.         buffer, and EDIT displays the message  "Creating:  filename"  in  the
  111.         lower left corner of the screen.
  112.             
  113.         Thus, the following are several examples of how EDIT is invoked:
  114.             
  115.  
  116.  
  117.  
  118.  
  119.  
  120.                                   EDIT Users Manual                          
  121.         Command Overview                                                  2-3
  122.  
  123.  
  124.             edit
  125.             edit memo.txt
  126.             edit b:prog1.src
  127.                             
  128.             
  129.         The  user may also supply the name of a "setting-file" after the name
  130.         of the file to edit.  Thus, the following is the  full  form  of  the
  131.         command to start EDIT:
  132.             
  133.             edit [ filename [ settingfile ] ]
  134.             
  135.         The  setting  file  is  used  to  initialize  the options that effect
  136.         editing and printing.  If no setting file  is  specified,  edit  will
  137.         look for the file "edit.set" on the default DOS device.  If this file
  138.         exists, it will be used to initialize EDIT's  settings.    Otherwise,
  139.         EDIT  will  use  its  default  settings, which have been designed for
  140.         basic word processing.  The setting  file  is  explained  in  greater
  141.         detail   in  section  3.3.    Section  3.4  also  explains  how  EDIT
  142.         automatically looks for a  setting  file  associated  with  the  file
  143.         currently being edited.
  144.             
  145.         The  following  examples show how the user may start EDIT and specify
  146.         both a file to edit and a setting file:
  147.             
  148.             edit prog2.c color.set
  149.             edit letter.txt wp.set
  150.  
  151.             
  152.         2.3.  Screen Organization
  153.         2.3.  Screen Organization
  154.             
  155.         EDIT organizes the screen as follows:
  156.                                         
  157.             Text area:      top 23 lines
  158.             Prompt line:    next to the bottom line
  159.             Status line:    bottom line
  160.             
  161.         EDIT uses the top 23 lines of the screen to display  the  portion  of
  162.         the  file  that  contains  the cursor.  Lines that are longer than 80
  163.         characters will  only  have  their  first  80  characters  displayed,
  164.         although all commands operate on long lines normally.
  165.             
  166.         EDIT  uses  the 24th line on the screen (the next to the bottom line)
  167.         for prompts regarding the use of function keys,  for  input  of  file
  168.         names, search strings, and such, and for messages.
  169.             
  170.         The  bottom  line  on  the screen displays the name of the file being
  171.         edited and various status indicators.  On the far right side  of  the
  172.         bottom  line EDIT displays the line and column numbers of the current
  173.         cursor position within the file.  To the left of the line and  column
  174.         numbers  on  the  bottom line, EDIT displays the amount of free space
  175.         currently available in its editing buffer  as  a  percentage  of  the
  176.  
  177.  
  178.                                   EDIT Users Manual                          
  179.         Command Overview                                                  2-4
  180.  
  181.  
  182.         total space available.
  183.             
  184.             
  185.         2.4.  Command Basics
  186.         2.4.  Command Basics
  187.             
  188.         Each  key the user types in EDIT may be considered a command, in that
  189.         each keystroke causes a specific action to take place, and the result
  190.         of  that action is immediately displayed on the screen.  Usually this
  191.         consists of moving the cursor, deleting a portion of text adjacent to
  192.         the  cursor,  or inserting the character typed into the buffer at the
  193.         cursor position.
  194.             
  195.         To avoid confusing the user, EDIT always does the same thing for  all
  196.         commands.  Thus,  EDIT might be called a "modeless" editor.  However,
  197.         EDIT does have different "modes" that determine what happens  when  a
  198.         character is typed for insertion into the buffer.  These are "Insert"
  199.         mode and "Replace" mode.  In Insert mode,  each  character  typed  is
  200.         inserted  into  the text at the cursor position and the characters to
  201.         the right of the cursor are moved over one position to make room  for
  202.         the  inserted  character.    In  Replace  mode,  the  character typed
  203.         replaces the character that was at the cursor position.
  204.             
  205.         Likewise, EDIT  gives  the  user  control  over  what  it  does  when
  206.         characters  are inserted or deleted so that a line doesn't fit nicely
  207.         between the left and right margins.  This is EDIT's "Word processing"
  208.         mode.    The  different  options  for  the  Word  processing mode are
  209.         explained in section  3.3,  under  the  "Set  Word  processing  mode"
  210.         command.
  211.             
  212.         A  simple  set  of rules for EDIT's commands is as follows.  All text
  213.         characters are simply inserted (or "replaced") into the buffer.   The
  214.         cursor  control  keys  (Left,  Home,  etc.)  on the right side of the
  215.                                 Left   Home                                  
  216.         keyboard generally perform some action that corresponds to the  label
  217.         on  the  key (Left means move cursor left, and Home means move cursor
  218.                       Left                             Home                  
  219.         to beginning of line).  In addition, each of these keys also  perform
  220.         some  "stonger" version of the same command when it is given with the
  221.         Shift key  depressed  (Shift-Left  means  move  left  one  word,  and
  222.         Shift                  Shift Left                                    
  223.         Shift-Home means move left one sentence).
  224.         Shift Home                               
  225.             
  226.         A similar set of rules governs the use of the 10 function keys on the
  227.         left side of the keyboard.  Each of  these  has  a  standard  command
  228.         associated with it.  The help line lists each of these commands.  For
  229.         example, F9 is the command to delete a block of text and save  it  in
  230.                  F9                                                          
  231.         an  internal  buffer  from which it can later be retrieved.  However,
  232.         some of these commands also have a modified version, which  is  given
  233.         by  holding  down  the  Shift  key  and  simultaneously  pressing the
  234.                                 Shift                                        
  235.         function key.  Shift-F9 is the command to  delete  a  block  of  text
  236.                        Shift F9                                              
  237.         without saving it.
  238.             
  239.  
  240.  
  241.  
  242.  
  243.                                   EDIT Users Manual                          
  244.         Command Overview                                                  2-5
  245.  
  246.  
  247.         For convenience, the user may use Alt or Ctrl instead of Shift to get
  248.                                           Alt    Ctrl            Shift       
  249.         the modified version of the function keys on the  left  side  of  the
  250.         keyboard.
  251.               
  252.         A few additional commands are obtained by pressing Alt and one of the
  253.                                                            Alt               
  254.         text keys in the center of the keyboard.  Generally the  key  pressed
  255.         with  Alt  is  the first letter of the desired command.  For example,
  256.               Alt                                                            
  257.         Alt-C is the Center command, which causes EDIT to center the  current
  258.         Alt                                                                  
  259.         line between the left and right margins.
  260.             
  261.         Note  that  it  is  also possible to use the cursor control keys as a
  262.         numeric pad, for ease of entering numbers, "+", and "-".  To  do  so,
  263.         the  user  should press the Num Lock key.  After this key is pressed,
  264.                                     Num Lock                                 
  265.         these keys will act as a numeric pad until Num Lock is pressed again.
  266.                                                    Num Lock                  
  267.             
  268.             
  269.         2.5.  Command Repetition
  270.         2.5.  Command Repetition
  271.             
  272.         Several of the commands accept  an  optional  repetition  count  that
  273.         indicates  the  number  of times the command should be executed.  The
  274.         repetion count is entered by pressing Esc,  followed  by  a  positive
  275.                                               Esc                            
  276.         number,  and  then  typing the command key.  For example, to move the
  277.         cursor down ten lines, the user may type the following:
  278.             
  279.             Esc 10 Down
  280.             Esc    Down
  281.                             
  282.         There is a default value for the repetition count that is used if the
  283.         user simply types Esc followed by the command.  The initial value for
  284.                           Esc                                                
  285.         this default is 5.  The default value may be changed by  typing  Esc,
  286.                                                                          Esc 
  287.         then  the new value, and then Enter.  The maximum repetition count is
  288.                                       Enter                                  
  289.         9999.  The count may not be negative.
  290.             
  291.         The commands that accept a repetition count include the following:
  292.         
  293.           - basic cursor movement commands
  294.           - find commands
  295.           - replace commands
  296.           - get command
  297.         
  298.         The deletion commands do not accept a repetition count.
  299.             
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.                                   EDIT Users Manual                          
  313.         Command Overview                                                  2-6
  314.  
  315.  
  316.         2.6.  Input to Command Prompts
  317.         2.6.  Input to Command Prompts
  318.             
  319.         A few EDIT commands require the user to enter a text string - a  file
  320.         name,  a  string to search for, etc.  Other commands require the user
  321.         to type a single character to select a particular option from a  menu
  322.         of  subcommands.   In both of these cases, the cursor is moved out of
  323.         the main text area, and down to the prompt line.  To  help  the  user
  324.         remember  the  position of the cursor in the file while the cursor is
  325.         actually down on the prompt line, the character at that  position  is
  326.         marked in reverse video.
  327.             
  328.         For  commands  that  require  the user to enter a string of text, the
  329.         user should type each character in the string, and then  press  Enter
  330.                                                                         Enter
  331.         to  terminate  the string and execute the command.  The Backspace key
  332.                                                                 Backspace    
  333.         may  be  used  to  delete  the  last   character   of   the   string.
  334.         Shift-Backspace  will delete the entire string.  To abort the command
  335.         Shift Backspace                                                      
  336.         requesting the string input, the user may type Esc.   Note  that  the
  337.                                                        Esc                   
  338.         Enter  key  is  the large key just above the key labeled "PrtSc" near
  339.         Enter                                                                
  340.         the right side of the keyboard.  The Backspace key is the  large  key
  341.                                              Backspace                       
  342.         just to the left of the key labeled "Num Lock" near the right side of
  343.         the keyboard, just above the Enter key.
  344.                                      Enter     
  345.             
  346.         When a command requires the user to type a single character to select
  347.         from a menu of subcommands, the subcommands are listed in parentheses
  348.         on the prompt line, and the cursor appears at the right  end  of  the
  349.         list.    The  user  selects  the  desired  option by typing its first
  350.         character. Typing any other character aborts the command.
  351.             
  352.         The user need not explicitly abort a  command  that  requires  string
  353.         input or option selection in order to execute a command on one of the
  354.         cursor control keys on the right side of the keyboard,  the  function
  355.         keys  on the left side of the keyboard, or one of the Shift commands.
  356.                                                               Shift          
  357.         Typing one these commands automatically aborts  the  current  command
  358.         and executes the new command.
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.                                   EDIT Users Manual                          
  379.