msdos/INSTALL

   1 GNU Emacs Installation Guide for the DJGPP (a.k.a. MS-DOS) port
   2
   3 Copyright (C) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
   4 2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   5 See the end of the file for license conditions.
   6
   7 The DJGPP port of GNU Emacs builds and runs on plain DOS and also on
   8 all versions of MS-Windows from version 3.X on, including Windows XP,
   9 Vista, and Windows 7 (however, see below for issues with Windows Vista
  10 and 7).
  11
  12 To build and install the DJGPP port, you need to have the DJGPP ports
  13 of GCC (the GNU C compiler), GNU Make, rm, mv, and sed.  See the
  14 remarks in CONFIG.BAT for more information about locations and
  15 versions.  The Emacs FAQ (see info/efaq) includes pointers to Internet
  16 sites where you can find the necessary utilities; search for "MS-DOS".
  17 The configuration step (see below) will test for these utilities and
  18 will refuse to continue if any of them isn't found.
  19
  20 Bootstrapping Emacs or recompiling Lisp files in the `lisp'
  21 subdirectory using the various targets in the lisp/Makefile file
  22 requires additional utilities: `find' (from Findutils), GNU `echo' and
  23 `test' (from Sh-utils or Coreutils), `ls' and `chmod' (from Fileutils
  24 or Coreutils), `grep' (from Grep), and a port of Bash.  However, you
  25 should not normally need to run lisp/Makefile, as all the Lisp files
  26 are distributed in byte-compiled form as well.  As for bootstrapping
  27 itself, you will only need that if you check-out development sources
  28 from the Emacs source repository.
  29
  30 If you are building the DJGPP version of Emacs on a DOS-like system
  31 which supports long file names (e.g. Windows 9X or Windows XP), you
  32 need to make sure that long file names are handled consistently both
  33 when you unpack the distribution and compile it.  With DJGPP v2.0 or
  34 later, long file names support is by default, so you need to unpack
  35 Emacs distribution in a way that doesn't truncate the original long
  36 filenames to the DOS 8.3 namespace; the easiest way to do this is to
  37 use djtar program which comes with DJGPP, since it will behave
  38 consistently with the rest of DJGPP tools.  Alternatively, you can
  39 build Emacs with LFN=n, if some of your tools don't support long file
  40 names: just ensure that LFN is set to `n' during both unpacking and
  41 compiling.
  42
  43 (By the time you read this, you have already unpacked the Emacs
  44 distribution, but if the explanations above imply that you should have
  45 done it differently, it's safer to delete the directory tree created
  46 by the unpacking program and unpack Emacs again, than to risk running
  47 into strange problems during the build process.)
  48
  49 It is important to understand that the runtime support of long file
  50 names by the Emacs binary is NOT affected by the LFN setting during
  51 compilation; Emacs compiled with DJGPP v2.0 or later will always
  52 support long file names on Windows no matter what was the setting
  53 of LFN at compile time.  However, if you compiled with LFN disabled
  54 and want to enable LFN support after Emacs was already built, you need
  55 to make sure that the support files in the lisp, etc and info
  56 directories are called by their original long names as found in the
  57 distribution.  You can do this either by renaming the files manually,
  58 or by extracting them from the original distribution archive with
  59 djtar after you set LFN=y in the environment.
  60
  61 To unpack Emacs with djtar, type this command:
  62
  63     djtar -x emacs.tgz
  64
  65 (This assumes that the Emacs distribution is called `emacs.tgz' on
  66 your system.)
  67
  68 When unpacking Emacs is done, a directory called `emacs-XX.YY' will be
  69 created, where XX.YY is the Emacs version.
  70
  71 On plain DOS, unpacking can complain about several directories and
  72 files in the `nextstep' subdirectory of the `emacs-XX.YY' top-level
  73 directory.  This is because the names of these files overflow the
  74 67-character limit on the file-name length imposed by DOS filesystems.
  75 When prompted by `djtar' for a different name for these files, just
  76 press [Enter] to skip them: they are not needed for the DJGPP build.
  77
  78 If you want to print international characters, install the intlfonts
  79 distribution.  For this, create a directory called `fonts' under the
  80 `emacs-XX.YY' top-level directory created by unpacking emacs.tgz,
  81 chdir into the directory `emacs-XX.YY/fonts', and type this:
  82
  83     djtar -x intlfonts.tgz
  84
  85 To build and install Emacs, chdir to the `emacs-XX.YY' directory and
  86 type these commands:
  87
  88     config msdos
  89     make install
  90
  91 Running "config msdos" checks for several programs that are required
  92 to configure and build Emacs; if one of those programs is not found,
  93 CONFIG.BAT stops and prints an error message.  If you have DJGPP
  94 version 2.0 or 2.01, it will complain about a program called
  95 DJECHO.EXE.  These old versions of DJGPP shipped that program under
  96 the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
  97 rerun CONFIG.BAT.  If you have neither ECHO.EXE nor DJECHO.EXE, you
  98 should be able to find them in your djdevNNN.zip archive (where NNN is
  99 the DJGPP version number).
 100
 101 On Windows NT and Windows 2000/XP/Vista/7, running "config msdos"
 102 might print an error message like "VDM has been already loaded".  This
 103 is because those systems have a program called `redir.exe' which is
 104 incompatible with a program by the same name supplied with DJGPP,
 105 which is used by config.bat.  To resolve this, move the DJGPP's `bin'
 106 subdirectory to the front of your PATH environment variable.
 107
 108 Windows Vista/7 has several bugs in its DPMI server related to memory
 109 allocation: it fails DPMI resize memory block function, and it
 110 arbitrarily limits the default amount of DPMI memory to 32MB.  To work
 111 around these bugs, first configure Emacs to use the `malloc' function
 112 from the DJGPP library.  To this end, run CONFIG.BAT with the
 113 "--with-system-malloc" option:
 114
 115     config --with-system-malloc msdos
 116     make install
 117
 118 In addition, for Windows Vista you'll need to install Service Pack 1
 119 (SP1) or later and enlarge its DPMI memory limit by setting the value
 120 of this Registry key:
 121
 122   HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Wow\DpmiLimit
 123
 124 Create this key if it does not exist.  The value is a DWORD; setting
 125 it to 536870912 should let Emacs use up to 512MB of memory.
 126
 127 If you have other problems, either building Emacs or running the
 128 produced binary, look in the file etc/PROBLEMS for some known problems
 129 related to the DJGPP port (search for "MS-DOS").
 130
 131 To install the international fonts, chdir to the intlfonts-X.Y
 132 directory created when you unpacked the intlfonts distribution (X.Y is
 133 the version number of the fonts' distribution), and type the following
 134 command:
 135
 136     make bdf INSTALLDIR=..
 137
 138 After Make finishes, you may remove the directory intlfonts-X.Y; the
 139 fonts are installed into the fonts/bdf subdirectory of the top-level
 140 Emacs directory, and that is where Emacs will look for them by
 141 default.
 142
 143 Building Emacs creates executable files in the src and lib-src
 144 directories.  Installing the DJGPP port of Emacs moves these
 145 executables to a sibling directory called bin.  For example, if you
 146 build in directory C:/emacs, installing moves the executables from
 147 C:/emacs/src and C:/emacs/lib-src to the directory C:/emacs/bin, so
 148 you can then delete the subdirectories C:/emacs/src and
 149 C:/emacs/lib-src if you wish.  The only subdirectories you need to
 150 keep are bin, lisp, etc and info.  (If you installed intlfonts, keep
 151 the fonts directory and all its subdirectories as well.)  The bin
 152 subdirectory should be added to your PATH.  The msdos subdirectory
 153 includes a PIF and an icon file for Emacs which you might find useful
 154 if you run Emacs under MS Windows.
 155
 156 Emacs on MSDOS finds the lisp, etc and info directories by looking in
 157 ../lisp, ../etc and ../info, starting from the directory where the
 158 Emacs executable was run from.  You can override this by setting the
 159 environment variables EMACSDATA (for the location of `etc' directory),
 160 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
 161 the location of the `info' directory).
 162
 163 Emacs features which require asynchronous subprocesses that depend on
 164 multitasking do not work in the DJGPP port.  Synchronous subprocesses
 165 do work, so features such as compilation, grep, and Ispell run
 166 synchronously, unlike on other platforms.
 167
 168 Version 2.0 of djgpp has two bugs that affect Emacs.  We've included
 169 corrected versions of two files from djgpp in the msdos subdirectory:
 170 is_exec.c and sigaction.c.  To work around the bugs, compile these
 171 files and link them into temacs.  Djgpp versions 2.01 and later have
 172 these bugs fixed, so upgrade if you can before building Emacs.
 173
 174 \f
 175 This file is part of GNU Emacs.
 176
 177 GNU Emacs is free software: you can redistribute it and/or modify
 178 it under the terms of the GNU General Public License as published by
 179 the Free Software Foundation, either version 3 of the License, or
 180 (at your option) any later version.
 181
 182 GNU Emacs is distributed in the hope that it will be useful,
 183 but WITHOUT ANY WARRANTY; without even the implied warranty of
 184 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 185 GNU General Public License for more details.
 186
 187 You should have received a copy of the GNU General Public License
 188 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.