home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast.iso / oemacs / install.dos < prev    next >
Text File  |  1994-03-05  |  16KB  |  431 lines
  1.                 OEMACS
  2.                Release 4.1 (BETA RELEASE)
  3.                 August 22, 1993
  4.  
  5.  
  6.      This document describes how to install OEmacs.
  7.  
  8.     *********************
  9.     ***** IMPORTANT *****
  10.     *********************
  11.  
  12.     Backup your hard disk before using this version of Emacs.
  13.     Although there are no known bugs that will cause filesystem
  14.     corruption, there may be some.
  15.  
  16.     Before you can use this version of Emacs, you must have a 386 or
  17.     better processor with at least 4MB of motherboard RAM (8MB is
  18.     recommended).  If you want to use this version within a Windows
  19.     DOS box, you should have at least 8MB of motherboard RAM, and
  20.     having 12-16MB is strongly recommended.
  21.  
  22.     Also note that oemacs, like demacs, uses "/" as the directory
  23.     separator, and not "\".  As a matter of fact, "\" will not work,
  24.     except in filenames on the command line.
  25.  
  26.  
  27. ***** Installation instructions
  28.  
  29.      OEmacs currently comes in three different versions:
  30.  
  31. 1. A DJGPP-compiled version.  This version starts up relatively quickly,
  32.    but requires a numeric coprocessor to work within a Windows DOS box.
  33.  
  34. 2. A WATCOM C/386-compiled version.  This version does not need a
  35.    numeric coprocessor to work within a Windows DOS box, but it takes a
  36.    while to start up (about 20 seconds on a 33MHz 486DX), and requires
  37.    much more disk space.
  38.  
  39. 3. A DJGPP-compiled version for use with DESQview/X.  This version
  40.    provides full multi-frame capability and starts up relatively
  41.    quickly, but will only run under DESQview/X.
  42.  
  43. To install a particular version, see one of the following sections:
  44.  
  45.     Installing the DJGPP-compiled version
  46.     Installing the WATCOM C/386-compiled version
  47.     Installing the DESQview/X version
  48.  
  49.  
  50. ***** Installing the DJGPP-compiled version
  51.  
  52.      To install this version, you need the files "oe41gbin.zip" and
  53. "oe41min.zip".  Any other .zip files are optional.
  54.  
  55.      You will need about 3MB of disk space to install this version.  The
  56. exact amount required will depend on your disk's cluster size.
  57.  
  58. To install the DJGPP-compiled version:
  59.  
  60. 1. Extract the files into some convenient directory.  Note that all of
  61.    the .zip files *MUST* be extracted from the *SAME* directory.
  62.  
  63.    All of the files should have been extracted into a subdirectory
  64.    called "emacs-19.19".  If this did not happen, you are using pkunkip
  65.    (as opposed to the "free" "unzip" program) and probably forgot to
  66.    specify the "-d" option to preserve the directory structure.  In this
  67.    case, delete the files and try re-extracting them.
  68.  
  69.    If you extract any optional .zip files, you *MUST* extract all of the
  70.    .zip files from the *SAME* directory.
  71.  
  72. 2. Make sure that you have at least 200-250 bytes of free environment
  73.    space.  Various batch files set a number of environment variables,
  74.    and Emacs will not run properly if setting these environment
  75.    variables fails.
  76.  
  77. 3. If you are using DOS 5.0 or later, edit the file
  78.    "emacs-19.19/bin/emacs.bat" to reflect where you extracted the OEmacs
  79.    files (see the comments in this file for more information), and copy
  80.    this batch file to some convenient directory listed in your %PATH
  81.    environment variable.
  82.  
  83.    Similarly, if you are using DOS 4.0 or earlier, edit the file
  84.    "emacs-19.19/bin/emacs2.bat" to reflect where you extracted the
  85.    OEmacs files, and copy this batch file to some convenient directory
  86.    listed in your %PATH environment variable.  Rename the copied file to
  87.    "emacs.bat".
  88.  
  89.    Also, see the comments in the batch file for anything else that may
  90.    need to be edited.
  91.  
  92.    NOTE: if you try to be "smart" and ignore part of the above
  93.    instructions by adding "emacs-19.19/bin" to your %PATH environment
  94.    variable, note that you will still have to copy the "emacs.bat" file
  95.    to a DIFFERENT directory, one that is EARLIER in the list of
  96.    directories listed in %PATH (either that, or set all of the
  97.    appropriate environment variables in your AUTOEXEC.BAT file).  This
  98.    restriction is imposed by the fact that "emacs-19.19/bin" contains
  99.    both an "emacs.bat" and an "emacs.exe".
  100.  
  101. 4. That should be it.  You should now be able to start OEmacs by typing
  102.    "emacs" and pressing [Enter].  To exit Emacs, press Ctrl-X Ctrl-C.
  103.  
  104.  
  105. ***** Installing the WATCOM C/386-compiled version
  106.  
  107.      To install this version, you need the following files:
  108.  
  109.     oe41wbin.zip
  110.     oe41min.zip
  111.     oe41el1.zip
  112.     oe41el2.zip
  113.     oe41el3.zip
  114.  
  115. Any other .zip files are optional.  Note that oe41min.zip contains files
  116. that are duplicated in other .zip files; all of the duplicated files
  117. should be identical, and so you can tell unzip to overwrite files.
  118.  
  119.      You will need about 14MB of disk space to install this version.  The
  120. exact amount required will depend on your disk's cluster size.
  121.  
  122. To install the WATCOM C/386-compiled version:
  123.  
  124. 1. Extract the files into some convenient directory.  Note that all of
  125.    the .zip files *MUST* be extracted from the *SAME* directory.
  126.  
  127.    All of the files should have been extracted into a subdirectory
  128.    called "emacs-19.19".  If this did not happen, you are using pkunkip
  129.    (as opposed to the "free" "unzip" program) and probably forgot to
  130.    specify the "-d" option to preserve the directory structure.  In this
  131.    case, delete the files and try re-extracting them.
  132.  
  133.    If you extract any optional .zip files, you *MUST* extract all of the
  134.    .zip files from the *SAME* directory.
  135.  
  136. 2. Make sure that you have at least 200-250 bytes of free environment
  137.    space.  Various batch files set a number of environment variables,
  138.    and Emacs will not run properly if setting these environment
  139.    variables fails.
  140.  
  141. 3. If you are using DOS 5.0 or later, edit the file
  142.    "emacs-19.19/bin.wat/emacs.bat" to reflect where you extracted the
  143.    OEmacs files, and copy this batch file to some convenient directory
  144.    listed in your %PATH environment variable.
  145.  
  146.    Similarly, if you are using DOS 4.0 or earlier, edit the file
  147.    "emacs-19.19/bin.wat/emacs2.bat" to reflect where you extracted the
  148.    OEmacs files, and copy this batch file to some convenient directory
  149.    listed in your %PATH environment variable.  Rename the copied file to
  150.    "emacs.bat".
  151.  
  152.    Also, see the comments in the batch file for anything else that may
  153.    need to be edited.  In particular, if you have one of the following
  154.    machines, see the section below on the "DOS/4GW DOS extender":
  155.  
  156.     NEC 98-series
  157.     Fujitsu FMR-60,-70
  158.     Hitachi B32
  159.     OKI if800
  160.  
  161.    If you have one of these machines, you must set additional variables
  162.    in "emacs.bat"; if you don't, then Emacs will not work.
  163.  
  164. 4. Do one of the following:
  165.  
  166.    * Add the directory "emacs-19.19/bin.wat" to your %PATH environment
  167.      variable (but add the absolute path, not the relative one).
  168.  
  169.    * Copy or move the following files into an existing directory listed
  170.      in your %PATH environment variable:
  171.  
  172.     emacs-19.19/bin.wat/dos4gw.exe
  173.     emacs-19.19/bin.wat/go32.exe
  174.  
  175.      (Even though Emacs may be compiled with WATCOM C/386, the support
  176.      programs "make-doc.exe" and "etags.exe" are compiled using DJGPP.)
  177.  
  178. 5. If you do not have a numeric coprocessor, you will have to manually
  179.    add a driver to your Windows 3.1 SYSTEM.INI file.  If you do not have
  180.    a numeric coprocessor, you must add a line like the following to the
  181.    [386Enh] section of your SYSTEM.INI file:
  182.  
  183.     device=c:\emacs-19.19\bin.wat\wemu387.386
  184.  
  185.    Edit the above line to reflect where the "wemu387.386" file exists.
  186.  
  187.    If you have a numeric coprocessor, you do not need this driver.
  188.  
  189. 6. That should be it.  At this point, you should be able to run Emacs by
  190.    typing "emacs" and pressing [Enter].  To exit Emacs, press Ctrl-X
  191.    Ctrl-C.
  192.  
  193.  
  194. ***** Installing the DESQview/X version
  195.  
  196.      To install this version, you need the files "oe41xbin.zip" and
  197. "oe41min.zip".  Any other .zip files are optional.
  198.  
  199.      You will need about 3MB of disk space to install this version.  The
  200. exact amount required will depend on your disk's cluster size.
  201.  
  202.      Note: see the file "readme.dvx" for more information.
  203.  
  204. To install the DESQview/X version:
  205.  
  206. 1. Extract the files into some convenient directory.  Note that all of
  207.    the .zip files *MUST* be extracted from the *SAME* directory.
  208.  
  209.    All of the files should have been extracted into a subdirectory
  210.    called "emacs-19.19".  If this did not happen, you are using pkunkip
  211.    (as opposed to the "free" "unzip" program) and probably forgot to
  212.    specify the "-d" option to preserve the directory structure.  In this
  213.    case, delete the files and try re-extracting them.
  214.  
  215.    If you extract any optional .zip files, you *MUST* extract all of the
  216.    .zip files from the *SAME* directory.
  217.  
  218. 2. Make sure that you have at least 200-250 bytes of free environment
  219.    space.  Various batch files set a number of environment variables,
  220.    and Emacs will not run properly if setting these environment
  221.    variables fails.
  222.  
  223. 3. If you are using DOS 5.0 or later, edit the file
  224.    "emacs-19.19/bin.dvx/emacs.bat" to reflect where you extracted the
  225.    OEmacs files (see the comments in this file for more information),
  226.    and copy this batch file to some convenient directory listed in
  227.    your %PATH environment variable.
  228.  
  229.    Similarly, if you are using DOS 4.0 or earlier, edit the file
  230.    "emacs-19.19/bin.dvx/emacs2.bat" to reflect where you extracted the
  231.    OEmacs files, and copy this batch file to some convenient directory
  232.    listed in your %PATH environment variable.  Rename the copied file to
  233.    "emacs.bat".
  234.  
  235.    Also, see the comments in the batch file for anything else that may
  236.    need to be edited.
  237.  
  238.    NOTE: if you try to be "smart" and ignore part of the above
  239.    instructions by adding "emacs-19.19/bin.dvx" to your %PATH
  240.    environment variable, note that you will still have to copy the
  241.    "emacs.bat" file to a DIFFERENT directory, one that is EARLIER in
  242.    the list of directories listed in %PATH (either that, or set all of
  243.    the appropriate environment variables in your AUTOEXEC.BAT file).
  244.    This restriction is imposed by the fact that "emacs-19.19/bin.dvx"
  245.    contains both an "emacs.bat" and an "emacs.exe".
  246.  
  247. 4. That should be it.  You should now be able to start OEmacs by typing
  248.    "emacs" and pressing [Enter].  To exit Emacs, press Ctrl-X Ctrl-C.
  249.  
  250.  
  251.  
  252.  
  253.  
  254. *******************************************************************************
  255. ***** The DOS/4GW DOS extender:
  256.  
  257.      *************
  258.      * IMPORTANT *
  259.      *************
  260.      +---------------------------------------------------------------------
  261.      | If you have any of the following machines, you MUST set the
  262.      | DOS16M environment variable before you can use this version of
  263.      | emacs:
  264.      |
  265.      |        NEC 98-series
  266.      |        Fujitsu FMR-60,-70
  267.      |        Hitachi B32
  268.      |        OKI if800
  269.      |
  270.      | See below for more information.
  271.      +---------------------------------------------------------------------
  272.  
  273.      The DOS/4GW DOS extender, used and required by this version of
  274. Emacs, is a royalty-free DOS extender from Rational Systems.  It must
  275. be placed in a directory in %PATH, and it can be controlled through
  276. through the use of the following environment variables:
  277.  
  278.     DOS4G    -- Suppresses printout of DOS/4GW startup message.
  279.     DOS16M    -- Controls how 32-bit memory is used and accessed.
  280.     DOS4GVM -- Enables and controls virtual memory (outside of
  281.            Windows).
  282.  
  283. * DOS4G:
  284.  
  285.      The DOS4G variable can be set to "quiet", which suppresses the
  286. display of the DOS/4GW startup message, e.g.,
  287.  
  288.     set DOS4G=QUIET
  289.  
  290.  
  291. * DOS16M:
  292.  
  293. [ Note: not all options for the DOS16M variable are documented in the
  294.   following. ]
  295.  
  296.      The DOS16M variable takes values of the form:
  297.  
  298.      [<switch_mode>][@<start_address>[-<end_address>]][:<size>]
  299.  
  300. The "<switch_mode>" value, which MUST be specified if you have an NEC
  301. 98-series, Fujitsu FMR-60,-70, Hitachi B32, or OKI if800 machine, can
  302. take one of the following values:
  303.  
  304.     Value        Meaning
  305.        --------------------------------------------------------------------
  306.     0        Use DPMI to access 32-bit memory (automatically
  307.             set if present).
  308.     1        Use a method specific to the NEC 98-series
  309.             machine.  You MUST specify a start/stop range of
  310.             memory to use.
  311.     2        Use a method specific to the PS/2 (automatically
  312.             set if necessary).
  313.     3        Use a method specific to a generic 386/486
  314.             machine (automatically set if necessary).
  315.     INBOARD        Use a method specific for a 386 with an Intel
  316.             Inboard (automatically set if necessary).
  317.     5        Use a method specific to the Fujitsu FMR-70
  318.             machine.  You MUST specify a start/stop range of
  319.             memory to use.
  320.     11        Use VCPI to access 32-bit memory (automatically
  321.             set if present).
  322.     14        Use a method specific to the Hitachi B32
  323.             machine.  You MUST specify a start/stop range of
  324.             memory to use.
  325.     15        Use a method specific to the OKI if800 machine.
  326.             You MUST specify a start/stop range of memory to
  327.             use.
  328.     16        Use a method specific to PS/55s.  This setting
  329.             may be needed for some PS/55s, and note that
  330.             this is NOT automatically detected and used.
  331.  
  332. Note that, for most machines, the correct value for "<switch_mode>" is
  333. automatically detected and used.
  334.  
  335.      The "<start_address>" and "<end_address>" values specify a range of
  336. extended memory to use.  This is only necessary if neither DPMI nor VCPI
  337. is available (these values are ignored if DMPI or VCPI is available).
  338. Values can be specified as decimal or hexadecimal (prefixed with "0x"),
  339. and are assumed to be values in kilobytes, unless an "M" (for
  340. "megabytes") is appended to the end of the number.
  341.  
  342.      The "<size>" value specifies the maximum amount of memory that can
  343. be allocated.  Values can be specified as decimal or hexadecimal
  344. (prefixed with "0x"), and are assumed to be values in kilobytes, unless
  345. an "M" (for "megabytes") is appended to the end of the number.
  346.  
  347.      If both a memory range ("<start_address"/"<end_address>") and a
  348. "<size>" are given, the more restrictive of the two are used.
  349.  
  350.      Examples:
  351.  
  352.     set DOS16M=:2M
  353.  
  354. Use up to 2MB of extended memory.  The method used to access 32-bit
  355. memory will be automatically determined (for those machines where it can
  356. be done).
  357.  
  358.     set DOS16M=14@4M-8M
  359.  
  360. This tells DOS/4GW that an Hitachi B32 machine is being used, and that
  361. memory from address 0x00400000 (4 megabytes) to address 0x00800000 (8
  362. megabytes) should be used.
  363.  
  364.  
  365. * DOS4GVM:
  366.  
  367. [ Note: not all options for the DOS4GVM variable are documented in the
  368.   following. ]
  369.  
  370.      The DOS4GVM variable is used to enable and control virtual memory.
  371. To enable virtual memory support, you can set DOS4GVM to one of the
  372. following values:
  373.  
  374.     set DOS4GVM=1
  375.     set DOS4GVM=@<control_filename>
  376.  
  377. The first form, "set DOS4GVM=1", enables virtual memory with default
  378. values for all parameters.  The second form enables virtual memory, and
  379. allows you to specify a file that contains values for some or all
  380. parameters (the filename must have the extension ".VMC").
  381.  
  382.      The settable parameters are (all numeric values must be specified
  383. in kilobytes):
  384.  
  385.     VIRTUALSIZE
  386.         This is the size of the virtual memory space.  The
  387.         default is 16384KB (16MB).
  388.     MINMEM
  389.         This is the minimum amount of RAM to manage.  The
  390.         default is 512KB.
  391.     MAXMEM
  392.         This is the maximum amount of RAM to manage.  The
  393.         default is 4096KB (4MB).
  394.     SWAPMIN
  395.         This is the minimum or initial size of the swap file.
  396.         If this is not specified, the initial size will be based
  397.         upon the "VIRTUALSIZE" parameter.
  398.     SWAPINC
  399.         This is the size by which the swap size grows, if the
  400.         swap has to grow.
  401.     SWAPNAME
  402.         This is the name of the swapfile.  The default name is
  403.         "DOS4GVM.SWP", and is placed in the root directory of
  404.         the CURRENT drive (not the boot drive).  It's best if
  405.         you specify a complete pathname (w/drive letter) here.
  406.     DELETESWAP
  407.         If given, the swapfile is deleted when the program
  408.         exits.  Normally, the swapfile is NOT deleted when the
  409.         program exits, which means that the program will startup
  410.         faster the next time (it doesn't have to recreate the
  411.         swapfile).  Unlike the other options, this parameter
  412.         does not take any values.
  413.  
  414. IMPORTANT: The file containing the parameters must NOT have any blank
  415. lines, as parameter processing STOPS at the first blank line.
  416.  
  417.      An example of a .VMC file is:
  418.  
  419. ! Example .VMC file.
  420. ! Comments start with "!".
  421. ! Set the virtual memory size:
  422. virtualsize = 32768
  423. ! The minimum amount of ram used is:
  424. minmem = 4096
  425. ! The maximum amount of ram used is:
  426. maxmem = 8192
  427. ! Delete the swapfile when the program terminates:
  428. deleteswap
  429. ! The name of the swapfile is:
  430. swapname = c:\myswap.swp
  431.