home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / wp_dtp / qed021.lzh / qed_manu.doc < prev    next >
Text File  |  1989-11-29  |  49KB  |  1,089 lines

  1.  
  2.  
  3.  
  4.  
  5.                                      QED
  6.  
  7.                               AMIGA TEXT EDITOR
  8.  
  9.                      Copyright 1989 by Darren M. Greenwald
  10.  
  11.                               All rights reserved
  12.  
  13.  
  14.                              User's documentation
  15.                        Last revised 8/5/89  -  QED 0.20
  16.  
  17.      QED may be freely distributed.  It may not be distributed in any
  18. commercial product, shareware product, or commercial publication without
  19. permission.  It is permissible to release QED as part of a public domain
  20. collection, or on a telecommunication service as long as no "special
  21. charge" is made for this program; "special charge" does not include
  22. "reasonable" charges for replication of the media, or standard charges for
  23. use of the system. 
  24.  
  25.      The intent of the above should be clear - I did the work, and while
  26. you are allowed to freely distribute the program, you may not profit from
  27. it.
  28.  
  29.      Any archived files which the author distributes MUST be left intact. 
  30. If you do distribute this program, I insist that you distribute all the
  31. files including any notices.
  32.  
  33.      QED is SHAREWARE - the registration fee is $20, and in return you will
  34. receive complete documentation describing QED's command line language,
  35. ARexx interfacing, keyboard mapping, etc.
  36.  
  37.  
  38.      Darren M. Greenwald
  39.      2511 W. Sunflower Av. #D-16
  40.      Santa Ana, CA 92704
  41.  
  42.      GEnie E-MAIL address: DMG
  43.  
  44.  
  45. DISCLAIMER:
  46. ---------------------------------------------------------------------
  47.  
  48.      In no way can the author be held responsible for any damages, loss of
  49. anticipated profits, or any other perceived loss related to using this
  50. program.  The user assumes the entire risk, and responsibility when using
  51. this program.
  52.  
  53.  
  54.  
  55. TABLE OF CONTENTS
  56. ---------------------------------------------------------------------
  57.  
  58. Section i    .................. Introduction
  59. Section ii   .................. Registration
  60.  
  61. Section 1.0  .................. Starting QED
  62. Section 2.0  .................. QED Requesters
  63. Section 3.0  .................. Opening files
  64. Section 4.0  .................. Saving files
  65. Section 5.0  .................. Opening new windows
  66. Section 6.0  .................. Window options
  67. Section 7.0  .................. Positioning the cursor
  68. Section 8.0  .................. Basic editing keys
  69. Section 9.0  .................. Deleting text
  70. Section 10.0 .................. Block operations
  71. Section 11.0 .................. Search & Replace
  72. Section 12.0 .................. Formatting text
  73. Section 13.0 .................. Indenting text
  74. Section 14.0 .................. Miscellaneous features
  75. Section 15.0 .................. Command line mode, and ARexx macros
  76. Section 16.0 .................. Editing binary characters
  77. Section 17.0 .................. Printing
  78. Section 18.0 .................. Making QED resident (and QGO)
  79.  
  80.  
  81. Section i                INTRODUCTION TO QED
  82. =====================================================================
  83.  
  84.      QED is a fast, and easy to use general-purpose "text-editor".  There
  85. are no built-in limits on the number of windows which can be opened, file
  86. size, line length, or number if lines per file other then any memory
  87. limitations.  Memory is dynamically allocated, and deallocated through out
  88. the program, and memory is used in an efficient manner.  As you enter
  89. text, additional memory is automatically allocated as needed.
  90.  
  91.      QED allows you to work with multiple text editing buffers in the form
  92. of separate text editing windows.  Each new window requires a minimal
  93. amount of memory.  Data can be shared between text editing windows via
  94. cut, copy, and paste.  There is no significant performance penalty for
  95. working with multiple text editing windows.  Each text editing window can
  96. have unique editings options, settings, colors, etc.
  97.  
  98.      QED will work with non-proportional system fonts of any size with the
  99. understanding that fonts wider then Topaz 9, and/or taller then Topaz 11
  100. may be too large for use on a 640x200 Workbench screen.  This is because
  101. QED adjusts the size of the pull-down menus, and requesters to use your
  102. system font.  FastText (Copyright 1988 by Darren M. Greenwald) is built
  103. into the program.  "FastText" is a blitter based fast text rendering
  104. routine which will speed up rendering of fonts of any height, and from 4-16
  105. pixels wide.  QED also uses your system's keymap to decode the
  106. alpha-numeric keys (dead-keys too), and will work properly with over-sized
  107. Workbench screens.
  108.  
  109.      QED has extremely fast search, and replace capabilities.  A
  110. lightening fast formatter allows you to format a paragraph, or marked
  111. block text.  In fact many of QED's features can be limited to a marked
  112. block of text.  A full ARexx interface, and keyboard mapping is supported
  113. for the advanced users, while the full Intuition interface makes QED easy
  114. to use.
  115.  
  116.  
  117. Section ii                    REGISTRATION
  118. =====================================================================
  119.  
  120.      QED is SHAREWARE.  As of version 0.20, you can no longer save files
  121. larger then 10K bytes.  This has unfortunately become a necessity to
  122. encourage users to register.  My interest in this product is proportional
  123. to your support.  As a SHAREWARE product, QED is both inexpensive, and you
  124. have an opportunity to try before you buy.
  125.  
  126.      I am also focusing my attentions on providing features which
  127. registered users have requested.  I have now had too many non-paying users
  128. ask for new features which I added, and still have not received their
  129. registration fee.  My guess is that they have no intention of paying for
  130. software at any price.  Ever hear an Amiga user gripe that there is so
  131. little productivity software for the machine?  Perhaps this is why?
  132.  
  133.      Registered users will be shipped an uncrippled version of QED, as well
  134. as a simple method for deprotecting future releases of QED.  Periodically
  135. the deprotection method may be changed at which time I will send out a
  136. letter to registered users notifying them of the latest method in use. 
  137.  
  138.  
  139.      The registration fee is $20, and should be sent to:
  140.  
  141.                              Darren M. Greenwald
  142.  
  143.                          2511 W. Sunflower Av. #D-16
  144.                              Santa Ana, CA 92704
  145.  
  146.  
  147.      I would like to think that $20 is a very reasonable fee for software
  148. of this caliber.  The SHAREWARE method of distribution is less expensive
  149. then standard commercial distribution, and allows me to distribute updates
  150. quickly, and inexpensively.
  151.  
  152.      Please include your name, address, and if you would like, a GEnie
  153. E-MAIL address where you can be reached.  The registration fee may be
  154. increased in the future.
  155.  
  156.      I can also be contacted on GEnie, E-MAIL address "DMG".  You are also
  157. invited to stop by the Amiga Programmer's RoundTable (PRO-AM) page 670.
  158.  
  159.      Registered owners will also receive:
  160.  
  161.      1.) Documentation describing the built in command line language, and
  162.          advanced features which are only accessable via the command line
  163.          language (e.g. insert multiple lines).
  164.  
  165.      2.) Documentation explaining how to write ARexx macros for use with QED.
  166.  
  167.      3.) Documentation explaining how to configure QED via an ARexx
  168.          start-up macro.
  169.  
  170.      4.) Documentation explaining how to create macros which are
  171.          automatically executed when a file is opened (based on the file
  172.          name's extension).
  173.  
  174.      5.) Documentation explaining how to configure the keyboard, and
  175.          function keys to execute QED commands, DOS commands, and/or ARexx
  176.          macros.
  177.  
  178.      6.) Documentation explaining how to define your own user menu items
  179.          to execute any built in command, DOS command, or ARexx macros.
  180.  
  181.      These capabilities allow you to extend QED's features, and create a
  182. customized working environment.  If you don't already have ARexx, I highly
  183. recommend you purchase it.  ARexx is a copyrighted program by William S.
  184. Hawes.
  185.  
  186.      Unfortunately, I will not be able to send free software updates to
  187. registered users due to the cost of mailing, however, software updates will
  188. be made available to registered users for a nominal fee to cover mailing
  189. and material costs.
  190.  
  191.  
  192. Section 1.0                   STARTING QED
  193. =====================================================================
  194.  
  195.      It is assumed the user knows how to install QED on their system, or
  196. working disk.  QED is a stand alone program, and is easily copied to any
  197. destination directory; no special support libraries are required.  A small
  198. utility program called "QGO" is also provided which is needed if QED is
  199. run in its resident mode.
  200.  
  201.      By default, QED opens a single, un-named text editing window upon
  202. start up.  You may begin entering text immediately if you like, or open an
  203. existing file for editing.  ARexx owners have the option of creating a
  204. start up macro which will be automatically executed when QED is started. 
  205. All of QED's options, and capabilities can be accessed using the macro
  206. capability, so this is an excellent way to create a configuration file to
  207. set the various options up the way that you want.  Only registered users
  208. will receive documentation describing QED's built in command language, and
  209. how to write ARexx macros for use with QED. 
  210.  
  211.  
  212. Section 2.0                QED REQUESTERS
  213. =====================================================================
  214.  
  215.      At times QED will ask for a response from you in the form of a
  216. requester.  All QED requesters are opened in draggable windows, and the
  217. position of all requesters is remembered for the duration of the editing
  218. session.  Therefore you can place the requester windows where you want
  219. them, and they will be opened in the same position where you last left
  220. them.  The size of all requesters are adjusted (width & height) to use your
  221. system font.
  222.  
  223.  
  224.      The File Requester -
  225.      ------------------
  226.  
  227.      Amiga users should be relatively familiar with file requesters,
  228.      however it is worth noting the following:
  229.  
  230.      The QED file requester can display up to 8 files, or sub-directory
  231.      names.  Directory entries are sorted in non-case senstive order, and
  232.      displayed such that sub-directories take precedence over file names.
  233.  
  234.      The QED file requester does not make you wait for the directory to be
  235.      read before you can enter a file name, or change directories.
  236.  
  237.      QED's file requester makes it EASY to select a file, or sub-directory
  238.      name before the entire directory has been read.  First, you can
  239.      enter a new path name, or a file name before the entire directory
  240.      has been read.  Second, QED's file requester does not continually,
  241.      or periodically change the list of names on you until you drag the
  242.      scroll bar.  This means that you can actually single, or double click
  243.      on a name before the entire directory has been read, and not have
  244.      to worry about the list of names changing on you faster then you
  245.      can move the mouse! 
  246.  
  247.      The string gadget labeled "File:" is automatically activated, so it is
  248.      possible in some cases to enter a file name from the keyboard, and
  249.      press the RETURN key without ever touching the mouse.
  250.  
  251.      This file requester dynamically allocates, and deallocates memory as
  252.      needed for the directories; there is no built-in limit on the number
  253.      of directory entries that this requester can handle.
  254.  
  255.      A gadget labeled "TOGGLE:" allows you to toggle between a list of
  256.      devices in your system, and the directory list.  There is no built-in
  257.      limit on the number of devices which this requester can handle, and 
  258.      device names of up to 31 characters in length do not present a problem
  259.      as they do with some requesters.
  260.  
  261.      You may use the ARP file requester if you prefer (this option can be
  262.      set from the command mode, and requires the arp.library version 34 or
  263.      greater).
  264.  
  265.  
  266.      Input requesters -
  267.      ----------------
  268.  
  269.      Input requesters expect you to respond by typing in a number, or a
  270.      string of text.  Input requesters automatically activate the string
  271.      gadgets so often it is possible to respond by entering the
  272.      number or string(s), and pressing the RETURN key.  Of course you can
  273.      also respond using the mouse to select OK, or CANCEL.  If none of the 
  274.      string gadgets are activated, you can respond with the 'o' or 'c' keys 
  275.      on the keyboard.
  276.  
  277.      Notices & Queries -
  278.      -----------------
  279.  
  280.      Notices can only be responded to with an "OK" response, while queries
  281.      allow you to respond with an "OK" or "CANCEL" response.  If you
  282.      prefer, you can also respond to these requesters using the 'o' or 'c'
  283.      keys on the keyboard
  284.  
  285.  
  286. Section 3.0                   OPENING FILES
  287. =====================================================================
  288.  
  289.      QED allows you to OPEN, or INSERT existing files.  The difference is
  290. that opening a file replaces the text editing buffer, while inserting a
  291. file 'inserts' the file below the cursor position.  When opening a file,
  292. you will be prompted with a requester if you have made any changes to the
  293. text buffer being replaced.
  294.  
  295.      It is also possible to specify one, or more file names to be
  296. automatically opened in separate text editing windows when starting QED
  297. such as:
  298.  
  299. 1> run qed hello.c read_me "df0:my file"
  300.  
  301.      In the above example, QED will attempt to open the files named
  302. "hello.c", "read_me", and "df0:my file" in separate text editing windows. 
  303. If any of the above files are not found, then QED assumes you want to
  304. create a file of the same name, and opens an empty text editing window.
  305.  
  306.      QED is not suitable for use as a binary file editor because some
  307. binary characters are stripped, and converted to other characters when
  308. opening, or inserting a file.
  309.  
  310. Binary value         Action taken
  311. --------------------------------------------------------
  312. 11-255               Valid characters.  No stripping or conversion.
  313.  
  314. 10                   Linefeed - treated as an end of line character.
  315.  
  316. 9                    Tab - If "TAB = SPACES" under the "Options" menu is
  317.                      turned ON, then hard tabs are expanded to spaces
  318.                      when a file is opened, or inserted based upon the
  319.                      windows tab size setting which can be any value from
  320.                      1-8.  If "TAB = SPACES" is OFF (the default setting),
  321.                      then hard tabs are left in a file when opened, or
  322.                      inserted.
  323.  
  324. 1-8                  Valid characters.  No stripping or conversion.
  325.  
  326. 0                    Stripped at load time.
  327.  
  328.  
  329. Selecting "OPEN", or "INSERT" file under the "Project" will result in the
  330. file requester being displayed.
  331.  
  332.  
  333. Section 4.0                   SAVING FILES
  334. =====================================================================
  335.  
  336.      QED allows you to save the entire text editing buffer, or a marked
  337. block of text using the "SAVE AS" option under the "Project" menu.  The
  338. "SAVE AS" option causes the file requester to be displayed.  Named files
  339. can be quickly saved (if any changes have been made to the file) using the
  340. "SAVE" option under the "Project" menu.
  341.  
  342.      In order to save a marked block of text, highlight the block (see the
  343. section described later on how to mark blocks of text), and simply select
  344. "SAVE AS".  When mark block mode is on, it is implied that you want to save
  345. just the marked block of text.  When mark block mode is off, it is implied
  346. that you want to save the entire text editing buffer to a file.
  347.  
  348.      You have the option of creating a backup file under the "Options"
  349. menu.  When turned on, QED will rename any file which is going to be
  350. over-written as 'qed.backup' before saving the file.  This allows you an
  351. opportunity to recover the over-written file should you over-write a file
  352. by mistake.
  353.  
  354.      You also have the option of saving text to a file in append mode under
  355. the "Options" menu.  This capability is often handy when you want to save
  356. multiple blocks of text to a single file.  When this option is turned on,
  357. all text written to a file will be appended to the end of the file.  If the
  358. file does not exist, it will be created.
  359.  
  360.  
  361. Section 5.0                OPENING A NEW WINDOW
  362. =====================================================================
  363.  
  364.      QED supports multiple text editing buffers in the form of an unlimited
  365. number of text editing windows.  This is advantageous because you can see
  366. what each buffer holds, and edit any buffer.  There is no built-in limit
  367. on the number of windows which can be opened other then that which the
  368. operating system can handle, and memory limitations.  There is also no
  369. significant performance penalty for opening multiple windows other then
  370. that which is typical of the operating system when managing multiple
  371. windows on the Workbench screen.
  372.  
  373.      In order to open a new window, select "NEW" under the "Project" menu. 
  374. Note that the pull-down menus are accessable, and shared by all text
  375. editing windows.  It is also important to note that menu selections affect
  376. the window from which the menu item was selected.  For example, selecting
  377. "QUIT" from a window causes only that window to be closed.  When the last
  378. window is closed, QED is automatically terminated.
  379.  
  380.      The general layout of a QED text editing window is depicted by the
  381. diagram below:
  382.  
  383.        ------ File name           -------  Line/Column cursor position
  384.        |                          |
  385. ----------------------------------------------------------
  386. | QED - Untitled              L:     1  C:    20   |  |  |- Front/Back
  387. ----------------------------------------------------------
  388. |                                                      |_|- Top of file
  389. |                                                      |_|- Page up
  390. |                                                      | |
  391. |                                                      | |- Proportional
  392. |                      Text editing                    | |  slider gadget
  393. |                        work area                     | |
  394. |                                                      | |
  395. |                                                      | |
  396. |                                                      |_|
  397. |                                                      |_|-Page down
  398. |                                                      |_|-End of file
  399. |                                                      | |-Window size
  400. ----------------------------------------------------------
  401.  
  402.      You can define the default window size that QED will use to open a
  403. window upon startup, as well as any NEW windows opened via the pull-down
  404. menus.  This capability requires the use of the SETENV function provided as
  405. part of the 1.3 operating system.
  406.  
  407.      In order to use this function, assign ENV: to the RAM: disk, and
  408. use the SETENV command such as -
  409.  
  410. 1>setenv qedsize "0 20 300 100"
  411.  
  412.      Where the four parameters are left edge, top edge, width, and height
  413. in pixels.  If you enter any erroneous arguments, the window is opened to
  414. the full size of the WB screen a few pixels below the title bar.  Ideally
  415. you would make the assignment of the environment variable "qedsize" as part
  416. of your startup-sequence.
  417.  
  418.  
  419.  
  420. Section 6.0                WINDOW OPTIONS
  421. =====================================================================
  422.  
  423.      Each text editing window has its own private text editing buffer, and
  424. private characteristics including:
  425.  
  426.      Under the "Tools" menu
  427.      ----------------------
  428.  
  429.      Pen and paper colors -
  430.  
  431.           Pen, and paper colors can be toggled between 4 preset color
  432.      combinations by selecting "COLOR" under the "Tools" menu.  These
  433.      color combinations have been selected to also work properly using a
  434.      one bit-plane Workbench screen such as is possible using the
  435.      1008x800 monitor.
  436.  
  437.           From the command line mode it is also possible to set a specific
  438.      preset color combination, or any pen/paper color combination of your
  439.      choice.  Pen/Paper colors can be set from 0-255 should newer Amigas
  440.      offer more on-screen colors.
  441.  
  442.  
  443.      Tab size -
  444.  
  445.           The tab size can be set individually from 1-8 for each window
  446.      under the "Tools" menu, but by default is set to the proper value of
  447.      eight (8).  The tab size is used when calculating how many spaces to
  448.      insert when using soft tabs, and affects how hard tabs are displayed.
  449.  
  450.  
  451.      Right margin -
  452.  
  453.           The right margin can be set individually for each window under
  454.      the "Tools" menu.  The right margin setting is used by the formatter,
  455.      and word-wrap routine.  By default, the right margin is set to 75, but
  456.      can be set to any value from 8-10000.
  457.  
  458.           As an alternative, you can set the right margin to a value of one
  459.      (1) in which case the right margin is variable based on window, and
  460.      font width.  In this case the right margin is equivalent to the
  461.      maximum number of columns visible in the window.
  462.  
  463.      Show end of lines -
  464.  
  465.           Selecting "SHOW EOL" under the "Tools" menu toggles visible
  466.      end of line characters on/off.  The actual character used to represent
  467.      end of line characters can be set from the command mode.  The End Of
  468.      File (EOF) is displayed using a different character; once again the
  469.      actual character used can be set from the command mode.
  470.  
  471.      Show hard tabs -
  472.  
  473.          Selecting "SHOW TABS" under the "Tools" menu toggles visible
  474.      hard tabs on/off.  The actual character used to represent hard tabs
  475.      can be set from the command mode.
  476.  
  477.      Proportional gadget -
  478.  
  479.           Selecting "PROP GADGET" under the "Tools" menu toggles the
  480.      proportional slider gadget on/off.  This gadget is ghosted when off. 
  481.  
  482.           Note that the page up/down gadgets above, and below the
  483.      proportional gadget are more accurate then clicking above, or below
  484.      the proportional knob to move up/down a window page through a file.
  485.      Also note that when the proportional gadget is turned on, that
  486.      scrolling may slow down a bit due to the extra time required to
  487.      redraw the proportional gadget.
  488.  
  489.      Under the "Options" menu
  490.      ------------------------
  491.  
  492.      Overstrike mode -
  493.  
  494.           QED allows you to enter text in insert, or overstrike mode.
  495.  
  496.      Word wrap -
  497.  
  498.           QED will perform "simple" word-wrap when text is entered past the
  499.      right margin.  This feature should not be confused with the more
  500.      complex real-time paragraph reformatters typical of many word-
  501.      processors.
  502.  
  503.      Case sensitive search mode -
  504.  
  505.           QED allows you to search for text in case, or non-case sensitive
  506.      search modes.  When case sensitive mode is turned off, the alpha
  507.      characters (a-z and A-Z) are treated as equivalent.
  508.  
  509.           For example, you could enter "cat" as a search string, and
  510.      "cat", "CAT", "Cat", etc., would all be found when searching for
  511.      text, and/or when searching & replacing text.
  512.  
  513.      Append saves -
  514.  
  515.           This option allows you to save text to a file in append mode in
  516.      which case any text written to an existing file will be appended to
  517.      the end of the file.  This capability is often useful when marking
  518.      multiple blocks of text to be saved to single a file.
  519.  
  520.      Backup files -
  521.  
  522.           This option will cause any file which is going to be over-written
  523.      by a save operation to be renamed as "qed.backup" before saving the
  524.      file.  This allows you an opportunity to recover a file which is
  525.      inadvertently replaced by a save operation.  
  526.  
  527.      Mark line mode -
  528.  
  529.           When this option is turned on, you can only mark whole lines
  530.      of text to be cut, copied, saved, erased, formatted, replaced,
  531.      and printed.  The block, and project insert functions are also
  532.      affected.  When this options is turned on, a block of text which is
  533.      inserted from the clipboard, or a file will be inserted as a group of
  534.      lines above the cursor position.  This mode will most likely be
  535.      preferred by those working with line oriented text (e.g., programmers).
  536.  
  537.           When this option is turned off, you can mark a block of text
  538.      from any line/column position to any line/column position.  The block,
  539.      and project insert functions are also affected.  When this option is
  540.      turned off, a block of text which is inserted from the clipboard, or a
  541.      file will be inserted at the cursor position.  This mode will most
  542.      likely be preferred by those working with document oriented text.
  543.  
  544.  
  545.      Free form editing -
  546.  
  547.           This option affects the cursor's behavior.  When turned on, the
  548.      cursor can be positioned past the end of line allowing you to enter
  549.      text beyond the end of a line in which case spaces are automatically
  550.      inserted as needed.  This mode will most likely be preferred by those
  551.      working with line oriented text (e.g., programmers).
  552.  
  553.           When turned off, the cursor cannot be moved past the end of line.
  554.      The right cursor key is also affected; if you cursor right past the
  555.      end of a line, the cursor is wrapped to the first character of the
  556.      next line.  This mode will most likely be preferred by those working
  557.      with document oriented text.
  558.  
  559.      Insert tabs -
  560.  
  561.           This option affects how the TAB key behaves.  When turned off,
  562.      the tab key moves the cursor to the next tab stop.  When turned on,
  563.      the TAB key can be used to insert hard tabs, or an equivalent number
  564.      of spaces (see "Tabs equal to spaces" below).
  565.  
  566.      Tabs equal to spaces -
  567.  
  568.           This option affects how the TAB key behaves.  When turned on,
  569.      soft tabs (spaces) are used instead of hard tabs (binary 9).  This
  570.      option is checked for when you press the TAB key, when indenting
  571.      lines, and when a file is opened, or inserted (allowing you to de-tab
  572.      files at load time).
  573.  
  574.      When opening a new window, these characterstics are inherited from the
  575. window from which the "NEW" command was issued.  It is also possible to
  576. write macros which are automatically executed when a file is opened.  This
  577. capability is extremely useful for automatically adjusting the various
  578. window options listed above to suit the type of file you are working on.
  579.  
  580. For example, you might load a "C" source code file in one window, and have
  581. a macro which automatically sets your tab size to three (3), turns mark
  582. line mode on, turns free-form editing on, etc.
  583.  
  584. In another window you might then load a document file, and have a macro
  585. which automatically sets your tab size to five (5), turns mark line mode
  586. off, turns free-form editing off, etc.
  587.  
  588.  
  589. Section 7.0                CURSOR POSITIONING
  590. =====================================================================
  591.  
  592.      Like most text editors, QED allows you to insert, or over-strike text
  593. at the cursor position.  Perhaps the easiest way to position the cursor is
  594. with the mouse using the "point & click" method.  Of course the keyboard
  595. can be used to position the cursor using the cursor keys.
  596.  
  597.      Text scrolling is allowed in all directions, and can be accomplished
  598. via the cursor keys, or mouse using the "point & drag" method.
  599.  
  600.      It is also possible to go to a specific line number (see the "Cursor"
  601. menu), or mark & go to a spot.  Command line mode users have more cursor
  602. positioning tools available such as the ability to go to a specific line,
  603. and column position.
  604.  
  605.  
  606. Cursor key   |  Result
  607. ---------------------------------------------------------------------------
  608.              |
  609. Up           | Move the cursor up a single line.
  610.              |
  611. Down         | Move the cursor down a single line.
  612.              |
  613. Left         | Move the cursor left a single character.  If the cursor is
  614.              | at the beginning of a line, the cursor is wrapped up to the
  615.              | end of the previous line.
  616.              |
  617. Right        | Move the cursor right a single character.  If FREE FORM
  618.              | edit mode is turned OFF, the cursor will wrap to the next
  619.              | line if you cursor right past the end of a line.
  620.              |
  621. SHIFTED      | Move the cursor up a single window page.
  622. Up           |
  623.              |
  624. SHIFTED      | Move the cursor down a single window page.
  625. Down         |
  626.              |
  627. SHIFTED      | Move the cursor to the previous word.
  628. Left         |
  629.              |
  630. SHIFTED      | Move the cursor to the next word.
  631. Right        |
  632.              |
  633. ALT          | Move the cursor to the first line in the text editing
  634. Up           | buffer.
  635.              |
  636. ALT          | Move the cursor to the last line in the text editing buffer.
  637. Down         |
  638.              |
  639. ALT          | Move the cursor to the beginning of the line.
  640. Left         |
  641.              |
  642. ALT          | Move the cursor to the end of the line.
  643. Right        |
  644.              |
  645. CTRL         | Move the cursor to the top of the window.
  646. Up           |
  647.              |
  648. CTRL         | Move the cursor to the bottom of the window.
  649. Left         |
  650. ---------------------------------------------------------------------------
  651.  
  652.  
  653. Section 8.0                BASIC EDITING KEYS
  654. =====================================================================
  655.  
  656.  
  657. Keypress     |   Result
  658. ---------------------------------------------------------------------------
  659.              |
  660. RETURN       | Splits the line at the cursor position.  If the cursor
  661.              | is positioned beyond the end of the line, a new line is 
  662.              | inserted.
  663.              |
  664. ENTER        | Inserts a new line with AUTO-INDENT.
  665.              |
  666. DELETE       | Deletes the character under the cursor.  If FREE FORM EDIT
  667.              | is turned OFF, the DEL key will also delete end of line
  668.              | characters if the cursor is positioned on the end of a
  669.              | line.
  670.              |
  671. BACKSPACE    | Deletes the character to the left of the cursor.  If the 
  672.              | cursor is on the beginning of a line, the BACKSPACE key
  673.              | can be used to join the line with the previous line by
  674.              | effectively deleting the previous end-of-line character.
  675.              |
  676. TAB          | Moves the cursor to the next tab stop.  The tab size by 
  677.              | default is set to the proper tab value of 8, but can be
  678.              | set individually for each window.  You also have the option
  679.              | under the "Options" menu of having the tab key insert a
  680.              | sufficient number of spaces at the cursor position to move
  681.              | the cursor to the next tab stop, or to insert a hard tab.
  682.              |
  683. ---------------------------------------------------------------------------
  684.  
  685.  
  686. Section 9.0                DELETING TEXT
  687. =====================================================================
  688.  
  689.      At times you may want to delete larger pieces of text then is
  690. practical using the BACKSPACE, and DELETE keys described above.  QED
  691. provides a number of tools for deleting text listed under the "Edit" menu.
  692.  
  693.      Delete line -
  694.  
  695.           The entire line on which the cursor resides is deleted.
  696.  
  697.      Delete to end of line -
  698.  
  699.           Deletes all text from the cursor position to the end of the line.
  700.  
  701.      Delete word -
  702.  
  703.           Deletes the word on which the cursor resides.
  704.  
  705.      Undelete -
  706.  
  707.           Text which has been deleted using any of the above 3 functions is
  708.      copied to a 256 byte private backup buffer (one buffer per editing
  709.      window).  The last bit of deleted text (line, word, or end of line)
  710.      can be restored using the undelete command.
  711.  
  712.           QED will allow you to work with lines longer then 256 characters,
  713.      however to insure that you have an opportunity to undelete text, the
  714.      delete tools listed above will not work if the amount of text to be
  715.      deleted exceeds 256 characters.  In this case use the block cut, or
  716.      erase commands.
  717.  
  718.  
  719. Section 10.0                BLOCK OPERATIONS
  720. =====================================================================
  721.  
  722.      QED allows you to mark a block of text to be cut, or copied to a
  723. clipboard area which is used by all the text editing windows.  In addition,
  724. many of the QED commands can be restricted to a marked block of text (e.g.,
  725. SAVE AS, REPLACE, PRINT, FORMAT, etc.).
  726.  
  727.      Mark block mode can be toggled on/off from the pull-down menus under
  728. the "Edit" menu, or can be toggled on/off by "double-clicking" the left
  729. mouse button over the same row/column position.
  730.  
  731.      Mark block mode is transparent; you can continue to edit text like
  732. usual, and the pull-down menus are always accessable.  In order to mark a
  733. block of text, simply toggle mark block mode on, and use the cursor keys,
  734. or mouse to highlight a range of text.
  735.  
  736.      As indicated above, you have the option under the "Options" menu of
  737. toggling between line mark mode (always marks whole lines), or free form
  738. mark mode (allows you to mark from/to any row/column position).
  739.  
  740.      In the free form mark block mode, the last character marked in a block
  741. is excluded; this makes complete sense in actual use as it allows you to
  742. position the cursor at the beginning of a line, and cursor up/down one
  743. line to mark the line without including the first character of the
  744. next line.
  745.  
  746.      Both the CUT, and COPY block tools under the "Edit" menu copy
  747. the marked block of text to the clipboard, however CUT block also deletes
  748. the text.
  749.  
  750.      In some cases you may want to cut a block of text, but you don't
  751. want it copied to the clipboard.  In this case use the ERASE tool under the
  752. "Project" menu.  ERASE will erase all text in a text editing window, and
  753. free any up any memory that it can, however if mark block mode is on, the
  754. ERASE function will only erase the marked block.  In either case you will
  755. be prompted with a requester because any erased text cannot be restored.
  756.  
  757.      INSERT block under the "Edit" menu inserts whatever is in the clipboard
  758. at the cursor position.  If MARK LINE MODE is ON, the contents of clipboard
  759. will be inserted as a group of lines above the cursor position.  If MARK
  760. LINE MODE is OFF, the contents of the clipboard will be inserted at the
  761. cursor position.
  762.  
  763.  
  764. Section 11.0                SEARCH & REPLACE
  765. =====================================================================
  766.  
  767.      The SEARCH, REPLACE, and HUNT tools under the "Tools" menu allow you
  768. to search for a phrase, replace a phrase, and quickly repeat the last
  769. search and/or replace operation.
  770.  
  771.      As indicated above, QED supports both case, and non-case sensitive
  772. search modes, and can be optionally set for each text editing window.
  773.  
  774.      Both SEARCH, and REPLACE will prompt you for strings using a
  775. requester.  Both commands will search forward from the cursor position for
  776. a matching search string, and position the cursor on the first occurrance
  777. of the search string if a match was found.
  778.  
  779.      When using the REPLACE command, you will also be prompted with a
  780. message in the title bar of the window such as:
  781.  
  782.      Replace? (Y)es (N)o (G)lobal (M)arked (Q)uit
  783.  
  784.      You may respond using the upper, or lower case keys on the keyboard
  785.      where (?) causes the following action to be taken:
  786.  
  787.      (Y)es    - Yes, replace the string with the search string, and
  788.                 continue searching.
  789.  
  790.      (N)o     - No, don't replace the string, and continue searching.
  791.  
  792.      (G)lobal - Replace all occurrences of the search string forward from
  793.                 the cursor position.
  794.  
  795.      (M)arked - Replace all occurrences of the search string found within
  796.                 a marked block.  In order to use this option, you must
  797.                 first mark a block of text.
  798.  
  799.      (Q)uit   - Quit searching.  You may also click in the window with
  800.                 the LEFT mouse button to abort the search.
  801.  
  802.      In order to search, and replace on 'end-of-line' characters, simply
  803. use the CTRL-J character in your search, and replace strings to denote
  804. 'end-of-line' characters.  CTRL-J is equivalent to a binary value of 10;
  805. also known as a LINEFEED.  Other control key sequences as listed in Section
  806. 16.0 below may also be used in your search strings as needed.
  807.  
  808.      The HUNT command can be used to repeat the last SEARCH, and/or REPLACE
  809. operation.  When using the HUNT command, searches will skip the character
  810. under the cursor to avoid finding duplicate matches of a string.
  811.  
  812.      
  813. Section 12.0                FORMATTING TEXT
  814. =====================================================================
  815.  
  816.      The FORMAT tool under the "Tools" menu allows you to format a
  817. paragraph, or a marked block of text.
  818.  
  819.      If mark block mode is off, then FORMAT searches forward from the line
  820. on which the cursor resides for two (2) consecutive end of line characters.
  821.  The following illustration may be helpful in better understand how the
  822. FORMAT tool works.
  823.  
  824. Let's suppose the original piece of text looks like this:
  825. --------------------------------------------------------
  826.  
  827. This is some text to demonstrate a point.
  828.  
  829. This is some more text.
  830.  
  831.  
  832. This is how the text is evaluated by the FORMAT command:
  833. -------------------------------------------------------
  834.            _________________________________Cursor position column 11.
  835.           |
  836.           |          _______________________Wrapping will occur here.
  837.           |         |
  838.           |         |    ___________________Right margin is 25.
  839.           |         |   |
  840.           |         |   |        ___________Column 33 is > right margin.
  841.           |         |   |       |
  842. This is some text to demonstrate a point. - This line of text is terminated
  843.                                           - by 2 end-of-line characters.
  844. This is some more text
  845.  
  846.  
  847. This is the result after using the FORMAT command:
  848. -------------------------------------------------
  849.  
  850. This is some text to
  851. demonstrate a point.
  852.  
  853. This is some more text.
  854.  
  855.  
  856.      FORMAT will never insert, or delete any spaces.  What it will do is
  857. replace spaces with end-of-line characters, and vice-versa in an attempt to
  858. cause the affected text to fit in the right margin setting with word-wrap.
  859.  
  860.  
  861. Section 13.0                INDENTING TEXT
  862. =====================================================================
  863.  
  864.      Programmers who work with block oriented languages frequently find
  865. themselves indenting sections of source code left, and right.  Often this
  866. can mean manually deleting, and/or inserting spaces or tabs.  QED provides
  867. a tool which allows you to easily indent a line, or a range of lines to the
  868. next left or right tab position.
  869.  
  870.      Under the "Tools" menu, you have the option of indenting the current
  871. line left, or right to the next tab stop, or indenting multiple lines.  If
  872. you choose the INDENT MULTIPLE tool, you will be prompted with a message in
  873. the window's title bar such as:
  874.  
  875.      Indent? (R)ight (L)eft (S)kip ([) (]) (Q)uit
  876.  
  877.      You may respond using the upper, or lower case keys on the keyboard
  878.      where (?) causes the following action to be taken:
  879.  
  880.      (R)ight - Indent line right, and move cursor to the next line.
  881.  
  882.      (L)eft  - Indent line left, and move cursor to the next line.
  883.  
  884.      (S)kip  - Skip the line, and move cursor to the next line.
  885.  
  886.      ([)     - Indent line left, and don't move the cursor.
  887.  
  888.      (])     - Indent line right, and don't move the cursor.
  889.  
  890.      (Q)uit  - Abort multiple indent utility.  You may also click in the
  891.                window with the LEFT mouse button to quit.
  892.  
  893.  
  894. The INDENT MULTIPLE tool is extremely useful when you wish to change the
  895. indent of a range of lines.  Place the cursor at the top line of the range
  896. you want to change, and repeatedly use the (R), or (L) keys.  You can also
  897. skip lines you dont want changed, and adjust each line individually using
  898. the ([), and (]) keys.
  899.  
  900. You have the option of indenting lines using hard tabs, or soft tabs
  901. (spaces).  If "TAB = SPACES" is turned ON under the "Options" menu, soft
  902. tabs will be used when indenting lines.  If "TAB = SPACES" is turned OFF,
  903. then hard tabs will be used.
  904.  
  905.  
  906. Section 14.0             MISCELLANEOUS FEATURES
  907. =====================================================================
  908.  
  909.      QED allows you to assign any built in QED command, ARexx macro, and
  910. any DOS command to ANY key when pressed alone (including the FUNCTION
  911. keys), or to ANY key when pressed in conjunction with the CTRL, ALT, or
  912. SHIFT keys.  In order to use this capability you will need the Registered
  913. User's Documentation.
  914.  
  915.      The ALT keys can be mapped to imitate the RIGHT AMIGA key menu
  916. alternatives listed in the pull-down menus using a single command from
  917. the command mode, or in an ARexx macro.  For those of you who are
  918. uncomfortable with using the RIGHT AMIGA key, this allows you to use
  919. either the left, or right ALT keys.
  920.  
  921.      Even though there is no "NEW CLI" command in the pull-down menus, the
  922. CTRL/HELP key combination is by default mapped to open a new CLI window.
  923.  
  924.      If you own Brian Jackson's ACK terminal program for the Amiga, you can
  925. mark blocks of text to be sent to ACK via a message port just as if you had
  926. typed the text directly, or sent an ASCII file.  In order to do this,
  927. simply mark a block of text that you want to send, and press CTRL "`". 
  928. Remember that if this does not suit your taste, you can remap the keyboard
  929. as mentioned above.  Only the Amiga makes it possible!
  930.  
  931.      Brian Jackson can be reached on GEnie: E-MAIL address "B.J."
  932.  
  933.      The ERASE function under the "Project" menu will clear, and reset the
  934. text editing buffer as described under section 10.0 above.
  935.  
  936.      The JOIN command under the "Edit" menu will join the line on which the
  937. cursor resides with the previous line.  Joining lines can also be
  938. accomplished by back spacing over the previous end of line character as
  939. described under section 8.0 above.
  940.  
  941.      The MARK SPOT, and GOTO SPOT commands under the "Edit" menu can be
  942. used to mark spot, and quickly return to the same position later, however
  943. the spot may be lost when using the global replace capabilities, or if you
  944. delete the text corresponding to the marked spot.
  945.  
  946.      QED has a built-in keyboard repeat limiting feature which will only
  947. limit repeating key press messages if QED cannot keep up (e.g., during
  948. heavy multi-tasking).  If you have ever used an Amiga program in which you
  949. inadvertently held down a repeating key such as the BACKSPACE key too long,
  950. and watched your last 10 minutes of work be erased, you will appreciate
  951. this feature.
  952.  
  953.      You can quickly move between multiple windows opened with the NEW
  954. command by using the "NEXT", and "PREV" items under the "Project" menu.  If
  955. you have more then one window open, these two items will bring the next, or
  956. previous window to front, and activate as if you had clicked in it with the
  957. mouse. 
  958.  
  959.  
  960. Section 15.0         THE COMMAND LINE MODE & AREXX MACROS
  961. =====================================================================
  962.  
  963.      The "CMD LINE" command under the "Tools" menu causes the command line
  964. window to be opened (if its not already), and assigns the command line
  965. window to the text editing window from which this command was issued.  As
  966. an alternative, you can use the ESC key.  The command line mode allows you
  967. to enter commands, and execute/debug ARexx macros.  Any command which can
  968. be performed using the pull-down menus, or keyboard can be accomplished
  969. from the command line mode, and much more...
  970.  
  971.      The command line mode allows you to perform all of the functions
  972. available in the pull-down menus, execute ARexx macros, and more.  In order
  973. to use this capability you will need the Registered User's Documentation. 
  974.  
  975.      The "RUN MACRO" command under the "Tools" menu will list, and allow you
  976. to execute all ARexx macros in your REXX: directory.
  977.  
  978.  
  979. Section 16.0            EDITING BINARY CHARACTERS
  980. =====================================================================
  981.  
  982.      QED is a text editor, so binary file editing is not fully supported,
  983. however you can open, display, edit, and save most of the binary character
  984. set other then binary 0.  This capability should provide sufficient for
  985. those who would like to insert ANSI, or printer device control sequences in
  986. their files.
  987.  
  988.      QED utilizes your system font, and it is worth noting that AMIGA fonts
  989. generally do not contain character definitions for the complete binary
  990. character set 0-255.  Most system fonts only have character imagery for
  991. binary 32-255, and possibly a smaller subset of characters.  Undefined
  992. characters are displayed using a default image (generally a box).
  993.  
  994.      In order to compensate, QED will display the characters "A" through
  995. "_" in inverted imagery to represent binary 1-31.
  996.  
  997.      You can also enter these characters from the keyboard by holding down
  998. the CTRL key, and pressing the following keys on the keyboard:
  999.  
  1000.      a = binary 1                  q = binary 17
  1001.      b = binary 2                  r = binary 18
  1002.      c = binary 3                  s = binary 19
  1003.      d = binary 4                  t = binary 20
  1004.      e = binary 5                  u = binary 21
  1005.      f = binary 6                  v = binary 22
  1006.      g = binary 7                  w = binary 23
  1007.      h = binary 8                  x = binary 24
  1008.      i = binary 9  (Hard tab)      y = binary 25
  1009.      j = binary 10 (Line feed)     z = binary 26
  1010.      k = binary 11                 [ = binary 27
  1011.      l = binary 12                 \ = binary 28
  1012.      m = binary 13 (Cairrage ret)  ] = binary 29
  1013.      n = binary 14                 ^ = binary 30 (CTRL SHIFTED 6)
  1014.      o = binary 15                 _ = binary 31 (CTRL SHIFTED -)
  1015.      p = binary 16
  1016.  
  1017.      The above sequences rely on the standard operating system routines to
  1018. decode the keyboard, however you can assign key values to any keyboard
  1019. combination of your choice from the command mode.  Of course you can also
  1020. assign whole strings of text which may include binary control sequences to
  1021. a key press combination.
  1022.  
  1023.  
  1024. Section 17.0                  PRINTING
  1025. =====================================================================
  1026.  
  1027.      QED allows you to print the entire contents of a windows text editing
  1028. buffer, or a marked block of text (if a block is marked).  Simply select
  1029. PRINT from the pull down menus, and respond to the requester verifying that
  1030. you want to print.  Printing occurs as a background task, and does not
  1031. interfere with any other QED features.  You may even quit QED while
  1032. printing is still in process.  In this case QED will release as much
  1033. memory as it can, and will hang around in a wait state until the printer is
  1034. done before fully exiting.
  1035.  
  1036.      If you select PRINT again while the printer is busy, you will be
  1037. prompted with a requester asking if you want to cancel the current print
  1038. job.  If you elect to cancel printing, printing will stop as soon as
  1039. possible.  If you are using a printer buffer, then of course it may be
  1040. necessary to turn the buffer, or printer off to flush the buffer. 
  1041.  
  1042.  
  1043. Section 18.0             MAKING QED RESIDENT
  1044. =====================================================================
  1045.  
  1046.      QED can be started in "resident" mode by including "-r" (no quotes) as
  1047. the first argument on the command line.  This mode will force QED to hang
  1048. around in memory until awakened by another small utility program provided
  1049. with QED.
  1050.  
  1051.      Normally when you load QED from disk, or from ram disk, QED will exit
  1052. when the last text editing window is closed freeing up all the memory used
  1053. by QED.  If you run, and exit QED frequently, this means that QED must be
  1054. reloaded each time.  Many users place commonly used programs in a ram disk;
  1055. this avoids the delays of reloading a program from floppy, or hard drive,
  1056. but still means that the program must be copied from ram disk to another
  1057. section of memory before being run.
  1058.  
  1059.      QED's resident mode allows you to keep a "single" copy of QED hanging
  1060. around in memory at all times.  This is more efficient then run QED from a
  1061. ram disk, and faster then reloading QED from a floppy, or hard drive.
  1062.  
  1063.      Remember that QED allows you to open an unlimited number of text
  1064. editing windows, that there is no significant performance penalty for
  1065. opening multiple windows, and that this is much more efficient then running
  1066. multiple copies of QED to edit separate files.  You can still run QED as
  1067. separate tasks if desired, however only one copy of QED can be made
  1068. resident, and in most cases one copy of QED is sufficient to handle your
  1069. multi-file editing needs.  
  1070.  
  1071.      If QED is started in resident mode using the "-r" flag, by default no
  1072. text editing windows, or files will be opened.  You can still include a
  1073. list of file names following this command line flag to be automatically
  1074. loaded into separate text editing windows.  See section 3.0 for details on
  1075. specifying a list of files to be opened as CLI arguments.
  1076.  
  1077.      A small utility program has been provided called "QGO" which will send
  1078. the necessary commands to a resident QED task to open new QED windows,
  1079. files, etc.  In fact "QGO" behaves much like QED in that you can specify a
  1080. list of files names to be automatically opened in separate text editing
  1081. windows.  If no file names are included as CLI arguments, "QGO" will send
  1082. the necessary commands to QED to open a single, un-named text editing
  1083. window.
  1084.  
  1085.      Finally "QGO" can also send a command to QED to turn resident mode
  1086. off, in which case QED will be fully exited once the last window is closed.
  1087.  In order to do this, simple include "-q" as the first CLI argument when
  1088. using the "QGO" program.
  1089.