X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/91074c048b770f8e583bfffddfd723921a33633d..ae4c58a755c319d92d9b884a2cb71ec0efa76382:/INSTALL
diff --git a/INSTALL b/INSTALL
index a51327e6a6..ad4f987e7d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,6 @@
GNU Emacs Installation Guide
-Copyright (c) 1992, 1994, 1996, 1997, 2000, 2001 Free software Foundation, Inc.
+Copyright (c) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2006
+Free software Foundation, Inc.
See the end of the file for copying permissions.
@@ -59,7 +60,7 @@ that, so please refer to them if the simple procedure does not work.
with some non-default options), always clean the source
directories before running `configure' again:
- make distclean
+ make distclean
./configure
5. Invoke the `make' program:
@@ -93,13 +94,13 @@ ADDITIONAL DISTRIBUTION FILES
* intlfonts-VERSION.tar.gz
-The intlfonts distribution contains X11 fonts that Emacs needs in
-order to display international characters. If you see a non-ASCII
-character appear as a hollow box, that means you don't have a font for
-it. You might find a font in the intlfonts distribution. If you do
-have a font for a non-ASCII character, but some characters don't look
-right, or appear improperly aligned, a font from the intlfonts
-distribution might look better.
+The intlfonts distribution contains X11 fonts in various encodings
+that Emacs can use to display international characters. If you see a
+non-ASCII character appear as a hollow box, that means you don't have
+a font for it. You might find one in the intlfonts distribution. If
+you do have a font for a non-ASCII character, but some characters
+don't look right, or appear improperly aligned, a font from the
+intlfonts distribution might look better.
The fonts in the intlfonts distribution are also used by the ps-print
package for printing international characters. The file
@@ -127,19 +128,19 @@ colored icons in the toolbar if XPM support is not compiled in.
Here's the list of these optional libraries, and the URLs where they
can be found:
- . libXaw3d for fancy 3D-style
+ . libXaw3d for fancy 3D-style
scroll bars: ftp://ftp.x.org/contrib/widgets/Xaw3d/
. libxpm for XPM: ftp://ftp.x.org/contrib/libraries/
- Get version 3.4k or later, which lets Emacs
+ Get version 3.4k or later, which lets Emacs
use its own color allocation functions.
- . libpng for PNG: ftp://www.libpng.org/pub/png/
- . libz (for PNG): http://www.info-zip.org/pub/infozip/zlib/
+ . libpng for PNG: ftp://ftp.simplesystems.org/pub/libpng/png/
+ . libz (for PNG): http://www.zlib.net/
. libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
Get version 6b -- 6a is reported to fail in
Emacs.
. libtiff for TIFF: http://www.libtiff.org/
- . libungif for GIF:
- http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
+ . libungif for GIF:
+ http://sourceforge.net/projects/libungif
Ensure you get version 4.1.0b1 or higher of libungif -- a bug in
4.1.0 can crash Emacs.
@@ -152,18 +153,49 @@ configure should avoid such old versions. If that happens, use the
* Extra fonts
+The Emacs distribution does not include fonts and does not install
+them. You must do that yourself.
+
To take proper advantage of Emacs 21's mule-unicode charsets, you need
-a Unicode font. For information on Unicode fonts for X, see
-,
- and
+a suitable font. For `Unicode' (ISO 10646) fonts for X, see
+ (packaged in Debian),
+ (packaged in Debian). (In
+recent Debian versions, there is an extensive `misc-fixed' iso10646-1
+in the default X installation.) Perhaps also see
.
+
has basic fonts for Emacs's
ISO-8859 charsets.
-XFree86 release 4 (from and mirrors)
+XFree86 release 4 (from and mirrors)
contains font support for most, if not all, of the charsets that Emacs
-supports. The font files should be usable separately with older X
-releases.
+currently supports, including iso10646-1 encoded fonts for use with
+the mule-unicode charsets. The font files should also be usable with
+older X releases. Note that XFree 4 contains many iso10646-1 fonts
+with minimal character repertoires, which can cause problems -- see
+etc/PROBLEMS.
+
+BDF Unicode fonts etl-unicode.tar.gz are available from
+ and
+. These
+fonts can also be used by ps-print and ps-mule to print Unicode
+characters.
+
+Finally, the Web pages
+and list a large
+number of free Unicode fonts.
+
+* GNU/Linux development packages
+
+Many GNU/Linux systems do not come with development packages by
+default; they just include the files that you need to run Emacs, but
+not those you need to compile it. For example, to compile Emacs with
+X11 support, you may need to install the special `X11 development'
+package. For example, in April 2003, the package names to install
+were `XFree86-devel' and `Xaw3d-devel' on RedHat. On Debian, the
+packages necessary to build the installed version should be
+sufficient; they can be installed using `apt-get build-dep emacs21' in
+Debian 3 and above.
DETAILED BUILDING AND INSTALLATION:
@@ -179,7 +211,7 @@ least 2.8 MB and can reach 100 MB or more. If the swapping space is
insufficient, you will get an error in the command `temacs -batch -l
loadup dump', found in `./src/Makefile.in', or possibly when
running the final dumped Emacs.
-
+
Building Emacs requires about 140 MB of disk space (including the
Emacs sources) Once installed, Emacs occupies about 77 MB in the file
system where it is installed; this includes the executable files, Lisp
@@ -223,16 +255,21 @@ accept a list of directories, separated with colons.
To get more attractive menus, you can specify an X toolkit when you
configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
-TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
-`athena'). On some systems, it does not work to use a toolkit with
-shared libraries. A free implementation of Motif, called LessTif, is
-available ftom . Compiling with LessTif or
-Motif causes a standard File Selection Dialog to pop up when you type
-"C-x C-f" and similar commands. You can get fancy 3D-style scroll
-bars, even without LessTif/Motif, if you have the Xaw3d library
-installed (see "Image support libraries" above for Xaw3d
+TOOLKIT is `athena', `motif' or `gtk' (`yes' and `lucid' are synonyms
+for `athena'). On some systems, it does not work to use a toolkit
+with shared libraries. A free implementation of Motif, called
+LessTif, is available from . Compiling with
+LessTif or Motif causes a standard File Selection Dialog to pop up
+when you invoke file commands with the mouse. You can get fancy
+3D-style scroll bars, even without LessTif/Motif, if you have the
+Xaw3d library installed (see "Image support libraries" above for Xaw3d
availability).
+If `--with-x-toolkit=gtk' is specified, you can tell configure where
+to search for GTK by specifying `--with-pkg-config-prog=PATH' where
+PATH is the pathname to pkg-config. Note that GTK version 2.4 or
+newer is required for Emacs.
+
The `--with-gcc' option specifies that the build process should
compile Emacs using GCC. If you don't want to use GCC, specify
`--with-gcc=no'. If you omit this option, `configure' will search
@@ -261,9 +298,15 @@ or more of these options:
--without-png for PNG image support
Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
-scroll bars. --without-xim disables the use of X Input Methods, and
---disable-largefile omits support for files larger than 2GB on systems
-which support that.
+scroll bars.
+
+Use --without-xim to inhibit the default use of X Input Methods. In
+this case, the X resource useXIM can be used to turn on use of XIM.
+
+Use --disable-largefile omits support for files larger than 2GB on
+systems which support that.
+
+Use --without-sound to disable sound support.
The `--prefix=PREFIXDIR' option specifies where the installation process
should put emacs and its data files. This defaults to `/usr/local'.
@@ -430,17 +473,6 @@ are installed in the following directories:
at the same time; in particular, you don't have to
make Emacs unavailable while installing a new version.
-`/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
- files installed for Emacs version VERSION only.
-
-`/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
- files installed for all Emacs versions.
-
- When Emacs is installed, it searches for its Lisp files
- in `/usr/local/share/emacs/VERSION/site-lisp', then in
- `/usr/local/share/emacs/site-lisp', and finally in
- `/usr/local/share/emacs/VERSION/lisp'.
-
`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
file, the `yow' database, and other
architecture-independent files Emacs might need while
@@ -470,6 +502,20 @@ are installed in the following directories:
`/usr/local/man/man1' holds the man pages for the programs installed
in `/usr/local/bin'.
+Any version of Emacs, whether installed or not, also looks for Lisp
+files in these directories.
+
+`/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
+ files installed for Emacs version VERSION only.
+
+`/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
+ files installed for all Emacs versions.
+
+ When Emacs is installed, it searches for its Lisp files
+ in `/usr/local/share/emacs/VERSION/site-lisp', then in
+ `/usr/local/share/emacs/site-lisp', and finally in
+ `/usr/local/share/emacs/VERSION/lisp'.
+
If these directories are not what you want, you can specify where to
install Emacs's libraries and data files or where Emacs should search
for its Lisp files by giving values for `make' variables as part of
@@ -489,9 +535,8 @@ the build directory by typing `make clean'. To also remove the files
that `configure' created (so you can compile Emacs for a different
configuration), type `make distclean'. If you don't need some, or all
of the input methods from the Leim package, you can remove the
-unneeded files in the leim/quail, leim/skk, and leim/skk-dic
-subdirectories of your site's lisp directory (usually
-/usr/local/share/emacs/VERSION/).
+unneeded files in the leim subdirectories of your site's lisp
+directory (usually /usr/local/share/emacs/VERSION/).
@@ -531,7 +576,7 @@ Here is a complete list of the variables you may want to set.
We create the following subdirectories under `libexecdir':
- `emacs/VERSION/CONFIGURATION-NAME', containing executable
programs used by Emacs that users are not expected to run
- themselves.
+ themselves.
`VERSION' is the number of the Emacs version you are installing,
and `CONFIGURATION-NAME' is the argument you gave to the
`configure' program to identify the architecture and operating
@@ -675,7 +720,7 @@ directory of the Emacs distribution.
in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
Strictly speaking, not all of the executables in `./lib-src' need be copied.
-- The programs `cvtmail', `emacsserver', `fakemail', `hexl',
+- The programs `cvtmail', `fakemail', `hexl',
`movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
and `yow' are used by Emacs; they do need to be copied.
- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'