home *** CD-ROM | disk | FTP | other *** search
/ POINT Software Programming / PPROG1.ISO / misc / qedit30 / read.me < prev    next >
Text File  |  1994-02-24  |  21KB  |  544 lines
  1.             Welcome to the shareware version of QEdit Advanced 3.0!
  2.                    Copyright 1985 - 1994 SemWare Corporation.
  3.                          All rights reserved worldwide.
  4.  
  5. ──────────────────────────────────────────────────────────────────────────────
  6.  
  7.           TABLE OF CONTENTS
  8.  
  9.      0    INTRODUCTION
  10.      I    SEMWARE NEWS
  11.      II   CONTENTS OF QEDIT ADVANCED SHAREWARE DISK
  12.      III  TECHNICAL SUPPORT
  13.      IV   VERSION 3.0 - RELEASE NOTES
  14.  
  15.  
  16. 0    INTRODUCTION
  17. ──────────────────────────────────────────────────────────────────────────────
  18.  
  19. This version of QEdit is NOT public domain or free software, but is being
  20. distributed as "shareware" for EVALUATION PURPOSES ONLY.
  21.  
  22. SemWare grants a limited license to individuals to use this shareware software
  23. for a 30-day evaluation period on a private, non-commercial basis, for the
  24. express purpose of determining whether QEdit is suitable for their needs. At
  25. the end of this 30-day evaluation period, the individual must either purchase
  26. a license from SemWare for continued use of the program, or discontinue using
  27. QEdit.
  28.  
  29. Many hours of work have gone into the development of QEdit - over 10
  30. work-years, as of this version - and that does not include all the time spent
  31. on our users guide/reference manual. In addition, we provide full-time
  32. support, via phone during normal business hours, or mail, fax, or BBS if you
  33. prefer.
  34.  
  35. QEdit is a professionally developed, packaged, and supported product. Our
  36. product has received excellent reviews, and our manual and product support are
  37. highly regarded by our licensed users. We offer discounts on updates to our
  38. registered users, and we regularly incorporate suggested changes into the
  39. product as we are able.
  40.  
  41. The only way we can continue to provide products like QEdit and to offer
  42. outstanding technical support, is to stay in business; and the only way we can
  43. stay in business is for those who use QEdit to purchase a license for it. We
  44. like the shareware concept and would like to stay a part of it. But we can do
  45. so only through paid licenses for QEdit. Please don't take this the wrong way
  46. - you may try QEdit for 30 days (subject to the conditions and restrictions
  47. stated in QEDIT.DOC), under no obligation to pay to use it during that time.
  48. However, if you continue to use it after that 30-day evaluation period, you
  49. must purchase a license to do so. THANKS!
  50.  
  51.  
  52. The QEdit software is owned by SemWare Corporation, or its suppliers, and is
  53. protected by United States copyright laws and international treaty provisions.
  54.  
  55. SemWare is a registered trademark of SemWare Corporation.  All other
  56. trademarks and registered trademarks referenced in this file are the property
  57. of their respective owners.  The QEdit registered trademark is used under
  58. license from Robelle Consulting Ltd.
  59.  
  60. For LICENSE, WARRANTY, U.S. GOVERNMENT RESTRICTED RIGHTS, EXPORT LAW
  61. ASSURANCES, and GOVERNING LAW AND GENERAL PROVISIONS information, see the
  62. printed documentation accompanying this software.
  63.  
  64. Please review the contents of this file before using QEdit.  It contains
  65. helpful information on the operation of QEdit and how to get assistance when
  66. you need it.  The VERSION 3.0 - RELEASE NOTES section includes an explanation
  67. of features and changes in this release not documented in the reference
  68. manual.
  69.  
  70. I    SEMWARE NEWS
  71. ──────────────────────────────────────────────────────────────────────────────
  72.  
  73. QEdit has become widely popular, with over 120,000 licensed customers
  74. throughout the U.S. and in more than 70 countries!
  75.  
  76. QEdit for OS/2 NOW AVAILABLE with HPFS support!  If you want THE FASTEST
  77. editor available for OS/2, give SemWare a call!
  78.  
  79. QEdit TSR AVAILABLE!  For those of you who would like to have access to your
  80. favorite editor at virtually anytime, in the middle of anything else, we at
  81. SemWare are proud to offer you QEdit TSR v3.0. And best of all, if you have
  82. expanded memory (192k minimum) or extended memory (384k minimum), QEdit TSR
  83. will reserve only 9k of DOS memory! See the QEdit reference manual for more
  84. details.
  85.  
  86. QEdit is the winner of the Data Based Advisor Readers Choice Award for best
  87. text/program editor for 1989, 1991 and 1992.  We thank our users for this
  88. vote of confidence and their continued support!
  89.  
  90. There are GERMAN versions available of our QEdit products.  All text
  91. displayed by the program (including the status line!) is in German, and the
  92. reference manual was painstakingly translated by a native German.  For
  93. information on ordering the German version, contact our German distributor,
  94. Manfred Luft, directly:
  95.  
  96.    Manfred Luft SoftWare              CIS:      100016,3715
  97.    Waldstr. 20a                       Internet: 100016.3715@compuserve.com
  98.    D-79194 Gundelfingen
  99.    GERMANY
  100.  
  101.                  within Germany          from the US
  102.     Telephone:    0761-58 05 26       011-49-761-580526
  103.     Fax:          0761-58 05 47       011-49-761-580547
  104.     BBS 1:        0761-58 05 22       011-49-761-580522
  105.     BBS 2:        0761-58 32 70       011-49-761-583270
  106.  
  107.  
  108.  
  109. II   CONTENTS OF QEDIT ADVANCED DISTRIBUTION DISK
  110. ──────────────────────────────────────────────────────────────────────────────
  111.  
  112. File            Description
  113. ────────────    ──────────────────────────────────────────────────────────────
  114.  
  115. Q.EXE           The editor program.  This is the only file required
  116.                 to run QEdit Advanced.
  117.  
  118. QCONFIG.EXE     The configuration program.
  119. QCONFIG.DAT     The standard Keyboard Definition File.
  120. QHELP.TXT       The standard Help text.
  121.  
  122. QMAC.EXE        Macro translator for QEdit.
  123. MACROS.TXT      Sample macros for use with QEdit.
  124.  
  125. QCP.EXE         QEdit compiler helper program.
  126. QCP.DOC         QEdit compiler helper program documentation.
  127. QCP.DAT         A configuration file for QCP.
  128. QCP.TXT         A sample QEdit macro for using with QCP.
  129.  
  130. READ.ME         The file you are currently reading.
  131. QEDIT.DOC       The documentation for the shareware version of QEdit.
  132. HELPME.DOC      Common Questions and Answers regarding QEdit.
  133. QTIPS.DOC       Helpful QEdit tips compiled by SemWare Tech support.
  134. FILE_ID.DIZ     QEdit description for bbs.
  135. VENDOR.DOC      Restrictions/Authorizations for Disk Vendor distribution.
  136. ORDERFRM.DOC    Handy order from.
  137.  
  138. Notes
  139. ─────
  140.  
  141.  
  142. The ONLY file required to run QEdit is Q.EXE - the others are not required
  143. by the program.
  144.  
  145.  
  146. We DO NOT release patch files for QEdit, under any circumstances. If you
  147. encounter a "patch" file that modifies your Q.EXE file, be aware that it
  148. does not originate from us, and we cannot be responsible for the behavior of
  149. a patched QEdit. The ONLY programs you should use to modify your copy of
  150. Q.EXE, are the QCONFIG and QUPDATE programs that we supply with Q.EXE. We
  151. cannot provide support for copies of QEdit which have been modified by other
  152. third-party programs. Keep this in mind when calling for technical support.
  153.  
  154. Please make sure you read this entire file in order to take full advantage
  155. of the new commands/features in QEdit 3.0.
  156.  
  157.  
  158. III  TECHNICAL SUPPORT
  159. ──────────────────────────────────────────────────────────────────────────────
  160.  
  161. Because of the tremendous popularity of QEdit, we can give technical support
  162. ONLY to licensed, registered QEdit users.  Please have your QEdit SERIAL
  163. NUMBER handy when you call.
  164.  
  165. Please!  Before you call us with a problem, make sure you have read this
  166. entire READ.ME file to determine if it solves your problem.  You should also
  167. review the HELPME.DOC and QTIP.DOC files to see if they answer your question.
  168.  
  169. If you should need to contact us, please provide or have available the
  170. following information:
  171.  
  172.     QEdit version number, date of Q.EXE on the original diskette,
  173.       and serial number
  174.     OS/2 or DOS version
  175.     Computer model
  176.     Amount of RAM
  177.     Whether you are using a hard disk or floppy disk based PC
  178.     The names of any memory-resident programs you have loaded
  179.  
  180.  
  181. You may obtain technical support directly from SemWare as follows:
  182.  
  183. 1. Call our remote electronic bulletin board service.  The board is
  184.    operational 24 hours a day, 7 days a week.  Modem settings are <N81>,
  185.    9600 HST DS, 2400 or 1200 baud.  The BBS number is: (404) 641-8968.
  186.  
  187. 2. CompuServe (GO SEMWARE, Section 6)
  188.  
  189. 3. Send email to:
  190.  
  191.    CIS         75300,2710
  192.    Fido        1:133/314
  193.    EchoNet     50:5020/314
  194.    RIME        ->SemWare   (QEdit or RIME Admin)
  195.                ->330       (QEdit or RIME Admin)
  196.    InterNet    75300.2710@compuserve.com
  197.                or
  198.                tech.support@semware.atl.ga.us
  199.  
  200.    We can also be reached in the SemWare/QEdit echos on the following
  201.    networks:
  202.  
  203.    EchoNet, Fido, Global-Link, ILink, Intellec, MetroLink, PlanoNet, RIME,
  204.    SmartNet, U'NI-net, and W-Net.
  205.  
  206. 4. Send us a Fax: (404) 640-6213
  207.  
  208. 5. Write to us:
  209.  
  210.    SemWare Corporation
  211.    Attn: QEdit Technical Support
  212.    4343 Shallowford Road, Suite C3A
  213.    Marietta, GA  30062-5022  USA
  214.  
  215. 6. Call us directly at SemWare (404) 641-9002. Support hours are 9 am to 5
  216.    pm (ET), Monday through Friday.
  217.  
  218.  
  219. SemWare is committed to supporting registered users.  However, we request
  220. that you reserve telephone support for questions or problems requiring
  221. immediate attention.
  222.  
  223. As always, if you have a suggestion that you think would improve our
  224. product, don't hesitate to let us know.
  225.  
  226.  
  227. IV   VERSION 3.0 - RELEASE NOTES
  228. ──────────────────────────────────────────────────────────────────────────────
  229.  
  230. Important Notes
  231. ───────────────
  232.  
  233. ∙ In order to provide the utmost in reliability, the internal macro format in
  234.   QEdit 3.0 is slightly different than for previous versions.  Because of
  235.   this, macros created in prior versions of QEdit can not be used as is.
  236.  
  237.   To use these macros in QEdit 3.0, simply convert the binary macro to text
  238.   format using your pre-3.0 version of QMAC, and then convert that text macro
  239.   to binary using QMAC 3.0.
  240.  
  241. ∙ The date format supported by QEdit 3.0 is slightly different than in
  242.   previous versions.  In previous versions, the year was in 4-digit format,
  243.   and two spaces were inserted after the date string.
  244.  
  245.   In QEdit 3.0, the year is in 2-digit format, and no extra spaces are
  246.   inserted at the end of the date string.
  247.  
  248. ∙ Multi-line macros are now supported by QCONFIG, in the QCONFIG.DAT file.
  249.   Also, the MacroBegin statement is optional.  Because of these additional
  250.   features, a couple of rules must be followed:
  251.  
  252.   - Key assignments must begin in column 1.
  253.  
  254.   - Lines two and greater of a multi-line macro must start in column 2 or
  255.     greater.
  256.  
  257.   - Text starting in column 1 (other than a comment) is assumed to be the
  258.     start of a key assignment.
  259.  
  260. ∙ To take advantage of the commands assigned to the enhanced keyboard keys
  261.   (^CursorUp, ^CursorDown, f11, f12, etc), the A)dvanced configuration option,
  262.   "Test for presence of enhanced keyboard" must be set to "Y" by the QCONFIG
  263.   program.
  264.  
  265.  
  266. New Features in QEdit 3.0
  267. ─────────────────────────
  268.  
  269. This section summarizes new features available in version 3.0 of QEdit.  For
  270. more detailed information, see the QEdit reference manual.
  271.  
  272. New Commands
  273.  
  274.   Printing commands:
  275.  
  276.     SetPrintDevice - Set print output device.
  277.     SetPrintLineSpacing - Set Line spacing: 1=single, 2=double, ...
  278.     TogglePrintLineNumbers - Toggles printing of line numbers.
  279.     TogglePrintPause - Toggles pauses between printed pages.
  280.  
  281.   Tabs commands:
  282.  
  283.     SetTabType - Set tab type to FIXED, SMART, or VARIABLE.
  284.     SetVarTabStops - Set column positions of variable tab stops.
  285.     SpacesToTabs - Compresses spaces to tabs for the block or file.
  286.     TabsToSpaces - Expands tabs to spaces for the block or file.
  287.     ToggleVarTabs - Toggles VARIABLE tabs on/off.
  288.  
  289.   Sorting commands:
  290.  
  291.     ToggleSortCaseInsensitive - Toggles case sensitive Sort.
  292.     ToggleSortDescending - Toggles descending Sort order.
  293.  
  294.   Macro control commands:
  295.  
  296.     isCurrChar - Tests the value of the current character in the file.
  297.     MacroQuit - Terminates the current macro unconditionally.
  298.     MacroQuitFalse - Terminates the current macro if preceding command
  299.         returned FALSE.
  300.     MacroQuitTrue - Terminates the current macro if preceding command
  301.         returned TRUE.
  302.  
  303.   Other commands:
  304.  
  305.     DelScrBuff - Prompts for named scratch buffer to delete.
  306.     ToggleCenterFinds - Toggles centering found text horizontally in current
  307.         window.
  308.     ToggleShowCurrChar - Toggles showing of hex/decimal value of current
  309.         char on StatusLine.
  310.     AsciiChart - Displays an ASCII chart, optionally allowing insertion of a
  311.         selected character into the file.
  312.  
  313.  
  314. Additions/Changes to Menus
  315.  
  316.     Menus now have dividers that improve the readability of menus with a
  317.     large number of selections.
  318.  
  319.     The menus now include the indicators "..." and "":  "..." identifies
  320.     menu items that issue a prompt when selected; "" identifies menu items
  321.     that display a submenu or pick list when selected.
  322.  
  323.     All menu items that previously toggled a mode, such as "set Autoindent
  324.     off", now show the current mode in square brackets like this:
  325.     "Autoindent   [on ]".  As before, selecting the menu item toggles the
  326.     value.
  327.  
  328.   New menu items:
  329.  
  330.     BLOCK menu:
  331.  
  332.       Ignore case [off]              - invokes ToggleSortCaseInsensitive
  333.       desceNding  [off]              - invokes ToggleSortDescending
  334.  
  335.     SEARCH menu:
  336.  
  337.       goto Line                      - invokes GotoLine
  338.       Goto column                    - invokes GotoColumn
  339.       Match                          - invokes Match
  340.       Center finds [on ]             - invokes ToggleCenterFinds
  341.  
  342.     PRINT menu:
  343.  
  344.       set print line Spacing         - invokes SetPrintLineSpacing
  345.       print line Numbers     [off]   - invokes TogglePrintLineNumbers
  346.       print paUse            [off]   - invokes TogglePrintPause
  347.       set print Device               - invokes SetPrintDevice
  348.  
  349.     EDITING menu:
  350.  
  351.       Centerline                     - invokes CenterLine
  352.       Wrappara                       - invokes WrapPara
  353.  
  354.     OTHER menu:
  355.  
  356.       sHow char value  [off]         - invokes ToggleShowCurrChar
  357.       set tab tYpe                   - invokes SetTabType
  358.       set Variable tab stops         - invokes SetVarTabStops
  359.       eXpand tabs to spaces          - invokes TabsToSpaces
  360.       coMpress spaces to tabs        - invokes SpacesToTabs
  361.       ascii charT                    - invokes AsciiChart
  362.  
  363.  
  364. Macro Enhancements
  365.  
  366.     Note:  Macros created with previous versions of QEdit must be recompiled
  367.            in order for them to work with QEdit 3.0.
  368.  
  369.     QConfig macro space has been increased from 512 to 2048 bytes.
  370.  
  371.     Loadable macro area has been increased from 2048 to 4096 bytes.
  372.  
  373.     Startup macro in QCONFIG.DAT.  This macro is created just as any other
  374.     macro in QCONFIG.DAT, except that it is not bound to a key. Instead, you
  375.     bind this macro to the keyword "main". For example:
  376.  
  377.       main    MacroBegin HorizontalWindow PrevWindow
  378.  
  379.     Macros in QCONFIG.DAT file may now span multiple lines.  Keys MUST begin
  380.     in column one and successive lines MUST be indented by one or more spaces
  381.     or tabs.  Blank lines are ignored.  For example, the above macro could
  382.     also be written:
  383.  
  384.       main    MacroBegin              * Start of macro
  385.                   HorizontalWindow    * Split the screen
  386.                   PrevWindow          * Return to the previous window
  387.  
  388.     Comments may appear at the end of lines containing macro commands, as in
  389.     the example above.
  390.  
  391.     Macros in QCONFIG.DAT may now be assigned to twokeys.
  392.  
  393.     Macros no longer require the MacroBegin, although its use is permitted.
  394.  
  395.  
  396. Other New Features
  397.  
  398.     The maximum line length has been increased from 512 to 1000.
  399.  
  400.     QConfig twokey space has been increased from 192 to 256 bytes.
  401.  
  402.     GetScrbuff, StoreScrbuff, AppendScrbuff, and DelScrbuff will now display
  403.     a pick list of existing scratch buffers to choose from if <Enter> is
  404.     pressed at an empty prompt.
  405.  
  406.     Startup Video Mode option added.  The editor can now be configured to
  407.     come up in the current video mode, or one of the following modes:
  408.     25-line mode, 28-line mode, or 43/50-line mode.  The modes available
  409.     depend on the type of display adapter being used.
  410.  
  411.     The Insert and Overwrite cursor size is now configurable via QConfig
  412.     under the Advanced Options.  Valid values are from 0 to 7, with 0 being
  413.     the smallest possible cursor, and 7 being the largest.
  414.  
  415.     TabsOut behavior changed as follows:
  416.       If TabsOut is ON, spaces are compressed to real tabs when:
  417.         1)  the file is saved, or
  418.         2)  the SpacesToTabs command is invoked.
  419.  
  420.         Note that this is done for each line, each time the file is saved.
  421.  
  422.     New date and time formats.  DateFormat, DateSeparator, TimeFormat, and
  423.     TimeSeparator options added to support multiple date/time formats.  The
  424.     commands InsertDate and InsertTime now recognize the new formats.
  425.  
  426.             DateFormat:     1 - MM-DD-YY            [MON  06-14-93]
  427.                             2 - DD-MM-YY            [MON  14-06-93]
  428.                             3 - YY-MM-DD            [MON  93-06-14]
  429.  
  430.             DateSeparator:  can be any character; defaults to "-"
  431.  
  432.             TimeFormat:     1 - 24-hour             [15:24:18]
  433.                             2 - 12-hour             [03:24 pm]
  434.  
  435.             TimeSeparator:  can be any character; defaults to ":"
  436.  
  437.     A pop-up ASCII chart is available that inserts the selected character
  438.     when the <Enter> key is pressed.  Pressing the <Escape> key exits the
  439.     ASCII chart without placing the character into the file.
  440.  
  441.     In the FileList, files that have been changed are indicated by an "*" in
  442.     the first column of the list.
  443.  
  444.  
  445. New Options Added to QCONFIG.EXE
  446.  
  447.   Under ADVANCED OPTIONS:
  448.  
  449.     Size of cursor in Insert mode [0..7] [4] :
  450.     Size of cursor in overwrite mode [0..7] [1] :
  451.  
  452.     Date format: 1=MM-DD-YY, 2=DD-MM-YY, 3=YY-MM-DD  [1] :
  453.     Character to use to separate the elements of the date  [-] :
  454.     Time format: 1=24-hour, 2=12-hour  [1] :
  455.     Character to use to separate the elements of the time  [:] :
  456.  
  457.     Full path to QEdit files [ ] :
  458.       Identifies the directory where QEdit supplemental files are stored.
  459.  
  460.  
  461.   Under COLORS/SCREEN:
  462.  
  463.     Display hex/decimal values of current character on StatusLine (Y/N)? [N] :
  464.  
  465.     Startup video mode: 0=current, 1=25lines, 2=28lines, 3=43/50lines [0] :
  466.     Startup attribute set: 0=AutoDetect, 1=Monochrome, 2=Color [0] :
  467.     Do you want to configure the mono attribute set (Y/N)? [N] :
  468.     Do you want to configure the color attribute set (Y/N)? [N] :
  469.  
  470.   Under GENERAL OPTIONS:
  471.  
  472.     Should Find and RepeatFind center the found text (Y/N)? [Y] :
  473.  
  474.     Default to case-insensitive sort (Y/N)? [N] :
  475.     Default to descending-order sort (Y/N)? [N] :
  476.  
  477.   Under PRINTER OPTIONS:
  478.  
  479.     Include line number at beginning of each printed line (Y/N)?  [N] :
  480.     Default line spacing: 1=single, 2=double, etc... [1..255]  [1] :
  481.     Should printing pause between pages (Y/N)? [N] :
  482.     Print Device: 0=PRN, 1=LPT1, 2=LPT2, 3=LPT3 [0..3] [0] :
  483.  
  484.   Under TAB SETTINGS:
  485.  
  486.     Default tab type: 0=Fixed, 1=Smart, 2=Variable [0] :
  487.  
  488.     Default Variable Tab stop columns:
  489.      [4 8 16 24 40]
  490.      :
  491.  
  492.  
  493. Commands Available in QEdit Prompt Boxes
  494.  
  495.   The following commands are available in QEdit prompt boxes:
  496.  
  497.     Command                 Forced Key Assignment
  498.     ───────                 ─────────────────────
  499.     BackSpace
  500.     BegLine
  501.     CurrentFilename
  502.     CursorLeft              CursorLeft
  503.     CursorRight             CursorRight
  504.     DelCh
  505.     DelLine
  506.     DelToEol
  507.     EndLine
  508.     Escape                  Escape
  509.     Paste
  510.     Pause
  511.     Return                  Return
  512.     ToggleInsert
  513.  
  514.  
  515. New Standard Key Assignments
  516.  
  517.     ^]  Edit Filename at Cursor (macro)
  518.     @=  Find the next occurrence of the word at the cursor
  519.  
  520.     @f  Pulldown the File menu (macro)
  521.     @p  Pulldown the Print menu (macro)
  522.     @q  Pulldown the Quit menu (macro)
  523.  
  524.  
  525. Miscellaneous Usage Notes
  526.  
  527.   Methods to Speed Up Keyboard Delays:
  528.  
  529.     If you are running DOS 5 or greater, you can use the following DOS
  530.     command:
  531.  
  532.       mode con: rate=32 delay=1
  533.  
  534.     See your DOS reference manual for additional details.
  535.  
  536.  
  537.   Problems with TSR's and QEdit:
  538.  
  539.     If you are having problems with TSR's not popping up over QEdit, try
  540.     setting the option "Test for presence of enhanced keyboard (Y/N)?" to
  541.     "N" (the standard setting).  This option is set via the QCONFIG program,
  542.     under "Advanced options."
  543.  
  544.