home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / ace.arc / ACE.DOC next >
Encoding:
Text File  |  1985-06-09  |  22.6 KB  |  463 lines

  1.  
  2.  
  3.  
  4.  
  5.                 ╔════════════════════════════════════════════════════════╗
  6.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  7.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ACE▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  8.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒(Ver 1.21)▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  9.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒┌------------┐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  10.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒├     BY     ┤▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  11.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒└------------┘▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  12.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  13.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒Patrick Bennett▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  14.                 ║▒▒▒▒All rights reserved, Copyright 1985 C-STUFF co.▒▒▒▒▒║
  15.                 ║▒▒▒R.R.#12  Box #19  Muncie, IN  47302 (317)288-7547▒▒▒▒║
  16.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  17.                 ║▒   If you are using this program, find it of value,   ▒║
  18.                 ║▒        and would like for me to write more,          ▒║
  19.                 ║▒your contribution ($35 suggested) will be appreciated.▒║
  20.                 ║▒read documentation for info. on contribution benefits.▒║
  21.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  22.                 ║▒You are encouraged to copy and share this program with▒║
  23.                 ║▒other users, on the conditions that the program is not▒║
  24.                 ║▒     distributed in modified form, that no fee or     ▒║
  25.                 ║▒ consideration is charged and that this notice is not ▒║
  26.                 ║▒                 bypassed or removed.                 ▒║
  27.                 ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  28.                 ╚════════════════════════════════════════════════════════╝
  29.  
  30.         Loading ACE...
  31.  
  32.         You can load ACE four different ways:
  33.         1. Type "ace" on the A> prompt.  This will load the editor and then ask for
  34.            the file you wish to edit.
  35.         2. Type "ace" followed by a space and the name of the file you wish to load,
  36.            e.g.  A>ace example.c.  This example would load the editor, then load the
  37.            file "example.c" into its buffer.
  38.         3. Type "ace/l" which will load the last file you edited automatically
  39.            without displaying the logo.
  40.         4. When you become a registered user, information will be sent to you
  41.            allowing a fourth method of loading the editor.
  42.  
  43.         Using ACE...
  44.  
  45.                                       MOVING THE CURSOR
  46.  
  47.         To move the cursor up, down, left, and right use the arrow keys. To move the
  48.      cursor one word to the left hit the Ctrl key then the left arrow key.  To move
  49.      the cursor one word at a time to the right press the Ctrl key then the right
  50.      arrow key.
  51.  
  52.         To go to the beginning of a line press the Home key.  To go to the end of a
  53.      line press the End key.  To go to the top of the window press the Ctrl key then
  54.      the Home key.  To get to the bottom of the window press the Ctrl key then the
  55.      End key.  To scroll a page up towards the beginning of the file press the PgUp
  56.      key.  To scroll a page down towards the end of the file press the PgDn key. To
  57.      go to the beginning of the file press the Ctrl key then PgUp key.  To go to the
  58.      end of the file press the Ctrl key then the PgDn key.
  59.  
  60.         When you look at the left side of the screen, you will see a marker.  This
  61.      marker shows you where you are in your document relative to the beginning and
  62.      end of the current file If the marker is in the middle of the screen, you are
  63.      around the middle of the document.
  64.  
  65.  
  66.  
  67.  
  68. ACE                                                                        - Page 2 -
  69.  
  70.  
  71.         Press the Scroll Lock key and "SCRL" will appear at the top of the screen,
  72.      indicating that you are in a special mode.  When in this mode, some of the keys'
  73.      meanings change.  The Home key now will move the cursor to the left side of the
  74.      screen (as opposed to the start of a line).  The End key will go move it to the
  75.      right side of the screen.  The up arrow will scroll up a half screen.  The down
  76.      arrow will scroll down half a screen.  The left arrow will scroll left 4 times
  77.      the tab size.  The right arrow will scroll right 4 times the tab size.
  78.  
  79.         Also, you may move the cursor beyond the end of a line.  When you are beyond
  80.      the end of a line, as soon as you press a character key ACE will automatically
  81.      pad spaces from the end of the line to the cursor. It then inserts the
  82.      character.  This padding also works for block moves, copies, etc.  When you are
  83.      beyond the end of the line the destructive backspace acts just like the left
  84.      arrow, and the delete key is disabled.
  85.  
  86.                                        INSERTING TEXT
  87.  
  88.         Whenever the cursor is a large block, you are in insert mode. If it is small,
  89.      you are in overtype mode.  When you are in insert mode, each time you press a
  90.      key all the text from the cursor on is moved over a character and the key you
  91.      pressed is inserted in the new space.  When you are in overtype mode, the
  92.      character you press replaces whatever is under the cursor.  If you want to
  93.      toggle the insert and overtype modes, you just press the Ins key.
  94.  
  95.                                         DELETING TEXT
  96.  
  97.         If you want to delete text you can use the backspace key, the delete key,
  98.      block delete, or a line delete.  The backspace key when in insert mode, takes
  99.      all the text from the cursor on and moves it one character to the left,
  100.      replacing the character to the left of the cursor.  The Del key takes the text
  101.      next to the cursor and moves it over so that it replaces the character beneath
  102.      the cursor.
  103.  
  104.         Before you can do a block delete you must DEFINE A BLOCK.  To do this place
  105.      the cursor at the beginning or ending of the text you want to define as a block.
  106.      Press the F6 key.  This starts the definition of a block, now move the cursor
  107.      you will see the text highlighted as you move along.  When you finish marking
  108.      off the text you want defined as a block press the F6 key again. This stops the
  109.      definition.  Now if you want to delete the block press Alt and D for delete and
  110.      the block will be deleted.  Other uses for the blocks are explained below.
  111.  
  112.         To automatically delete a line without having to define it as a block just
  113.      press Alt and the E key for erase.  This will delete the line that the cursor is
  114.      on.
  115.  
  116.                                         USING BLOCKS
  117.  
  118.         Block operations are powerful; they allow you to easily make large changes
  119.      which would otherwise be tedious and time consuming. An example is Copy Block.
  120.      To do this, define a block (see above), then just press the Alt key then the C
  121.      key (for "copy") and a copy of the block will be inserted at the cursor
  122.      position.  You can also move a block, which means delete it then place it at the
  123.      cursor position.  To do this press the Alt key then the M key.  ACE makes
  124.      changing whole chunks of code easier by combining deleting and changing into one
  125.      operation.  You can press the Alt key and the L key to delete the line the
  126.      cursor is on and replace it with the block.  Press the Alt key and the B key to
  127.      delete everything within the nearest braces { } and insert a copy of the block.
  128.  
  129.      NOTE:
  130.      You may not you use the Alt C, M, L, or B commands while the cursor is in the
  131.      block.  But you may use the Alt D command while the cursor is in the block.
  132.  
  133.  
  134. ACE                                                                        - Page 3 -
  135.  
  136.  
  137.                                MISCELLANEOUS EDITING FEATURES
  138.  
  139.         Sometimes you may need to place SPECIAL CHARACTERS in the text that ACE
  140.      normally will not let you use (ASCII codes 215-255).  To do this press the Alt
  141.      Key then the X key.  ACE will then place the cursor at the top of the screen.
  142.      Type in the code you would like to insert or overtype (depending on the mode
  143.      you're in) and press the return key.  That character will then be placed in the
  144.      text. (Note: you may not insert code 254!).
  145.  
  146.      NOTE:
  147.      When editing a file all character 174's are displayed as 254's.  When you save
  148.      the file all the 254's are converted back to 174's.
  149.  
  150.         Also, if you press the ALT O key no matter where you are in a line it will
  151.      INSERT A LINE below the current line and space that line over so that it is
  152.      below the first non space in the old line.
  153.  
  154.         ACE contains special functions to help you in writing programs, C programs in
  155.      particular.  One of these is the Alt R command; this places at the cursor a */
  156.      then scans the line and figures out what kind of line it is (code or comment).
  157.      It then places at the appropriate place a /*.  It will also if you have defined
  158.      a block and the cursor is within the block, place remarks around the block. This
  159.      is helpful when you want the compiler to ignore a whole section of code.
  160.  
  161.                                    USER DEFINABLE WINDOWS
  162.  
  163.         When programming, there always seem to be things which you need periodically
  164.      but not often enough to commit to memory. Wouldn't it be handy if, instead of
  165.      getting out K&R or some other book or document, and looking up something in the
  166.      index, finding the correct page, etcetera, you could create help windows,
  167.      callable from inside your editor?
  168.  
  169.         Ace gives you this capability by allowing you to open a window in the top
  170.      half of the screen into which you can load any maximum 2K file.  You may only
  171.      scroll through this file; you may not edit it. To open this window press the Alt
  172.      key then F2 this will give you a choice between opening or closing the window.
  173.      Select Open, then type in the name of the file to load.  If you want to close it
  174.      just select Close.  When you are in the top window the arrow keys scroll. When
  175.      you want to switch between windows, press Alt F1.  You can tell which window
  176.      you're in by where the ACE sign is.
  177.  
  178.         Some sample help files (with the extension ".hlp") have been included.  Of
  179.      course, help files are only one possible use for the window; any type of file
  180.      may be loaded into it.
  181.  
  182.                                        USING THE MENUS
  183.  
  184.         To access the main menu press the Esc key.  You will be shown a list of
  185.      options.  To select one, just press the capitalized letter you see in that
  186.      option.  The main menu options are:
  187.  
  188.         Files - This takes you to the Files submenu which is:
  189.           * Load - Allows you to load a file.
  190.           * Save - Allows you to save the current file with the same name or with a
  191.           different name.  To save it with the same name just press enter when it
  192.           asks you for the filename, otherwise type in the name of the file and press
  193.           return.
  194.           * Rename - Allows you to change the name of a file on disk. If you want the
  195.           name of the file you are working on to be changed just press enter for the
  196.           old filename prompt then type in the new name for the new name prompt and
  197.           it will be changed.
  198.           * Erase - This allows you to delete the file you specify from the disk.
  199.  
  200. ACE                                                                        - Page 4 -
  201.  
  202.  
  203.           * Block - This takes you to the Block submenu which looks like this:
  204.              - Load - Allows you to load a file which is then marked as a block and
  205.                placed at the end of the current file.
  206.              - Save - Allows you to take a block you have defined and save it to a
  207.                file.
  208.           * Print - Allows you to print the file or block out on a printer with or
  209.           without line numbers.  It will print out the block if the cursor is within
  210.           the block otherwise it will print the entire file.
  211.           * sTatus - Shows you the file you are working on and the length of it in
  212.           bytes.
  213.           * Quit - allows you to quit the editor.
  214.           * Dos  - allows you to exit to dos and run another program or execute dos
  215.           commands while keeping ACE in memory.  Type EXIT at the dos prompt to return
  216.           to ACE.  (You must be using dos 2.0 or higher to use this function.)
  217.  
  218.      Search  - Takes you to a sub-menu where you instruct ACE to search for a string.
  219.      Replace - Sub-menu to search for a string and replace it with another string.
  220.      Goto    - Allows you to go to a line number or to a tagged position.
  221.      Tag     - Allows you to tag a line so that you can later go to it without having
  222.                to remember line numbers.
  223.      Version - Shows the name of the user and serial number.
  224.      Attributes - Allows you to change the attributes of the editor, color, block
  225.                   color, border color, etc.
  226.  
  227.                                         USING SEARCH
  228.  
  229.         When you select the search command your screen should look like this:
  230.  
  231.      Search string:
  232.      DIRECTION: Up  Down  CASE: Yes  No
  233.  
  234.         Some of the options should also be inside parentheses, meaning they are
  235.      selected.  The direction field is just the direction the search goes from the
  236.      cursor.  The case field specifies whether a string found in the text has to
  237.      match the search string exactly or if they can be somewhat different, for
  238.      example.  If you searched for Int with case set to yes, it would only find Int
  239.      not int.  If the case was set to no, it could find Int, int, iNt, INT, inT, etc.
  240.      Also you may place a question mark in the search field to represent any
  241.      character.  If you were to search for i?t it could find int, ibt, ict, izt, etc.
  242.  
  243.         To set a field, press ALT 1 before you type in any search text.  Now press
  244.      the capitalized letter(s) of the options you wish to select, and then press the
  245.      Esc key to resume typing the search text.
  246.  
  247.                                         USING REPLACE
  248.  
  249.         When you select the replace command your screen should look like this:
  250.  
  251.      Search string:
  252.      DIRECTION: Up Down  CASE: Yes  No  CONVERT TO: uPper  Lower  nEither
  253.      CONFIRM: yeS  nO
  254.  
  255.         The direction and case fields are the same as in search, but Convert and
  256.      Confirm are different.  Convert is used to change the case of letters.  If you
  257.      place a question mark in the replace text, then when ACE finds match, it will
  258.      convert the character in the same position of the question mark to upper case,
  259.      lower case, or not convert at all.  If you were to search for ? and replace with
  260.      ? and have convert set to upper case it would convert all the characters it
  261.      found to upper case.  If you have selected Confirm, ACE will ask you in each
  262.      instance whether or not to perform the replace before actually doing it.
  263.  
  264.                                    CHANGING THE ATTRIBUTES
  265.  
  266. ACE                                                                        - Page 5 -
  267.  
  268.  
  269.         The attributes window can be opened by selecting Attributes from the main
  270.      menu, or by pressing the F5 key.  After loading in the data file it should look
  271.      something like this:
  272.  
  273.                               ╔═════════════════════════════╗
  274.                               ║NORMAL TEXT COLOR          F ║
  275.                               ║BLOCK COLOR                70║
  276.                               ║END OF FILE COLOR          F0║
  277.                               ║CARRIAGE RETURN COLOR      7 ║
  278.                               ║BORDER COLOR               7 ║
  279.                               ║CARRIAGE RETURN CHARACTER    ║
  280.                               ║THUMB CHARACTER            ╫ ║(ASCII 215)
  281.                               ║END OF FILE CHARACTER       ║(ASCII 4)
  282.                               ║START UP INSERT (1/0)      1 ║
  283.                               ║TAB SIZE (0-8)             8 ║
  284.                               ║COLUMN START POS. (1/0)    1 ║
  285.                               ╚═════════════════════════════╝
  286.  
  287.         Shown are the default values for ACE.  The top five options are displayed in
  288.      HEX; these options control the colors that you see on your screen.  The next
  289.      three are characters that ACE will display on different parts of the screen.
  290.      The next is either a 1 or a 0.  The next is anything from 0 to 8, and the next
  291.      option is a 1 or a 0
  292.  
  293.         The hex attributes in the first five options can be determined by looking in
  294.      the BASIC manual under the color statement.  The first number is the background
  295.      color, which can be from 0 to F. The second number is the foreground color,
  296.      which can also be from 0 to F.  So if you want inverse, white on black, for an
  297.      option, you would type 70 for the field, meaning a background of 7 and a
  298.      foreground of 0.  The first option, text color, defines what normal text looks
  299.      like.  The second option, block color, defines what color blocks will be.  The
  300.      third, end of file color, defines what color the end of file mark will be.  The
  301.      fourth, carriage return color, defines what color the end of line mark will be.
  302.      The fourth option, border color, defines what color the border will be.
  303.  
  304.                            THE 15 POSSIBLE COLORS ARE:
  305.  
  306.      0 - BLACK           8 - GRAY
  307.      1 - BLUE            9 - LIGHT BLUE
  308.      2 - GREEN           A - LIGHT GREEN
  309.      3 - CYAN            B - LIGHT CYAN
  310.      4 - RED             C - LIGHT RED
  311.      5 - MAGENTA         D - LIGHT MAGENTA
  312.      6 - BROWN           E - YELLOW
  313.      7 - WHITE           F - HIGH INTENSITY WHITE
  314.  
  315.         The character attributes can be any one character.  The carriage return
  316.      character is what appears at the end of every line.  The thumb character is the
  317.      character ACE uses at the side of the window to represent your position in the
  318.      document.  The end of file character is the character that you see at the end of
  319.      the document.
  320.  
  321.         The next field, start up insert state, specifies what mode the cursor will be
  322.      in the next time you load ACE: 1 for insert; 0 for overtype.  The next field,
  323.      specifies the size of your tabs.  If you set it to 0, then ACE will just insert
  324.      the ASCII 9 character instead.  The last field, column start pos, specifies
  325.      whether line and col start at 0 or 1.
  326.  
  327.         When you finish typing in all the new values, they are all automatically
  328.      saved in a data file.  This data file is automatically saved when you quit also,
  329.      so you may not need to change the start up insert state field, for it will be
  330.      changed according to what mode you are in when you quit.
  331.  
  332. ACE                                                                        - Page 6 -
  333.  
  334.  
  335.                                WHAT THE CONTRIBUTION GETS YOU
  336.  
  337.         When you make a contribution of $35 or more you will become a registered
  338.      user, receive  the latest  version,  the  latest documentation, and notices of
  339.      new software and revisions from C-STUFF that can be sent to you upon request.
  340.      (Make sure to send your name, address, and phone number.)
  341.  
  342.         You may for $10 have me rewrite ACE for your particular language  (please
  343.      include details about your language, such as what remarks are delimited by, what
  344.      functions are delimited by, etc). Right now doing this would change the Alt R,
  345.      and the Alt B functions.  If you think this isn't worth the 10 dollars wait
  346.      until an upcoming version!  It will have many, awesome, excellent and fantastic
  347.      features to help you with your programming.  It's your choice though, to wait,
  348.      or do it now.  It's only 10 dollars!
  349.  
  350.         If you have any ideas or have found some bugs, please call or write me.  If I
  351.      like your idea or you have found a true bug, I will send you the latest public
  352.      version.  You may only get the LATEST version if you are a registered user, for
  353.      I will only upload a new version to bulletin boards once every 6 months.
  354.  
  355.      Note:  When you wish to have an update, send your name, address serial number
  356.      and $10 to cover for the disk and mailing.  You may only send ACE in for
  357.      rewriting if you are a registered user.
  358.  
  359.                                        COMMAND SUMMARY
  360.  
  361.      F1 - Repeats the last search or replace.
  362.          Alt F1 - Switches between windows.
  363.      F2 - Takes you to the Files option.
  364.          Alt F2 - Allows you to open or close a help window.
  365.      F3 - Search option.
  366.      F4 - Replace option.
  367.      F5 - Attributes option.
  368.      F6 - Starts/stops defining of block.
  369.      F7 - ** reserved for future use **
  370.      F8 - Print option.
  371.      F9 - Goto option.
  372.      F10 - Tag option.
  373.  
  374.      Alt E - Deletes the line that the cursor is on.
  375.      Alt O - Inserts a line below the cursor and positions the cursor under the first
  376.              non-space line.
  377.      Alt X - Allows you to enter any ASCII code. (can not enter code 254!)
  378.  
  379.      Block Commands:
  380.          Alt R - Places remarks around a block or a line.
  381.          Alt C - Copies the block to the cursor position.
  382.          Alt D - Deletes the block.
  383.          Alt M - Moves the block to the cursor position.
  384.          Alt L - Deletes the line the cursor is on and inserts the block.
  385.          Alt B - Deletes everything inside the nearest braces and inserts the block.
  386.  
  387.      -->                 - Cursor right.
  388.      <--                 - Cursor left.
  389.        (up arrow)       - Cursor up.
  390.        (down arrow)     - Cursor down.
  391.      Home                - Beginning of line.
  392.      End                 - End of line.
  393.      PgUp                - Page up.
  394.      PgDn                - Page Down.
  395.      --                 - Destructive backspace.
  396.      Ins                 - Toggle insert/overtype.
  397.  
  398. ACE                                                                        - Page 7 -
  399.  
  400.  
  401.      Del                 - Delete character.
  402.      Ctrl -->            - Word right.
  403.      Ctrl <--            - Word left.
  404.      Ctrl Home           - Top of window.
  405.      Ctrl End            - Bottom of window.
  406.      Ctrl Pg Up          - Beginning of file.
  407.      Ctrl Pg Dn          - End of File.
  408.  
  409.      Scroll Lock - Toggles special cursor movement mode:
  410.          --> (right arrow) - scroll right 4 X tab size.
  411.          <-- (left arrow)  - scroll left 4 X tab size.
  412.             (down arrow)  - scroll down half a screen.
  413.             (up arrow)    - scroll up half a screen.
  414.          Home              - move cursor to left edge of screen.
  415.          End               - move cursor to right edge of screen.
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463. «