home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / tools / read.me < prev    next >
Encoding:
Text File  |  1990-02-25  |  18.8 KB  |  512 lines

  1.                 Welcome to QEdit Advanced - version 2.1
  2.  
  3. This is a licensed, commercial version of QEdit Advanced v2.1.  Please
  4. help us stay in business by respecting our copyright and keeping this
  5. version private. Also, be sure to return the postage-paid registration
  6. card that came with your package.  That is the only way we have of
  7. making sure that your name is in our database, without which you will
  8. not receive update notices (and discounts!) and technical support.
  9.  
  10. Is this a borrowed copy of this software?  If so, then please consider
  11. ordering your own personal copy, or persuading your company to purchase
  12. a license for it.  QEdit has taken many work years, and hundreds of
  13. thousands of dollars, to develop and produce. Yet, QEdit is very
  14. reasonably priced, and we also offer attractive multi-user site
  15. licenses.
  16.  
  17. There is also a shareware version of QEdit. This is *NOT* that version.
  18.  
  19. Please review the contents of this file before using QEdit.  It contains
  20. helpful information on the operation of QEdit and how to get assistance
  21. when you need it.  The Release Notes for version 2.1 (section 3) contain
  22. an explanation of all features and changes in this release and some
  23. additional features not documented in the 2.1 addendum.
  24.  
  25. Late-breaking news:
  26. ------------------------------------------------------------------------
  27. QEdit TSR is now available!  For those of you who would like to have
  28. access to your favorite editor at virtually anytime, in the middle of
  29. anything else, we at SemWare are proud to offer you QEdit TSR v1.1.
  30. Please call SemWare for details.
  31.  
  32. ------------------------------------------------------------------------
  33. QEdit is the winner of the Data Based Advisor Reader's Choice Award for
  34. best text or program editor of 1989.  We thank our users for this vote
  35. of confidence and their continued support!
  36.  
  37. ------------------------------------------------------------------------
  38. QEdit for OS/2 is now available.  If you'd like to have THE FASTEST
  39. editor available for OS/2, give SemWare a call!
  40.  
  41. ------------------------------------------------------------------------
  42. There is now a special German version of QEdit available.  It is based
  43. on version 2.1 of QEdit.  All text displayed by the program (including
  44. the status line!) is in German;  plus the reference manual was
  45. painstakingly translated by a native German.  For information on
  46. ordering the German version you can give SemWare a call, or if you
  47. prefer, you can call our German distributor directly at: 49-761-87419.
  48. Ask to speak to Manfred Luft.
  49.  
  50. ------------------------------------------------------------------------
  51.  
  52. Contents
  53. --------
  54.  
  55.     I   Contents of QEdit Distribution Disk
  56.     II  Technical Support
  57.     III Version 2.1 - Release Notes - February, 1990
  58.     IV  Various Keyboard Definition Files Supplied
  59.  
  60.  
  61.  
  62. I   Contents of QEdit Distribution Disk
  63. ---------------------------------------
  64.  
  65.     File            Description
  66.     ------------    ----------------------------------------------------
  67.  
  68.     Q.EXE           The editor program.  This is the only file required
  69.                     to run QEdit.
  70.  
  71.     QCONFIG.EXE     The configuration program.
  72.     QCONFIG.DAT     The default Keyboard Definition File.
  73.     QHELP.TXT       The default Help text.
  74.     READ.ME         The file you are currently reading.
  75.  
  76.       Keyboard Definition Files for the following editors are provided:
  77.  
  78.     QCONFIG.B       Brief 2.1
  79.     QCONFIG.NE      Norton Editor 1.3
  80.     QCONFIG.PE2     PE II
  81.     QCONFIG.WP      WordPerfect 5
  82.     QCONFIG.WS      WordStar 3.3 / SideKick 1.5
  83.  
  84.       Help files for the above:
  85.  
  86.     QHELP.NE
  87.     QHELP.PE2
  88.     QHELP.WP
  89.     QHELP.WS
  90.  
  91.     QUPDATE.EXE     Will copy the configuration information from QEdit
  92.                     versions 2.07 ,2.07A, or 2.08 to 2.1.  Just run
  93.                     QUPDATE and follow the prompts. If you are NOT
  94.                     upgrading from 2.07, 2.07A or 2.1, you don't need
  95.                     this file.
  96.  
  97.     QDISK.EXE       Run QDISK to obtain the amount of available memory
  98.                     and space on the current drive.
  99.  
  100.     SHOWKEY.EXE     Displays the scancode for extended keys.
  101.     CHUNKER.EXE     Splits large files into chunks for editing by QEdit.
  102.                     Will also merge these chunks back into a single
  103.                     file.
  104.  
  105.     ATKYFAST.COM    This program will speed up the keyboard response
  106.                     time on AT and 386 style computers.  It is NOT a
  107.                     TSR.  Just type ATKYFAST.  Note that this program
  108.                     will not work on all clones, but it will not cause
  109.                     any problems on them either.
  110.  
  111.     QMAC.EXE        Macro translator for QEdit.
  112.     QMAC.DOC        Macro translator documentation.
  113.  
  114.     The following files are courtesy of Karl Brendel, author of QFonEdit
  115.     and ProFonEdit.
  116.  
  117.     MACROS.MIS      Sample macros.
  118.     MACROS.PAS      Sample macros for Pascal programming.
  119.  
  120.     The following files are courtesy of Jerry Houston.
  121.  
  122.     QM.COM          Mouse driver for QEdit.
  123.     QM.DOC          Mouse driver documentation.
  124.  
  125.  
  126.     Notes
  127.     -----
  128.  
  129.     Other product names are trademarks or registered trademarks of their
  130.     respective holders.
  131.  
  132.     The ONLY file required to run QEdit is Q.EXE - the others are not
  133.     required or used by the program.
  134.  
  135.     QEdit comes pre-configured to work on a large range of monitors.
  136.     Because of this, the default colors are set up for a monochrome
  137.     system. If you have a color system and would like to edit in color,
  138.     then run the configuration program (QCONFIG), select the
  139.     C)olors/screen options, and change the default colors.
  140.  
  141.     NOTE:  We do NOT release patch files for QEdit, under any
  142.            circumstances. We release only fully-executable files.  If
  143.            you encounter a "patch" or "modification" file that modifies
  144.            your Q.EXE file, be aware that it does not originate from us,
  145.            and we cannot be responsible for the behavior of a patched
  146.            QEdit.  The only program you should use to modify your copy
  147.            of Q.EXE, is the QCONFIG program that came with it. Keep this
  148.            in mind when calling for technical support.
  149.  
  150.     Please, make sure you read this entire file to take full advantage
  151.     of the new commands/features in QEdit.
  152.  
  153.  
  154. II  Technical Support
  155. ---------------------
  156.  
  157. Due to the tremendous popularity of QEdit, we can give technical support
  158. ONLY to registered QEdit users.  Please have your QEdit SERIAL NUMBER
  159. handy when you call.
  160.  
  161.     Please!  Before you call us with a problem, make sure you have read
  162.     this entire READ.ME file to determine if it solves your problem.  If
  163.     you should have to contact us, please provide or have available the
  164.     following information:
  165.  
  166.         QEdit version number, date of Q.EXE on the original diskette,
  167.           and serial number
  168.         DOS version
  169.         Computer model
  170.         Amount of RAM
  171.         Whether you are using a hard disk or floppy disk based PC
  172.         The names of any memory-resident programs you have loaded
  173.  
  174.  
  175.     You may obtain technical support directly from SemWare as follows:
  176.  
  177.         1.  Call our remote electronic bulletin board service.  The
  178.             board is operational 24 hours a day, 7 days a week.  Modem
  179.             settings are <N81>, 9600 HST, 2400 or 1200 baud.  The
  180.             telephone number is: (404) 641-8968.
  181.  
  182.         2.  Write us at: (We've moved!)
  183.  
  184.                          SemWare
  185.                          Technical Support
  186.                          4343 Shallowford Rd., Suite C-3
  187.                          Marietta, GA  30062-5003
  188.  
  189.         3.  Send Compuserve E-Mail to userid 71520,67
  190.  
  191.         4.  Call us directly at SemWare, (404) 641-9002. Support hours
  192.             are 9 am to 5 pm (ET), Monday through Friday.
  193.  
  194.         5.  Send us a Fax at: (404) 640-6213
  195.  
  196.     SemWare is committed to supporting registered users.  However, we
  197.     request that you reserve telephone support only for questions or
  198.     problems requiring immediate attention.
  199.  
  200.     As always, if you have a suggestion that you think would improve our
  201.     product, don't hesitate to let us know.
  202.  
  203.     By the way, SemWare has grown!  We now have eight full-time people
  204.     on staff to help serve you better, and we have also moved to larger
  205.     facilities.
  206.  
  207. III Version 2.1 - Release Notes - February, 1990
  208. ------------------------------------------------
  209.  
  210. 2.1 summary of changes:
  211. -----------------------
  212.  
  213. QCONFIG:
  214. --------
  215.  
  216.  Deletions:
  217.  
  218.    "number of rows on physical screen option" has been removed.  QEdit
  219.    now retrieves this information from the bios data area, so this option
  220.    is no longer needed.
  221.  
  222.    "go to line number on command line option" has been removed. This has
  223.    been replaced with a command line option.
  224.  
  225.  Additions:
  226.  
  227.   Under Advanced options:
  228.  
  229.     "Swap to Expanded memory or DISK on Dos and Shell commands?"
  230.     "Drive to use for disk swapping [A..Z] *=default-drive ?"
  231.     "Should the editor restore the starting drive/dir on program exit?"
  232.     "Should the editor change the DOS PROMPT during a shell?"
  233.     "Should [TabRt]/[TabLt] be allowed to shift an entire block?"
  234.  
  235.   Under general options:
  236.  
  237.     "Do you want the bell to sound on warning messages and missed
  238.     searches?"
  239.  
  240.   Under printer options:
  241.  
  242.     "Default top margin for printing [0..100]?"
  243.     "Default bottom margin for printing [0..100]?"
  244.  
  245. QEdit CHANGES:
  246. --------------
  247.  
  248. New command line option:
  249.  
  250.   -n command line option.  For example:
  251.      q filename -n36
  252.   goes to line 36 in filename after initial load.
  253.  
  254. Operational changes:
  255.  
  256.   The [Dos] and [Shell] commands can now optionally swap QEdit out to
  257.   disk or EMS leaving only a 2k kernel in memory, thus allowing much
  258.   more memory for running memory-hungry programs from QEdit, especially
  259.   compilers.  This option is configurable via QCONFIG as well as
  260.   interactively using the [ToggleSwap] command, found on the "Other"
  261.   pulldown menu.
  262.  
  263.   Once in the shell, QEdit will optionally append "[QE]" to the DOS
  264.   prompt string, provided that:
  265.  
  266.   1) You have defined the prompt environment variable.
  267.   2) There is enough space left in the environment.
  268.   3) You have set the "Change DOS PROMPT during a Shell" option to
  269.      [Y]es.  See QCONFIG, under Advanced options.
  270.  
  271.   If you have NOT defined the prompt environment variable, then we
  272.   suggest you do so.  It is helpful with DOS command line operations in
  273.   general. A suggested prompt is (this should go in your AUTOEXEC.BAT
  274.   file):
  275.  
  276.   set prompt=$p $t $g
  277.  
  278.   If you do have a prompt string defined, but you do not get the "[QE]"
  279.   prompt in the QEdit shell, add the following to your AUTOEXEC.BAT:
  280.  
  281.   set x=x
  282.  
  283.   ----------------------------------------------------------------------
  284.  
  285.   Column blocks can now be deleted [DeleteBlock] <Alt G>, printed
  286.   [PrintBlock] <Esc><PB>, and written [WriteBlock] <Alt W> to disk.
  287.  
  288.   [TabRt]/[TabLt] when pressed while the cursor is inside a marked
  289.   block and insert mode is on, shifts the entire block by the current
  290.   cursor tab width.
  291.  
  292.   The window resize command allows up and down movement, instead of only
  293.   up or only down.
  294.  
  295.   .cpp, .hpp, .cxx, .hxx have been added to the list of valid C Mode
  296.   file extensions.
  297.  
  298.   Prompt boxes show prompt strings in the block attribute while they
  299.   will be overwritten when a character is typed; once a character or
  300.   editing key has been typed, prompt strings revert back to their
  301.   default color.
  302.  
  303.   [CurrentFilename] is now available outside of prompt boxes. In
  304.   previous versions, the [CurrentFilename] command was active only
  305.   during a QEdit prompt box.  This command now functions while editing,
  306.   too.
  307.  
  308. Find/Replace command changes:
  309.  
  310.   "L" option added to [Find], [FindReplace].  Limits the
  311.   Find/FindReplace to the currently marked block.  If the cursor is
  312.   outside the marked block, or the "G" option is also selected, the
  313.   search starts at the beginning of the block.  Otherwise, the search
  314.   starts at the current cursor position inside the block.
  315.  
  316.   "G" option in [Find], [FindReplace] now works as it does in WordStar
  317.   and the Borland editors; i.e., it starts the search at the beginning
  318.   of the file.
  319.  
  320.   In [FindReplace] you can now enter a number to limit the number of
  321.   replaces.
  322.  
  323.   The find string is now highlighted after a successful find.
  324.  
  325.   You can press <^Break> to halt a repeated command and/or macro, and to
  326.   halt a long [FindReplace].
  327.  
  328. New commands:
  329. -------------
  330.  
  331. Summary list:
  332.  
  333. CenterLine                      <^OT>
  334. FillBlock                       <^KL>
  335. JFalse
  336. JTrue
  337. Jump
  338. RepeatCmd                       <^QQ>
  339. SetPrintBotMargin               <ESC><P><O>
  340. SetPrintTopMargin               <ESC><P><T>
  341. ToggleSwap                      <ESC><O><S>
  342.  
  343. Detailed list:
  344.  
  345.   [CenterLine]                  <^OT>
  346.  
  347.   If the cursor is inside a column block, the lines encompassed by the
  348.   block are centered using the left and right columns of the block as
  349.   the margins.
  350.  
  351.   If the cursor is inside a line block, the lines encompassed by the
  352.   block are centered using column 1 and the right margin as the margins.
  353.  
  354.   Otherwise, the line the cursor is on is centered, using column 1 and
  355.   the right margin as the margins.
  356.  
  357.   [FillBlock]                   <^KL>
  358.  
  359.   The user is prompted for a character with which to fill the block.
  360.   With this command, you can now use the following macro to move a
  361.   block, and blank fill the space used by the block, instead of the
  362.   text closing in around the block.  The macro assumes a block is
  363.   already marked.  The block will be [Cut] to the clipboard or system
  364.   scrap buffer.  You can then insert the block where you like by
  365.   pressing the [Paste] key <Grey *>:
  366.  
  367.   f10 MacroBegin GotoBlockBeg Cut Paste FillBlock ' ' Return UnmarkBlock
  368.  
  369.   Choose a key (<f10> in the above example), and assign this macro to it
  370.   in the QCONFIG.DAT file. Run QCONFIG, configure the keyboard, and you
  371.   now have a "copy with wipe" command!
  372.  
  373.   [JTrue], [JFalse] and [Jump] commands.
  374.  
  375.   These commands are intended for macro use. All QEdit commands set an
  376.   internal QEdit result code of "True" if they executed successfully, or
  377.   "False" if they did not.  The [JTrue] and [JFalse] commands can be
  378.   used to take advantage of that fact. [Jump] is just an unconditional
  379.   jump. You can also define labels for branching, in the format
  380.   "label:". The maximum label length is 15 characters.  For Example:
  381.  
  382.   A command to delete from the cursor position to the beginning of the
  383.   line, assigned to the f10 key:
  384.  
  385.   f10 MacroBegin
  386.       begin:
  387.         CursorLeft
  388.         JFalse done:
  389.         DelCh
  390.         Jump begin:
  391.       done:
  392.  
  393.   This MUST all occur on ONE LINE in your QCONFIG.DAT file.
  394.  
  395.   [RepeatCmd]                   <^QQ>
  396.  
  397.   Repeats the last executed command and/or macro "n" times.  You are
  398.   prompted for "n".  You can stop the repeating at any time by pressing
  399.   the <^Break> key.  If the result code from the command is FALSE, or if
  400.   a result code from any of the commands in the macro is FALSE,
  401.   repetition halts.
  402.  
  403.   [SetPrintTopMargin]           <ESC><P><T>
  404.   [SetPrintBotMargin]           <ESC><P><O>
  405.  
  406.   Set the top and bottom margins used when printing.  If QEdit's print
  407.   page size is set to 0, these commands have no effect.
  408.  
  409.   [ToggleSwap]                  <ESC><O><S>
  410.  
  411.   Toggles Expanded memory/Disk swapping for the [Dos] and [Shell]
  412.   commands.  This option can also be set via QCONFIG.
  413.  
  414. IV  Various Keyboard Definition Files Supplied
  415. ----------------------------------------------
  416.  
  417. DESCRIPTION
  418. -----------
  419. QEdit has an extraordinary capacity for customization.  Almost every key
  420. on the keyboard can be assigned to any command, to achieve any sort of
  421. configuration the user might desire.
  422.  
  423. In particular, users switching from another editor to QEdit can install
  424. QEdit to "emulate" the other editor.  This decreases the amount of time
  425. spent learning QEdit.
  426.  
  427. However, setting up the configuration file to emulate another editor can
  428. take a fair amount of time.  We have provided a collection of
  429. ready-to-use keyboard definition files, to simplify the task of making
  430. QEdit work like a variety of other editors and word processors.
  431.  
  432. Both a keyboard definition file (QCONFIG.*) and a help file (QHELP.*)
  433. are supplied for most of the emulations, allowing you to configure both
  434. your keyboard definition and help screen.
  435.  
  436.  
  437. CONTENTS
  438. --------
  439. The following keyboard emulations are provided:
  440.  
  441.      Brief
  442.           QCONFIG.B
  443.  
  444.      Norton Editor 1.3c
  445.           QCONFIG.NE
  446.           QHELP.NE
  447.  
  448.      Personal Editor II (IBM)
  449.           QCONFIG.PE2
  450.           QHELP.PE2
  451.  
  452.      WordPerfect 4.2/5.0
  453.           QCONFIG.WP
  454.           QHELP.WP
  455.  
  456.      WordStar 3.3 (& SideKick/Borland Environments)
  457.           QCONFIG.WS
  458.           QHELP.WS
  459.  
  460.  
  461. INSTRUCTIONS
  462. ------------
  463. It is strongly recommended that, after choosing your emulation, you
  464. print out all the files associated with it.  There are two reasons for
  465. doing this.
  466.  
  467. First, by reading the keyboard definition file, you can see where each
  468. and every key on the keyboard is assigned, as well as the various notes
  469. and comments included inside.
  470.  
  471. Second, several of the keyboard definition files include instructions on
  472. how to answer the other questions and prompts within the configuration
  473. program to best emulate that editor.  You will need a print-out of this
  474. information to refer to while running the QEdit configuration program
  475. (QCONFIG.EXE)
  476.  
  477. Looking at the various help files may also give you some ideas for
  478. formatting a good help screen, if you decide to customize your own.
  479.  
  480. Follow these steps to install the desired keyboard definition:
  481.  
  482.      1.  Put your chosen keyboard definition and help files (e.g.,
  483.          QCONFIG.WS and QHELP.WS) in the same directory with Q.EXE and
  484.          QCONFIG.EXE.
  485.  
  486.      2.  Run QCONFIG, by simply entering the following from your QEdit
  487.          directory: QCONFIG<Enter><Enter>
  488.  
  489.      3.  Select "K" from the configuration program menu to install
  490.          K)eys. When prompted, enter the name of the desired keyboard
  491.          definition file (e.g., QCONFIG.WS).
  492.  
  493.      4.  Select "H" from the configuration program menu to install
  494.          H)elp. When prompted, enter the name of the appropriate help
  495.          file (e.g., QHELP.WS).
  496.  
  497.      5.  If your keyboard definition file has comments indicating
  498.          appropriate settings for other QCONFIG options, select those
  499.          menu options and set them as required, or to your preference.
  500.  
  501.      6.  Press "S" to S)ave your modified Q.EXE to disk.
  502.  
  503.  
  504. And that's it!  You should now be ready to go, with a version of QEdit
  505. that will act "just like" your former editor.
  506.  
  507. ACKNOWLEDGEMENTS
  508. ----------------
  509. Several of these files were originally submitted by QEdit users on
  510. SemWare's BBS. Thanks to Randy Wallin, Steve Lynch, Tim Farley, and many
  511. others for their input.
  512.