ET -- a TeX-compatible editor for text containing mathematics

              (Copyright)
              John Collins
              Physics Department
              Pennsylvania State University
              University Park, PA 16802, USA

              +1 (814) 863-0783

              E-mail:  [email protected]


The files in this directory are for the ET editor, which runs on MSDOS
computers (including MS-Windows).  All the files are MSDOS files, and
WHEN DOWNLOADING THEM YOU SHOULD SET THE FILE TYPE TO BINARY OR IMAGE,
as appropriate for your version of ftp.  (This is usually done by the
command binary in a UNIX version of ftp.)  The same remarks apply if
you are subsequently downloading the files to an MSDOS computer from
your mainframe or workstation (etc).  If you do not do this, the
executable files, in particular, will be badly corrupted.

Information on updates is contained in the file aaaupdat, if it
exists.

Information on copyright is in the file copyright.


If you use this program, or have comments, let me know, preferably
by e-mail to the address above.  Any further development of ET depends
on user encouragement of the author!  However



                  INSTALLATION
                  ============

To install ET on a hard disk, use the following procedure:

      1.  Choose, and, if necessary, create a directory on the hard
          disk to hold ET.  In the following, I will assume this
          directory is C:\ET.  This directory will be referred to as
          ET's home directory.
      2.  Ensure that this directory is in the MSDOS path.  Use the PATH
          command for this purpose.  Normally you will modify your
          AUTOEXEC.BAT file to do this.  This will ensure that ET can
          be run no matter what the default directory and drive are.
      3.  Copy the files on the distribution disk to ET's home
          directory. If the distribution disk is in drive A: and the ET
          home directory is C:\ET, then use the command
                       COPY A:*.* C:\ET
      4.  Change default drive and directory to ET's home directory,
          for example by the commands
                       C:
                       CD \ET
      5.  To obtain the documentation, print out the file ETDOC.ET.
          This contains full information on installing and running ET.
          This printout can be obtained by the MSDOS command
                       PRINT ETDOC.ET
          or by the MSDOS command
                       COPY ETDOC.ET PRN
      6.  You now need to install ET itself.  First run ET by the command
                       ET
          Now set the correct home directory for ET.  This will ensure
          that when you run ET it will know where to look to find the
          help file and the default macro file.
               (a) Use the F10 key to access the main menu.
               (b) Press the 'O' key to get the Options menu.
               (c) Press the 'L' key to get the Load File submenu.
               (d) Press the 'H' key to set the Home directory.
               (e) You will be prompted to enter the name (drive and
                   directory) of the home directory.  The current
                   directory's name will be given as the default (C:\ET
                   in our example); if this is satisfactory, press the
                   return key, otherwise type in the name, followed by
                   the return key.
               (f) Press the escape key to back up one level in the menu
                   system.
               (g) Press the 'S' key to save this and other options for
                   ET in its executable file.  Thus the next time the
                   program is run, it will look in the home directory
                   for macro and help files.
               (h) When ET has finished saving the setup, it will
                   display a message.
               (i) Press the escape key to remove the message.
               (j) Press the escape key again to remove the Options
                   menu.
               (k) You should now be at the main menu.   Either type
                   'F' followed by 'Q' to quit ET, or press the escape
                   key to return to text editing.
               (l) If you choose to stay in ET to explore it, note that
                   the <F10> key gets you to the main menu when you are
                   editing text, that the escape key backs you up one
                   level in the menu system, and that the <F1> key will
                   get you help.
               (m) To exit ET, go to the File menu, and type 'Q' (for
                   Quit).

Experienced users will of course be able to modify these instructions as
needed.

Minimum files needed.  If you are short on disk space you may
eliminate a number of the files.  At an absolute minimum you can have
the ET.EXE, VESA16.BGI, ET.HLP, ET.MAC, ETTOTEX.EXE and TEXTOET.EXE.
You will also need PRET.EXE if you plan to print in draft mode on a
dot matrix printer.  You can eliminate ET.HLP if you can get by
without online help; you can eliminate TEXTOET.EXE if you do not wish
to convert TeX files to ET, and you can eliminate ETTOTEX.EXE if you
do not plan to convert ET files to TeX on the computer you are using
to do the editting.

Whenever you configure ET to you different keystrokes for commands, you
will need the ETINST.EXE file and ET.TXT.


The contents of the distribution disk are:
        README           This file
        ET.EXE           The editor.
        VESA16.BGI       Auxiliary file needed to handle graphics
        ET.HLP           Help file for ET.
        ET.MAC           Standard macro definitions.
        ETDOC.ET         Documentation for ET.
        ETTOTEX.EXE      Converts ET file to TeX.
        TEXTOET.EXE      Converts TeX file to ET.
        PRET.EXE         Prints out draft quality version
                         of ET files on EPSON compatible
                         printer.
        PRET1.EXE        An improved version of the PRET
                         program, for printing out draft
                         quality versions of ET files.  It
                         has not been completely checked out
                         though.  Run PRET1 /HELP to see the
                         new features.
        GRKDRAFT.PPR     Downloadable printer font used
                         by PRET, no longer essential.
        KEYS.ET          When printed out using PRET, or
                         displayed on screen using ET,
                         shows the keyboard definition
                         for the Greek/symbol font.
        TEXCORR.ET       When printed out using PRET or
                         displayed on screen using ET,
                         shows the correspondence between
                         the Greek/symbol font and the
                         translation to TeX.
        ETINST.EXE       Program to customize keyboard
                         definition and help file for ET.
        ET.TXT           Uncustomized help file.
        ETMACS.TEX       Macros that let TeX directly
                         handle ET files.
        HW2.ET           Example of ET file that is used
                         only for draft print out by PRET
                         and not with TeX.
        PAPER.ET         Example file: a physics paper using ET.

        ET2TEXC.C        Source code in ANSI C for ET to TeX converter.
                         Can be used to implement ETTOTEX on another
                         computer.
        ETDEFS.H         Include file for ET2TEXC.C
        ETTRAN.INC       Include file for ET2TEXC.C
        ET2TEXKR.C       Kernighan and Ritchie C source code for
                         ETTOTEX -- old-fashioned C. Can be compiled
                         with standard UNIX C compiler.

        LATER.EXE        Program for comparing the date
                         and time of two files.  Useful
                         in batch files for to avoid
                         overwriting a new file by an
                         old file in conversions.  The
                         command
                                 LATER ?
                         will explain how to use it.

The program is copyrighted.  However, use and redistribution are
permitted --- see the file copyright.