OEMACS Release 4.1 (BETA RELEASE) August 22, 1993 This document describes how to install OEmacs. ********************* ***** IMPORTANT ***** ********************* Backup your hard disk before using this version of Emacs. Although there are no known bugs that will cause filesystem corruption, there may be some. Before you can use this version of Emacs, you must have a 386 or better processor with at least 4MB of motherboard RAM (8MB is recommended). If you want to use this version within a Windows DOS box, you should have at least 8MB of motherboard RAM, and having 12-16MB is strongly recommended. Also note that oemacs, like demacs, uses "/" as the directory separator, and not "\". As a matter of fact, "\" will not work, except in filenames on the command line. ***** Installation instructions OEmacs currently comes in three different versions: 1. A DJGPP-compiled version. This version starts up relatively quickly, but requires a numeric coprocessor to work within a Windows DOS box. 2. A WATCOM C/386-compiled version. This version does not need a numeric coprocessor to work within a Windows DOS box, but it takes a while to start up (about 20 seconds on a 33MHz 486DX), and requires much more disk space. 3. A DJGPP-compiled version for use with DESQview/X. This version provides full multi-frame capability and starts up relatively quickly, but will only run under DESQview/X. To install a particular version, see one of the following sections: Installing the DJGPP-compiled version Installing the WATCOM C/386-compiled version Installing the DESQview/X version ***** Installing the DJGPP-compiled version To install this version, you need the files "oe41gbin.zip" and "oe41min.zip". Any other .zip files are optional. You will need about 3MB of disk space to install this version. The exact amount required will depend on your disk's cluster size. To install the DJGPP-compiled version: 1. Extract the files into some convenient directory. Note that all of the .zip files *MUST* be extracted from the *SAME* directory. All of the files should have been extracted into a subdirectory called "emacs-19.19". If this did not happen, you are using pkunkip (as opposed to the "free" "unzip" program) and probably forgot to specify the "-d" option to preserve the directory structure. In this case, delete the files and try re-extracting them. If you extract any optional .zip files, you *MUST* extract all of the .zip files from the *SAME* directory. 2. Make sure that you have at least 200-250 bytes of free environment space. Various batch files set a number of environment variables, and Emacs will not run properly if setting these environment variables fails. 3. If you are using DOS 5.0 or later, edit the file "emacs-19.19/bin/emacs.bat" to reflect where you extracted the OEmacs files (see the comments in this file for more information), and copy this batch file to some convenient directory listed in your %PATH environment variable. Similarly, if you are using DOS 4.0 or earlier, edit the file "emacs-19.19/bin/emacs2.bat" to reflect where you extracted the OEmacs files, and copy this batch file to some convenient directory listed in your %PATH environment variable. Rename the copied file to "emacs.bat". Also, see the comments in the batch file for anything else that may need to be edited. NOTE: if you try to be "smart" and ignore part of the above instructions by adding "emacs-19.19/bin" to your %PATH environment variable, note that you will still have to copy the "emacs.bat" file to a DIFFERENT directory, one that is EARLIER in the list of directories listed in %PATH (either that, or set all of the appropriate environment variables in your AUTOEXEC.BAT file). This restriction is imposed by the fact that "emacs-19.19/bin" contains both an "emacs.bat" and an "emacs.exe". 4. That should be it. You should now be able to start OEmacs by typing "emacs" and pressing [Enter]. To exit Emacs, press Ctrl-X Ctrl-C. ***** Installing the WATCOM C/386-compiled version To install this version, you need the following files: oe41wbin.zip oe41min.zip oe41el1.zip oe41el2.zip oe41el3.zip Any other .zip files are optional. Note that oe41min.zip contains files that are duplicated in other .zip files; all of the duplicated files should be identical, and so you can tell unzip to overwrite files. You will need about 14MB of disk space to install this version. The exact amount required will depend on your disk's cluster size. To install the WATCOM C/386-compiled version: 1. Extract the files into some convenient directory. Note that all of the .zip files *MUST* be extracted from the *SAME* directory. All of the files should have been extracted into a subdirectory called "emacs-19.19". If this did not happen, you are using pkunkip (as opposed to the "free" "unzip" program) and probably forgot to specify the "-d" option to preserve the directory structure. In this case, delete the files and try re-extracting them. If you extract any optional .zip files, you *MUST* extract all of the .zip files from the *SAME* directory. 2. Make sure that you have at least 200-250 bytes of free environment space. Various batch files set a number of environment variables, and Emacs will not run properly if setting these environment variables fails. 3. If you are using DOS 5.0 or later, edit the file "emacs-19.19/bin.wat/emacs.bat" to reflect where you extracted the OEmacs files, and copy this batch file to some convenient directory listed in your %PATH environment variable. Similarly, if you are using DOS 4.0 or earlier, edit the file "emacs-19.19/bin.wat/emacs2.bat" to reflect where you extracted the OEmacs files, and copy this batch file to some convenient directory listed in your %PATH environment variable. Rename the copied file to "emacs.bat". Also, see the comments in the batch file for anything else that may need to be edited. In particular, if you have one of the following machines, see the section below on the "DOS/4GW DOS extender": NEC 98-series Fujitsu FMR-60,-70 Hitachi B32 OKI if800 If you have one of these machines, you must set additional variables in "emacs.bat"; if you don't, then Emacs will not work. 4. Do one of the following: * Add the directory "emacs-19.19/bin.wat" to your %PATH environment variable (but add the absolute path, not the relative one). * Copy or move the following files into an existing directory listed in your %PATH environment variable: emacs-19.19/bin.wat/dos4gw.exe emacs-19.19/bin.wat/go32.exe (Even though Emacs may be compiled with WATCOM C/386, the support programs "make-doc.exe" and "etags.exe" are compiled using DJGPP.) 5. If you do not have a numeric coprocessor, you will have to manually add a driver to your Windows 3.1 SYSTEM.INI file. If you do not have a numeric coprocessor, you must add a line like the following to the [386Enh] section of your SYSTEM.INI file: device=c:\emacs-19.19\bin.wat\wemu387.386 Edit the above line to reflect where the "wemu387.386" file exists. If you have a numeric coprocessor, you do not need this driver. 6. That should be it. At this point, you should be able to run Emacs by typing "emacs" and pressing [Enter]. To exit Emacs, press Ctrl-X Ctrl-C. ***** Installing the DESQview/X version To install this version, you need the files "oe41xbin.zip" and "oe41min.zip". Any other .zip files are optional. You will need about 3MB of disk space to install this version. The exact amount required will depend on your disk's cluster size. Note: see the file "readme.dvx" for more information. To install the DESQview/X version: 1. Extract the files into some convenient directory. Note that all of the .zip files *MUST* be extracted from the *SAME* directory. All of the files should have been extracted into a subdirectory called "emacs-19.19". If this did not happen, you are using pkunkip (as opposed to the "free" "unzip" program) and probably forgot to specify the "-d" option to preserve the directory structure. In this case, delete the files and try re-extracting them. If you extract any optional .zip files, you *MUST* extract all of the .zip files from the *SAME* directory. 2. Make sure that you have at least 200-250 bytes of free environment space. Various batch files set a number of environment variables, and Emacs will not run properly if setting these environment variables fails. 3. If you are using DOS 5.0 or later, edit the file "emacs-19.19/bin.dvx/emacs.bat" to reflect where you extracted the OEmacs files (see the comments in this file for more information), and copy this batch file to some convenient directory listed in your %PATH environment variable. Similarly, if you are using DOS 4.0 or earlier, edit the file "emacs-19.19/bin.dvx/emacs2.bat" to reflect where you extracted the OEmacs files, and copy this batch file to some convenient directory listed in your %PATH environment variable. Rename the copied file to "emacs.bat". Also, see the comments in the batch file for anything else that may need to be edited. NOTE: if you try to be "smart" and ignore part of the above instructions by adding "emacs-19.19/bin.dvx" to your %PATH environment variable, note that you will still have to copy the "emacs.bat" file to a DIFFERENT directory, one that is EARLIER in the list of directories listed in %PATH (either that, or set all of the appropriate environment variables in your AUTOEXEC.BAT file). This restriction is imposed by the fact that "emacs-19.19/bin.dvx" contains both an "emacs.bat" and an "emacs.exe". 4. That should be it. You should now be able to start OEmacs by typing "emacs" and pressing [Enter]. To exit Emacs, press Ctrl-X Ctrl-C. ******************************************************************************* ***** The DOS/4GW DOS extender: ************* * IMPORTANT * ************* +--------------------------------------------------------------------- | If you have any of the following machines, you MUST set the | DOS16M environment variable before you can use this version of | emacs: | | NEC 98-series | Fujitsu FMR-60,-70 | Hitachi B32 | OKI if800 | | See below for more information. +--------------------------------------------------------------------- The DOS/4GW DOS extender, used and required by this version of Emacs, is a royalty-free DOS extender from Rational Systems. It must be placed in a directory in %PATH, and it can be controlled through through the use of the following environment variables: DOS4G -- Suppresses printout of DOS/4GW startup message. DOS16M -- Controls how 32-bit memory is used and accessed. DOS4GVM -- Enables and controls virtual memory (outside of Windows). * DOS4G: The DOS4G variable can be set to "quiet", which suppresses the display of the DOS/4GW startup message, e.g., set DOS4G=QUIET * DOS16M: [ Note: not all options for the DOS16M variable are documented in the following. ] The DOS16M variable takes values of the form: [<switch_mode>][@<start_address>[-<end_address>]][:<size>] The "<switch_mode>" value, which MUST be specified if you have an NEC 98-series, Fujitsu FMR-60,-70, Hitachi B32, or OKI if800 machine, can take one of the following values: Value Meaning -------------------------------------------------------------------- 0 Use DPMI to access 32-bit memory (automatically set if present). 1 Use a method specific to the NEC 98-series machine. You MUST specify a start/stop range of memory to use. 2 Use a method specific to the PS/2 (automatically set if necessary). 3 Use a method specific to a generic 386/486 machine (automatically set if necessary). INBOARD Use a method specific for a 386 with an Intel Inboard (automatically set if necessary). 5 Use a method specific to the Fujitsu FMR-70 machine. You MUST specify a start/stop range of memory to use. 11 Use VCPI to access 32-bit memory (automatically set if present). 14 Use a method specific to the Hitachi B32 machine. You MUST specify a start/stop range of memory to use. 15 Use a method specific to the OKI if800 machine. You MUST specify a start/stop range of memory to use. 16 Use a method specific to PS/55s. This setting may be needed for some PS/55s, and note that this is NOT automatically detected and used. Note that, for most machines, the correct value for "<switch_mode>" is automatically detected and used. The "<start_address>" and "<end_address>" values specify a range of extended memory to use. This is only necessary if neither DPMI nor VCPI is available (these values are ignored if DMPI or VCPI is available). Values can be specified as decimal or hexadecimal (prefixed with "0x"), and are assumed to be values in kilobytes, unless an "M" (for "megabytes") is appended to the end of the number. The "<size>" value specifies the maximum amount of memory that can be allocated. Values can be specified as decimal or hexadecimal (prefixed with "0x"), and are assumed to be values in kilobytes, unless an "M" (for "megabytes") is appended to the end of the number. If both a memory range ("<start_address"/"<end_address>") and a "<size>" are given, the more restrictive of the two are used. Examples: set DOS16M=:2M Use up to 2MB of extended memory. The method used to access 32-bit memory will be automatically determined (for those machines where it can be done). set DOS16M=14@4M-8M This tells DOS/4GW that an Hitachi B32 machine is being used, and that memory from address 0x00400000 (4 megabytes) to address 0x00800000 (8 megabytes) should be used. * DOS4GVM: [ Note: not all options for the DOS4GVM variable are documented in the following. ] The DOS4GVM variable is used to enable and control virtual memory. To enable virtual memory support, you can set DOS4GVM to one of the following values: set DOS4GVM=1 set DOS4GVM=@<control_filename> The first form, "set DOS4GVM=1", enables virtual memory with default values for all parameters. The second form enables virtual memory, and allows you to specify a file that contains values for some or all parameters (the filename must have the extension ".VMC"). The settable parameters are (all numeric values must be specified in kilobytes): VIRTUALSIZE This is the size of the virtual memory space. The default is 16384KB (16MB). MINMEM This is the minimum amount of RAM to manage. The default is 512KB. MAXMEM This is the maximum amount of RAM to manage. The default is 4096KB (4MB). SWAPMIN This is the minimum or initial size of the swap file. If this is not specified, the initial size will be based upon the "VIRTUALSIZE" parameter. SWAPINC This is the size by which the swap size grows, if the swap has to grow. SWAPNAME This is the name of the swapfile. The default name is "DOS4GVM.SWP", and is placed in the root directory of the CURRENT drive (not the boot drive). It's best if you specify a complete pathname (w/drive letter) here. DELETESWAP If given, the swapfile is deleted when the program exits. Normally, the swapfile is NOT deleted when the program exits, which means that the program will startup faster the next time (it doesn't have to recreate the swapfile). Unlike the other options, this parameter does not take any values. IMPORTANT: The file containing the parameters must NOT have any blank lines, as parameter processing STOPS at the first blank line. An example of a .VMC file is: ! Example .VMC file. ! Comments start with "!". ! Set the virtual memory size: virtualsize = 32768 ! The minimum amount of ram used is: minmem = 4096 ! The maximum amount of ram used is: maxmem = 8192 ! Delete the swapfile when the program terminates: deleteswap ! The name of the swapfile is: swapname = c:\myswap.swp