home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 19 / CD_ASCQ_19_010295.iso / vrac / e4dv203.zip / E4.DOC < prev    next >
Text File  |  1994-10-11  |  21KB  |  538 lines

  1. ****************************************************************
  2. E4(tm) Editor (C) Copyright N.Faulks 1994. All Rights Reserved.
  3. ****************************************************************
  4. Version 2.03 October 1994
  5. ****************************************************************
  6.  
  7. Note that this file is an E4 outline document (as well as a 
  8. printable text file), to view it in outline form from within E4, 
  9. press ALT-H, then Y for "Yes". Now you can press ALT-H over 
  10. headings or text you would like to open or close.
  11.  
  12. If you want to print this file please note that it contains TAB 
  13. characters. To convert it to a printable (tab-less) file type 
  14. "E4 E4.DOC" then press ALT-P for print, type a filename and 
  15. press RETURN. (or press RETURN to print straight to PRN). To 
  16. leave E4 press ALT-Q.
  17.  
  18. INTRODUCTION ***************************************************
  19.  
  20.  E4 is a powerful multi-file text editor with outlining, 
  21.  macros, SVGA support, and in-editor compilation and 
  22.  error tracking.
  23.  
  24.  E4 isn't a bloated every-feature-under-the-sun product, 
  25.  rather it is a small, fast editor that manages to 
  26.  provide most of the features most people use.
  27.  
  28.  E4 is great for people who only want to edit 
  29.  AUTOEXEC.BAT and CONFIG.SYS as well as Programmers and 
  30.  System/Network Adminstrators.
  31.  
  32.  E4 is a complete Program Development Environment. You 
  33.  can compile from within the editor, a single file or a 
  34.  whole project. You can also run your program from within 
  35.  the editor, with or without a debugger. E4 can shrink in 
  36.  size to only 2K, leaving plenty of memory free for your 
  37.  program. The registered version of E4 comes with a 
  38.  program to trap error messages from a wide range of 
  39.  compilers. You can then step through compilation errors 
  40.  one by one, the cursor is taken to the erroneous line 
  41.  and the error message is displayed at the bottom of the 
  42.  screen. This works across different source files and for 
  43.  most languages (mixed languages are supported), even 
  44.  some linker errors are tracked to the original source 
  45.  file. E4 provides a common development environment, 
  46.  which ever language you are using.
  47.  
  48.  E4 really is better than other editors, because it is 
  49.  easy to use and powerful. Yes, you have to take the 
  50.  trouble to learn it, but once you have got over the 
  51.  short initial learning curve it WILL make you more 
  52.  productive. Easy to use doesn't have to mean pull down 
  53.  menus and WIMPs. E4 works well with a mouse, but the 
  54.  common commands are only a single mnemonic keystroke (E4 
  55.  doesn't use the function keys: how can they be easy to 
  56.  remember?). It doesn't matter if you have "every 
  57.  feature" if they are all equally difficult to use. E4 
  58.  makes everyone into an expert: the "Hintline" shows you 
  59.  most of the commands or options available, at every 
  60.  point in the editor. Full context-sensitive help makes 
  61.  E4 easy to learn.
  62.  
  63.  E4 is available as two versions: E4 and E4-Deluxe. The 
  64.  Deluxe version is distributed in an archive file that 
  65.  begins E4D. E4-Deluxe includes user-definable pull-down 
  66.  menus, and the shareware distribution includes more 
  67.  sample files.
  68.  
  69.  Feature lists are not the whole story: that's why E4 is 
  70.  made available on a try-before-you buy basis. Don't just 
  71.  reject it because it isn't exactly the same as what 
  72.  you're using: try it!
  73.  
  74.  E4 already has a large user community including 
  75.  professional programmers, businesspeople, educators, and 
  76.  students. If you've got a suggestion or problem call the 
  77.  author (Neil Faulks) on 071 873 2007 (+44 71 873 2007) 
  78.  anytime, or mail him on the Internet 
  79.  (neil@dcs.kcl.ac.uk) or through CompuServe 100417,1251
  80.  
  81.  I want you to be happy with E4, before and after you buy 
  82.  it.
  83.  
  84. IMPORTANT NOTICE ***********************************************
  85.  
  86.  This is a Try-before-you-buy Evaluation copy of the E4 
  87.  Editor, it is fully functional. You may use E4 freely 
  88.  for up to 30 days, but if you want to use it after this 
  89.  period you must pay for it. See later in this file.
  90.  
  91.  Occasionally the editor will ask you to press a key when 
  92.  you first run it, this feature is absent from the 
  93.  version you will receive upon payment.
  94.  
  95.  Buying your own copy also brings the benefits of 
  96.  comprehensive printed documentation, extra utility 
  97.  programs and macros, and special offers on upgrades and 
  98.  other products.
  99.  
  100.  Programmers should note that only the registered version 
  101.  supports compiler error message tracking, as it requires 
  102.  extra support programs.
  103.  
  104. PACKING LIST & RELEASE NOTES ***********************************
  105.  
  106.  This software should be distributed as the single .ZIP 
  107.  or .EXE archive. The archive contains the files listed 
  108.  below. PLEASE KEEP THE ORIGINAL ARCHIVE FILE TO GIVE TO 
  109.  OTHERS.
  110.  
  111.  Note that if this is the E4-Deluxe distribution more 
  112.  files are included than are listed here.
  113.  
  114.  E4.EXE        The Editor itself (All you really need!)
  115.  E4.HLP        The help file for the editor 
  116.  E4KEYS        A sample keyboard mapping file 
  117.  E4.DOC        This document, Please read it all 
  118.  E4ORDER.TXT    Printable order form and prices 
  119.  VENDOR.DOC    Notes for shareware vendors and BBSs. 
  120.          Includes feature lists and descriptions 
  121.  FILE_ID.DIZ    A BBS description file 
  122.  TEMPLATE.C    Sample template file for C programs 
  123.  E4OPTS.C    Sample options file for C programs
  124.  COMPILE.EXE    A generic compiler control program
  125.  COMPILE.DOC    Documentation for COMPILE
  126.  COMPILE.CL    Configuration file for COMPILE
  127.  
  128.  The sample E4KEYS file includes some key definitions of 
  129.  use only to programmers, to handle in-editor 
  130.  compilation. These are distributed as macros in the 
  131.  registered version, but are included here in the keys 
  132.  file to save space. The sample definitions allow you to 
  133.  compile from within the editor (a single file or a 
  134.  complete project), and to execute your program with or 
  135.  without a debugger. The registered version provides full 
  136.  error tracking, allowing you to step through error 
  137.  messages one by one, taking you to the correct file and 
  138.  line. 
  139.  
  140.  Programmers should examine the E4KEYS file to learn 
  141.  about creating macros to compile and debug programs.
  142.  
  143. CHANGES ********************************************************
  144.  
  145.  Only major changes are listed, numerous minor changes 
  146.  are made with every release. The registered version has 
  147.  more detailed information.
  148.  
  149.  Version 2.03
  150.   
  151.   The top menu bar is now hidden until the menu 
  152.   key is pressed or the mouse is moved over it 
  153.   (E4D). Setting a default extension now disables 
  154.   the "Create Project File" prompt.
  155.           
  156.  Version 2.02
  157.   
  158.   E4PATH enhanced so that * (meaning the current 
  159.   E4.EXE directory) can appear within a pathname. 
  160.   Default E4PATH changed to prefer placing config 
  161.   info into a CONFIG directory if one exists. 
  162.   Network users can as always have their own local 
  163.   config if the HOME environment variable is set.
  164.   
  165.   Added support in COMPILE.CL (shareware) and 
  166.   E4TRAP (registered version) for Procomm ASPECT 
  167.   language.
  168.   
  169.  Version 2.01
  170.   
  171.   Minor changes to documentation. Inclusion of a 
  172.   DESCRIPT.ION file for 4DOS and V1 users. No 
  173.   changes to programs, other than date and 
  174.   version.
  175.   
  176.  Version 2.0
  177.   
  178.   Rectangular Box Marking. Command line selectable 
  179.   keymaps. Paste chars from ASCII chart. Select 
  180.   video rows from command line. 2-Key assignments. 
  181.   View control chars as symbols or letters. 
  182.   Enhanced exploding macros. Enhanced marking 
  183.   mode, menu and display, with measurement 
  184.   capability. Roaming Cursor (RC) mode to allow 
  185.   cursor to move freely around screen. Shift 
  186.   marking on more keys.
  187.   
  188.  Version 1.6
  189.   
  190.   Outlining. XMS swapping (leaving <2K resident). 
  191.   Colour Brackets. LOOP, ENDLOOP and STOP in 
  192.   macros. Support for Read-only buffers 
  193.   (independent of Read-only files).
  194.   
  195.  Version 1.51
  196.   
  197.   New Ditto function using ALT-Space Bar. New 
  198.   CATCH macro keyword (useful in template macros). 
  199.   Enhanced handling of Read-Only files, can now 
  200.   edit System and Hidden files also. Enhanced 
  201.   handling of environment variables in DOS 
  202.   commands. Better handling of ^Break when macro 
  203.   playing is paused. Modified screen blanker to 
  204.   allow portables to power down.
  205.   
  206.  Version 1.5
  207.   
  208.   Support for external commands and tools. All new 
  209.   Picture mode/Line Draw mode. Automatic Project 
  210.   File creation. New commands: Buffer Reload, 
  211.   Tools Editclip, Goto Edit (New edit tracking 
  212.   system). Multiple tags. New Wordprocessing and 
  213.   WordWrap modes. Support for bright screen 
  214.   background colours. More support for Novell 
  215.   Netware. Template Macros. Enhanced Find Eol to 
  216.   allow searching for Lone CR or LF at ends of 
  217.   lines. Extended help system.
  218.   
  219.  Version 1.0
  220.   
  221.   First non-commercial release.
  222.  
  223. OVERVIEW *******************************************************
  224.  
  225.  E4 will run on any PC compatible with 128K of RAM, under 
  226.  MSDOS 3.0 or above, and any standard display adaptor. A 
  227.  hard disk is not required: the minimum installation is 
  228.  about 40K (42K for E4-Deluxe).
  229.  
  230.  SVGA support allows for special text modes such as 
  231.  100x40, 100x75 and 132x60, on those cards that offer it, 
  232.  up to 255x255.
  233.  
  234.  Full use is made of enhanced keyboards including F11 & 
  235.  F12 and other special key combinations. Full mouse 
  236.  support (for a true Microsoft compatible mouse) allows 
  237.  on screen selection of text and menu operation. Note 
  238.  that mouse support in SVGA screen modes often does not 
  239.  work due to mouse driver limitations.
  240.  
  241.  The editor occupies little disk space making it suitable 
  242.  for installation on a RAM Disk, the optional help file 
  243.  can be relocated elsewhere; using the E4HELP environment 
  244.  variable. 
  245.  
  246.  E4 has a short start up time and loads and saves files 
  247.  very quickly.
  248.  
  249.  Most of the keys on the keyboard may be redefined to 
  250.  suit you. Any standard key combination, or pair of keys, 
  251.  may be assigned to one or more editor functions, simply 
  252.  by editing a text file listing the assignments to be 
  253.  made (E4KEYS). A command line switch can be used to 
  254.  override customisation so that someone can use the 
  255.  editor on another person's machine, for example when 
  256.  giving help in a school or college.
  257.  
  258.  The normal Cut and Paste system, which allows arbitrary 
  259.  streams of characters to be moved about the editor, is 
  260.  augmented by a simple system for moving and copying 
  261.  whole lines, as this is such a common operation. 
  262.  
  263.  A design limitation is that the maximum file size that 
  264.  may be edited is 64K, and is one reason the editor is so 
  265.  small. This limit is offset somewhat by the ease with 
  266.  which multiple files may be edited. In particular you 
  267.  are able to perform a truly global search and replace 
  268.  operation that affects several files. When programming 
  269.  it is not a good idea to construct a program by using 
  270.  one monolithic file, better to split it up into several 
  271.  modules.
  272.  
  273.  E4 comes with complete context-sensitive on-line help. 
  274.  But you can use page-up and page-down to move through 
  275.  the help screens one by one if you want to make sure you 
  276.  see them all. Press F1 twice to find out how to use 
  277.  help.
  278.  
  279. INSTALLATION & RUNNING *****************************************
  280.  
  281.  DOS 3.0 or above is needed to run E4.
  282.  
  283.  Copy the files listed in the packing list above to a 
  284.  directory on your hard disk and put that directory in 
  285.  your PATH. For example if you create a directory for the 
  286.  editor called C:\E4 then you should add the following 
  287.  line to your AUTOEXEC.BAT file (and reboot):
  288.  
  289.      PATH C:\E4;%PATH%
  290.  
  291.  If you have CED or ANARKEY or a similar command line 
  292.  editor, you can have an alias that expands to the full 
  293.  pathname of the editor, instead of adding the editor 
  294.  directory to the PATH. E4 does not need to be in the 
  295.  path to find its support files or programs.
  296.  
  297.  Run the editor with the list of filenames you wish to 
  298.  edit. Wildcards may be included:
  299.  
  300.      E4 \AUTOEXEC.BAT \CONFIG.SYS \WINDOWS\*.INI
  301.  
  302.  NOTE: A few systems may not correctly identify the type 
  303.  of keyboard they have: if the editor hangs then reboot, 
  304.  and run it again with the /P switch, which forces it to 
  305.  use only the standard (PC) keyboard driver, rather than 
  306.  the enhanced (AT) driver. Note that the editor has been 
  307.  tested and does work correctly on true IBM PCs, IBM 
  308.  PC/ATs and IBM PS/2s, as well as many machines from a 
  309.  variety of manufacturers including Compaq, Dell, Grid, 
  310.  NEC and Tandon.
  311.  
  312.  The /B command line switch will run the editor in black 
  313.  and white. /? will list other switches.
  314.  
  315.  F1 displays context sensitive help.
  316.  
  317.  Press ALT-Q to leave the editor.
  318.  
  319.  You can put standard switch settings into the E4 
  320.  environment variable:
  321.  
  322.      SET E4=/B
  323.  
  324.  The example above will cause the editor to always run in 
  325.  Black and White.
  326.  
  327.  You can have many options listed in the environment 
  328.  variables. For example, if you also want to use CUA mode 
  329.  (E4-Deluxe only) you would set the variable like this:
  330.  
  331.      SET E4=/B /=CUA
  332.  
  333.  These SET statements are best placed in your 
  334.  AUTOEXEC.BAT file.
  335.  
  336. DEMO ***********************************************************
  337.  
  338.  For a short demonstration of Resume Mode go to the root 
  339.  directory of your boot disk and (assuming E4 is in your 
  340.  PATH) type
  341.      
  342.      E4 /R AUTOEXEC.BAT CONFIG.SYS
  343.  
  344.  Then press ALT-Q to quit the editor.
  345.  
  346.  Now whenever you want to edit your configuration simply 
  347.  go to the root directory and type
  348.  
  349.      E4
  350.  
  351.  The cursor will be where it was and the same files will 
  352.  be loaded. Any new files you load will also be available 
  353.  to future sessions.
  354.  
  355. EXAMPLE APPLICATION - BORLAND PARADOX **************************
  356.  
  357.  If you use Borland's Paradox (3.5 or 4.0) you can 
  358.  install E4 as the default editor. Use the following 
  359.  command line:
  360.      
  361.      E4 /XSC * /**
  362.  
  363.  This sets the default extension for loading and saving 
  364.  to .SC (for script). Paradox replaces the * by the 
  365.  filename and the ** by a line number within the file (E4 
  366.  interprets a number after a slash as a line number to go 
  367.  to on start up).
  368.  
  369. SUPPORT ********************************************************
  370.  
  371.  Technical support is available directly from the author 
  372.  by Post or E-Mail to any of the addresses given at the 
  373.  foot of this document. E-mail is preferred.
  374.  
  375.  Support is available whether or not you are a registered 
  376.  user: We want you to be happy with E4 before you buy it.
  377.  
  378. ORDERING and PAYMENT *******************************************
  379.  
  380.  This software has been made available so that potential 
  381.  users may try it out before committing to buy it. If you 
  382.  think that you have already paid for this software then 
  383.  you have been mislead by whoever took your money. Many 
  384.  organisations charge a copying fee for providing 
  385.  evaluation copies of software like this, which is 
  386.  legitimate within the limits detailed in the VENDOR.DOC 
  387.  file. Others, who may also be charging a higher fee, do 
  388.  not make it clear that you are paying them a service 
  389.  charge for providing you with an evaluation copy of the 
  390.  software.
  391.  
  392.  You must pay for this software if you continue to use 
  393.  it. This is copyrighted commercial software. The term 
  394.  "Shareware" is often applied to software marketed in 
  395.  this way, but it must not be confused with free software 
  396.  such as that in the Public Domain (PD).
  397.  
  398.  To pay for this software please examine the file 
  399.  E4ORDER.TXT, which is a registration and order form. You 
  400.  can fill this in before or after printing it out. 
  401.  Alternatively any form of order may be used provided 
  402.  that all the information requested in the text file is 
  403.  provided. Always quote the issue number given on that 
  404.  form (the same Issue Number appears in the editor banner 
  405.  screen).
  406.  
  407.  In exchange for payment you will receive a version of 
  408.  the software without the registration reminders, and 
  409.  which is registered to you personally. The price 
  410.  includes both E4 and E4-Deluxe, a comprehensive printed 
  411.  manual and extra utility programs and macros.
  412.  
  413.  Note that this registered version may not be distributed 
  414.  in any way and must be treated like any other commercial 
  415.  program. Please refer to the licence agreements below.
  416.  
  417. EXTRAS *********************************************************
  418.  
  419.  The following extra programs (at least) are shipped with 
  420.  the registered version of the editor:
  421.  
  422.  E4SM    a program to set special text modes on VGA/EGA 
  423.      cards. It also analyses your VGA card to find 
  424.      out what special text modes are available.
  425.  
  426.  E4TRAP    a program to trap error output from a range of 
  427.      compilers so that E4 can perform error tracking. 
  428.      Currently supported compilers include Borland 
  429.      C/C++, Turbo Pascal, Turbo Linker, Turbo 
  430.      Assembler, Microsoft C, MASM, Fitted Software 
  431.      Modula-2, Zortech C/C++ and others. Other 
  432.      compilers will be added in the future.
  433.      
  434.      Many compilers that are not listed will also 
  435.      work, if they generate standard error messages. 
  436.      Contact us if your compiler is not listed, we 
  437.      will add it if necessary.
  438.  
  439.  E4PRINT    a program to print E4 wordwrap files (and 
  440.      ordinary text files) on normal and PostScript 
  441.      printers.
  442.  
  443.  A library of useful programmer's macros is also 
  444.  provided.
  445.  
  446. LICENCE AGREEMENTS *********************************************
  447.  
  448.  "The software" refers in this case to the E4 editor and 
  449.  any associated documentation and/or additional programs 
  450.  or other items.
  451.  
  452.  "The purchaser" is that person or organisation that pays 
  453.  the fee for the software.
  454.  
  455. Licence for the Unregistered Version (this version) ************
  456.  
  457.  This software is copyrighted and any duplication other 
  458.  than under the terms of this agreement is a breach of 
  459.  copyright law. You are given permission to duplicate the 
  460.  software to give to others provided that you do not make 
  461.  any changes to the software and that you distribute it 
  462.  complete (preferably as the single self-extracting 
  463.  archive file described above). You must not make a 
  464.  charge for providing a copy of the software other than 
  465.  within the limits detailed in the VENDOR.DOC file.
  466.  
  467.  You are permitted to use the editor for a period not 
  468.  exceeding 30 days beginning from the date of first use. 
  469.  After this time you must pay if you wish to continue 
  470.  using it, even if you intend to do so only infrequently. 
  471.  If you do not purchase your own copy then you should 
  472.  keep the software only in its archived (unusable) form 
  473.  for the purposes of giving it to others.
  474.  
  475. Licences for the Commercial Version ****************************
  476.  
  477.  This software is copyrighted and any duplication other 
  478.  than under the terms of this agreement is a breach of 
  479.  copyright law. 
  480.  
  481.  Payment of the registration fee gains for the purchaser 
  482.  one or more disks and a licence to use the software 
  483.  contained on those disks subject to the conditions 
  484.  detailed below. 
  485.  
  486.  Single user Licence ************************************
  487.   
  488.   The software provided upon payment of the 
  489.   registration fee may not be duplicated other 
  490.   than for the purposes of installing it on one or 
  491.   more computers owned by the purchaser of the 
  492.   software, and/or for a single "back-up" copy of 
  493.   the supplied original disk or disks. The 
  494.   purchaser may install the software on more than 
  495.   one computer provided that there is no 
  496.   possibility that more than a single copy of the 
  497.   software be in use at any instant.
  498.   
  499.  Network Licence ****************************************
  500.   
  501.   Purchase of a network licence allows you to 
  502.   install the software on a single file server 
  503.   only (NOT a node in a peer-to-peer network). The 
  504.   software may be used only by machines attached 
  505.   to that network that are using that server. The 
  506.   software may not be installed on any other 
  507.   computer.
  508.   
  509.   You must take all reasonable precautions to 
  510.   prevent unauthorised copying. For example, for a 
  511.   Novell network you must set the Execute Only 
  512.   attribute for all executables that form part of 
  513.   the software.
  514.  
  515. AFTERWORD and ADDRESSES ****************************************
  516.  
  517.  Thank you for taking the time to wade through this file. 
  518.  Please try out the program and send me your comments, 
  519.  even if you choose not to continue using E4!
  520.  
  521.  Author:            UK Distributors:
  522.  Neil Faulks        Business Consultants Ltd.
  523.  96 Middle Lane        37 York Road
  524.  Crouch End        Woking
  525.  London            Surrey
  526.  England            England
  527.  N8 8NT            GU22 7XN
  528.  
  529.  E-mail:        neil@dcs.kcl.ac.uk
  530.  CompuServe:    >INTERNET:neil@dcs.kcl.ac.uk
  531.  
  532.  [Note that my previous address of 28 Clickett Hill, 
  533.  Basildon, Essex, SS14 1NW will also be valid for some 
  534.  years to come, but I prefer post to be sent to the above 
  535.  address]
  536.  
  537. End-of-File
  538.