aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorPaul Eggert2015-04-19 14:40:51 -0700
committerPaul Eggert2015-04-19 14:44:50 -0700
commit9099d45df734f63145d414a0e1205245973c9efb (patch)
tree45d131ea09c07024f85bb27c1ada901e40a45331 /INSTALL
parent62e170072e6000b30c37792227dc34e71a31d797 (diff)
downloademacs-9099d45df734f63145d414a0e1205245973c9efb.tar.gz
emacs-9099d45df734f63145d414a0e1205245973c9efb.zip
Quote 'like this' in top-level files
* CONTRIBUTE, INSTALL, Makefile.in, README, configure.ac, make-dist: Prefer to single-quote 'like this' (instead of the older style `like this'). * configure.ac: Fix some space-before-tab problems that 'git commit' complained about.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL302
1 files changed, 151 insertions, 151 deletions
diff --git a/INSTALL b/INSTALL
index 55320207fa3..ebd36e74414 100644
--- a/INSTALL
+++ b/INSTALL
@@ -13,21 +13,21 @@ msdos/INSTALL. For information about building from a repository checkout
13 13
14BASIC INSTALLATION 14BASIC INSTALLATION
15 15
16On most Unix systems, you build Emacs by first running the `configure' 16On most Unix systems, you build Emacs by first running the 'configure'
17shell script. This attempts to deduce the correct values for 17shell script. This attempts to deduce the correct values for
18various system-dependent variables and features, and find the 18various system-dependent variables and features, and find the
19directories where certain system headers and libraries are kept. 19directories where certain system headers and libraries are kept.
20In a few cases, you may need to explicitly tell configure where to 20In a few cases, you may need to explicitly tell configure where to
21find some things, or what options to use. 21find some things, or what options to use.
22 22
23`configure' creates a `Makefile' in several subdirectories, and a 23'configure' creates a 'Makefile' in several subdirectories, and a
24`src/config.h' file containing system-dependent definitions. 24'src/config.h' file containing system-dependent definitions.
25Running the `make' utility then builds the package for your system. 25Running the 'make' utility then builds the package for your system.
26 26
27Building Emacs requires GNU make, <http://www.gnu.org/software/make/>. 27Building Emacs requires GNU make, <http://www.gnu.org/software/make/>.
28On most systems that Emacs supports, this is the default `make' program. 28On most systems that Emacs supports, this is the default 'make' program.
29 29
30Here's the procedure to build Emacs using `configure' on systems which 30Here's the procedure to build Emacs using 'configure' on systems which
31are supported by it. In some cases, if the simplified procedure fails, 31are supported by it. In some cases, if the simplified procedure fails,
32you might need to use various non-default options, and maybe perform 32you might need to use various non-default options, and maybe perform
33some of the steps manually. The more detailed description in the other 33some of the steps manually. The more detailed description in the other
@@ -40,48 +40,48 @@ sections if you need to.
40 This includes the space-saving that comes from automatically 40 This includes the space-saving that comes from automatically
41 compressing the Lisp source files on installation. 41 compressing the Lisp source files on installation.
42 42
43 2a. `cd' to the directory where you unpacked Emacs and invoke the 43 2a. 'cd' to the directory where you unpacked Emacs and invoke the
44 `configure' script: 44 'configure' script:
45 45
46 ./configure 46 ./configure
47 47
48 2b. Alternatively, create a separate directory, outside the source 48 2b. Alternatively, create a separate directory, outside the source
49 directory, where you want to build Emacs, and invoke `configure' 49 directory, where you want to build Emacs, and invoke 'configure'
50 from there: 50 from there:
51 51
52 SOURCE-DIR/configure 52 SOURCE-DIR/configure
53 53
54 where SOURCE-DIR is the top-level Emacs source directory. 54 where SOURCE-DIR is the top-level Emacs source directory.
55 55
56 3. When `configure' finishes, it prints several lines of details 56 3. When 'configure' finishes, it prints several lines of details
57 about the system configuration. Read those details carefully 57 about the system configuration. Read those details carefully
58 looking for anything suspicious, such as wrong CPU and operating 58 looking for anything suspicious, such as wrong CPU and operating
59 system names, wrong places for headers or libraries, missing 59 system names, wrong places for headers or libraries, missing
60 libraries that you know are installed on your system, etc. 60 libraries that you know are installed on your system, etc.
61 61
62 If you find anything wrong, you may have to pass to `configure' 62 If you find anything wrong, you may have to pass to 'configure'
63 one or more options specifying the explicit machine configuration 63 one or more options specifying the explicit machine configuration
64 name, where to find various headers and libraries, etc. 64 name, where to find various headers and libraries, etc.
65 Refer to the section DETAILED BUILDING AND INSTALLATION below. 65 Refer to the section DETAILED BUILDING AND INSTALLATION below.
66 66
67 If `configure' didn't find some image support libraries, such as 67 If 'configure' didn't find some image support libraries, such as
68 Xpm and jpeg, refer to "Image support libraries" below. 68 Xpm and jpeg, refer to "Image support libraries" below.
69 69
70 If the details printed by `configure' don't make any sense to 70 If the details printed by 'configure' don't make any sense to
71 you, but there are no obvious errors, assume that `configure' did 71 you, but there are no obvious errors, assume that 'configure' did
72 its job and proceed. 72 its job and proceed.
73 73
74 4. Invoke the `make' program: 74 4. Invoke the 'make' program:
75 75
76 make 76 make
77 77
78 5. If `make' succeeds, it will build an executable program `emacs' 78 5. If 'make' succeeds, it will build an executable program 'emacs'
79 in the `src' directory. You can try this program, to make sure 79 in the 'src' directory. You can try this program, to make sure
80 it works: 80 it works:
81 81
82 src/emacs -Q 82 src/emacs -Q
83 83
84 6. Assuming that the program `src/emacs' starts and displays its 84 6. Assuming that the program 'src/emacs' starts and displays its
85 opening screen, you can install the program and its auxiliary 85 opening screen, you can install the program and its auxiliary
86 files into their installation directories: 86 files into their installation directories:
87 87
@@ -101,7 +101,7 @@ sections if you need to.
101 make distclean 101 make distclean
102 102
103 Note that the install automatically saves space by compressing 103 Note that the install automatically saves space by compressing
104 (provided you have the `gzip' program) those installed Lisp source (.el) 104 (provided you have the 'gzip' program) those installed Lisp source (.el)
105 files that have corresponding .elc versions, as well as the Info files. 105 files that have corresponding .elc versions, as well as the Info files.
106 106
107 107
@@ -114,7 +114,7 @@ On GNU and Unix systems, Emacs needs the optional libraries "m17n-db",
114Indic and Khmer, and also for scripts that require Arabic shaping 114Indic and Khmer, and also for scripts that require Arabic shaping
115support (Arabic and Farsi). On some systems, particularly GNU/Linux, 115support (Arabic and Farsi). On some systems, particularly GNU/Linux,
116these libraries may be already present or available as additional 116these libraries may be already present or available as additional
117packages. Note that if there is a separate `dev' or `devel' package, 117packages. Note that if there is a separate 'dev' or 'devel' package,
118for use at compilation time rather than run time, you will need that 118for use at compilation time rather than run time, you will need that
119as well as the corresponding run time package; typically the dev 119as well as the corresponding run time package; typically the dev
120package will contain header files and a library archive. Otherwise, 120package will contain header files and a library archive. Otherwise,
@@ -148,7 +148,7 @@ XBM images whose support is built-in.
148 148
149On some systems, particularly on GNU/Linux, these libraries may 149On some systems, particularly on GNU/Linux, these libraries may
150already be present or available as additional packages. If 150already be present or available as additional packages. If
151there is a separate `dev' or `devel' package, for use at compilation 151there is a separate 'dev' or 'devel' package, for use at compilation
152time rather than run time, you will need that as well as the 152time rather than run time, you will need that as well as the
153corresponding run time package; typically the dev package will 153corresponding run time package; typically the dev package will
154contain header files and a library archive. Otherwise, you can 154contain header files and a library archive. Otherwise, you can
@@ -195,15 +195,15 @@ number of free Unicode fonts.
195Many GNU/Linux systems do not come with development packages by default; 195Many GNU/Linux systems do not come with development packages by default;
196they include the files that you need to run Emacs, but not those you 196they include the files that you need to run Emacs, but not those you
197need to compile it. For example, to compile Emacs with support for X 197need to compile it. For example, to compile Emacs with support for X
198and graphics libraries, you may need to install the `X development' 198and graphics libraries, you may need to install the X development
199package(s), and development versions of the jpeg, png, etc. packages. 199package(s), and development versions of the jpeg, png, etc. packages.
200 200
201The names of the packages that you need varies according to the 201The names of the packages that you need varies according to the
202GNU/Linux distribution that you use, and the options that you want to 202GNU/Linux distribution that you use, and the options that you want to
203configure Emacs with. On Debian-based systems, you can install all the 203configure Emacs with. On Debian-based systems, you can install all the
204packages needed to build the installed version of Emacs with a command 204packages needed to build the installed version of Emacs with a command
205like `apt-get build-dep emacs24'. On Red Hat systems, the 205like 'apt-get build-dep emacs24'. On Red Hat systems, the
206corresponding command is `yum-builddep emacs'. 206corresponding command is 'yum-builddep emacs'.
207 207
208 208
209DETAILED BUILDING AND INSTALLATION: 209DETAILED BUILDING AND INSTALLATION:
@@ -214,37 +214,37 @@ the file nt/INSTALL. For MS-DOS and MS Windows 3.X, see msdos/INSTALL.)
214 214
2151) See the basic installation summary above for the disk space requirements. 2151) See the basic installation summary above for the disk space requirements.
216 216
2172) In the unlikely event that `configure' does not detect your system 2172) In the unlikely event that 'configure' does not detect your system
218type correctly, consult `./etc/MACHINES' to see what --host, --build 218type correctly, consult './etc/MACHINES' to see what --host, --build
219options you should pass to `configure'. That file also offers hints 219options you should pass to 'configure'. That file also offers hints
220for getting around some possible installation problems. 220for getting around some possible installation problems.
221 221
2223) You can build Emacs in the top-level Emacs source directory 2223) You can build Emacs in the top-level Emacs source directory
223or in a separate directory. 223or in a separate directory.
224 224
2253a) To build in the top-level Emacs source directory, go to that 2253a) To build in the top-level Emacs source directory, go to that
226directory and run the program `configure' as follows: 226directory and run the program 'configure' as follows:
227 227
228 ./configure [--OPTION[=VALUE]] ... 228 ./configure [--OPTION[=VALUE]] ...
229 229
230If `configure' cannot determine your system type, try again 230If 'configure' cannot determine your system type, try again
231specifying the proper --build, --host options explicitly. 231specifying the proper --build, --host options explicitly.
232 232
233If you don't want X support, specify `--with-x=no'. If you omit this 233If you don't want X support, specify '--with-x=no'. If you omit this
234option, `configure' will try to figure out for itself whether your 234option, 'configure' will try to figure out for itself whether your
235system has X, and arrange to use it if present. 235system has X, and arrange to use it if present.
236 236
237The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build 237The '--x-includes=DIR' and '--x-libraries=DIR' options tell the build
238process where the compiler should look for the include files and 238process where the compiler should look for the include files and
239object libraries used with the X Window System. Normally, `configure' 239object libraries used with the X Window System. Normally, 'configure'
240is able to find them; these options are necessary if you have your X 240is able to find them; these options are necessary if you have your X
241Window System files installed in unusual places. These options also 241Window System files installed in unusual places. These options also
242accept a list of directories, separated with colons. 242accept a list of directories, separated with colons.
243 243
244To get more attractive menus, you can specify an X toolkit when you 244To get more attractive menus, you can specify an X toolkit when you
245configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where 245configure Emacs; use the option '--with-x-toolkit=TOOLKIT', where
246TOOLKIT is `gtk' (the default), `athena', or `motif' (`yes' and 246TOOLKIT is 'gtk' (the default), 'athena', or 'motif' ('yes' and
247`lucid' are synonyms for `athena'). Compiling with Motif causes a 247'lucid' are synonyms for 'athena'). Compiling with Motif causes a
248standard File Selection Dialog to pop up when you invoke file commands 248standard File Selection Dialog to pop up when you invoke file commands
249with the mouse. You can get fancy 3D-style scroll bars, even without 249with the mouse. You can get fancy 3D-style scroll bars, even without
250Gtk or Motif, if you have the Xaw3d library installed (see 250Gtk or Motif, if you have the Xaw3d library installed (see
@@ -257,12 +257,12 @@ Emacs will autolaunch a D-Bus session bus, when the environment
257variable DISPLAY is set, but no session bus is running. This might be 257variable DISPLAY is set, but no session bus is running. This might be
258inconvenient for Emacs when running as daemon or running via a remote 258inconvenient for Emacs when running as daemon or running via a remote
259ssh connection. In order to completely prevent the use of D-Bus, configure 259ssh connection. In order to completely prevent the use of D-Bus, configure
260Emacs with the options `--without-dbus --without-gconf --without-gsettings'. 260Emacs with the options '--without-dbus --without-gconf --without-gsettings'.
261 261
262The Emacs mail reader RMAIL is configured to be able to read mail from 262The Emacs mail reader RMAIL is configured to be able to read mail from
263a POP3 server by default. Versions of the POP protocol older than 263a POP3 server by default. Versions of the POP protocol older than
264POP3 are not supported. For Kerberos-authenticated POP add 264POP3 are not supported. For Kerberos-authenticated POP add
265`--with-kerberos', for Hesiod support add `--with-hesiod'. While POP3 265'--with-kerberos', for Hesiod support add '--with-hesiod'. While POP3
266is always enabled, whether Emacs actually uses POP is controlled by 266is always enabled, whether Emacs actually uses POP is controlled by
267individual users--see the Rmail chapter of the Emacs manual. 267individual users--see the Rmail chapter of the Emacs manual.
268 268
@@ -322,28 +322,28 @@ that goes awry. 'make V=1' also enables the extra chatter.
322 322
323Use --enable-link-time-optimization to enable link-time optimizer. If 323Use --enable-link-time-optimization to enable link-time optimizer. If
324you're using GNU compiler, this feature is supported since version 4.5.0. 324you're using GNU compiler, this feature is supported since version 4.5.0.
325If `configure' can determine number of online CPUS on your system, final 325If 'configure' can determine number of online CPUS on your system, final
326link-time optimization and code generation is executed in parallel using 326link-time optimization and code generation is executed in parallel using
327one job per each available online CPU. 327one job per each available online CPU.
328 328
329This option is also supported for clang. You should have GNU binutils 329This option is also supported for clang. You should have GNU binutils
330with `gold' linker and plugin support, and clang with LLVMgold.so plugin. 330with 'gold' linker and plugin support, and clang with LLVMgold.so plugin.
331Read http://llvm.org/docs/GoldPlugin.html for details. Also note that 331Read http://llvm.org/docs/GoldPlugin.html for details. Also note that
332this feature is still experimental, so prepare to build binutils and 332this feature is still experimental, so prepare to build binutils and
333clang from the corresponding source code repositories. 333clang from the corresponding source code repositories.
334 334
335The `--prefix=PREFIXDIR' option specifies where the installation process 335The '--prefix=PREFIXDIR' option specifies where the installation process
336should put emacs and its data files. This defaults to `/usr/local'. 336should put emacs and its data files. This defaults to '/usr/local'.
337- Emacs (and the other utilities users run) go in PREFIXDIR/bin 337- Emacs (and the other utilities users run) go in PREFIXDIR/bin
338 (unless the `--exec-prefix' option says otherwise). 338 (unless the '--exec-prefix' option says otherwise).
339- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION 339- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
340 (where VERSION is the version number of Emacs, like `23.2'). 340 (where VERSION is the version number of Emacs, like '23.2').
341- The architecture-dependent files go in 341- The architecture-dependent files go in
342 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION 342 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
343 (where CONFIGURATION is the configuration name, like 343 (where CONFIGURATION is the configuration name, like
344 i686-pc-linux-gnu), unless the `--exec-prefix' option says otherwise. 344 i686-pc-linux-gnu), unless the '--exec-prefix' option says otherwise.
345 345
346The `--exec-prefix=EXECDIR' option allows you to specify a separate 346The '--exec-prefix=EXECDIR' option allows you to specify a separate
347portion of the directory tree for installing architecture-specific 347portion of the directory tree for installing architecture-specific
348files, like executables and utility programs. If specified, 348files, like executables and utility programs. If specified,
349- Emacs (and the other utilities users run) go in EXECDIR/bin, and 349- Emacs (and the other utilities users run) go in EXECDIR/bin, and
@@ -358,26 +358,26 @@ For example, the command
358configures Emacs to build for a 32-bit GNU/Linux distribution, 358configures Emacs to build for a 32-bit GNU/Linux distribution,
359without sound support. 359without sound support.
360 360
361`configure' doesn't do any compilation or installation itself. 361'configure' doesn't do any compilation or installation itself.
362It just creates the files that influence those things: 362It just creates the files that influence those things:
363`./Makefile' in the top-level directory and several subdirectories; 363'./Makefile' in the top-level directory and several subdirectories;
364and `./src/config.h'. 364and './src/config.h'.
365 365
366When it is done, `configure' prints a description of what it did and 366When it is done, 'configure' prints a description of what it did and
367creates a shell script `config.status' which, when run, recreates the 367creates a shell script 'config.status' which, when run, recreates the
368same configuration. If `configure' exits with an error after 368same configuration. If 'configure' exits with an error after
369disturbing the status quo, it removes `config.status'. `configure' 369disturbing the status quo, it removes 'config.status'. 'configure'
370also creates a file `config.cache' that saves the results of its tests 370also creates a file 'config.cache' that saves the results of its tests
371to make reconfiguring faster, and a file `config.log' containing compiler 371to make reconfiguring faster, and a file 'config.log' containing compiler
372output (useful mainly for debugging `configure'). You can give 372output (useful mainly for debugging 'configure'). You can give
373`configure' the option `--cache-file=FILE' to use the results of the 373'configure' the option '--cache-file=FILE' to use the results of the
374tests in FILE instead of `config.cache'. Set FILE to `/dev/null' to 374tests in FILE instead of 'config.cache'. Set FILE to '/dev/null' to
375disable caching, for debugging `configure'. 375disable caching, for debugging 'configure'.
376 376
377If the description of the system configuration printed by `configure' 377If the description of the system configuration printed by 'configure'
378is not right, or if it claims some of the features or libraries are not 378is not right, or if it claims some of the features or libraries are not
379available when you know they are, look at the `config.log' file for 379available when you know they are, look at the 'config.log' file for
380the trace of the failed tests performed by `configure' to check 380the trace of the failed tests performed by 'configure' to check
381whether these features are supported. Typically, some test fails 381whether these features are supported. Typically, some test fails
382because the compiler cannot find some function in the system 382because the compiler cannot find some function in the system
383libraries, or some macro-processor definition in the system headers. 383libraries, or some macro-processor definition in the system headers.
@@ -385,29 +385,29 @@ libraries, or some macro-processor definition in the system headers.
385Some tests might fail because the compiler should look in special 385Some tests might fail because the compiler should look in special
386directories for some header files, or link against optional 386directories for some header files, or link against optional
387libraries, or use special compilation options. You can force 387libraries, or use special compilation options. You can force
388`configure' and the build process which follows it to do that by 388'configure' and the build process which follows it to do that by
389setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC 389setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
390before running `configure'. CPP is the command which invokes the 390before running 'configure'. CPP is the command which invokes the
391preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are 391preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are
392compilation options, LDFLAGS are options used when linking, LIBS are 392compilation options, LDFLAGS are options used when linking, LIBS are
393libraries to link against, and CC is the command which invokes the 393libraries to link against, and CC is the command which invokes the
394compiler. By default, gcc is used if available. 394compiler. By default, gcc is used if available.
395 395
396Here's an example of a `configure' invocation, assuming a Bourne-like 396Here's an example of a 'configure' invocation, assuming a Bourne-like
397shell such as Bash, which uses these variables: 397shell such as Bash, which uses these variables:
398 398
399 ./configure \ 399 ./configure \
400 CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \ 400 CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
401 CFLAGS='-O3' LIBS='-lfoo -lbar' 401 CFLAGS='-O3' LIBS='-lfoo -lbar'
402 402
403(this is all one shell command). This tells `configure' to instruct the 403(this is all one shell command). This tells 'configure' to instruct the
404preprocessor to look in the `/foo/myinclude' directory for header 404preprocessor to look in the '/foo/myinclude' directory for header
405files (in addition to the standard directories), instruct the linker 405files (in addition to the standard directories), instruct the linker
406to look in `/bar/mylib' for libraries, pass the -O3 optimization 406to look in '/bar/mylib' for libraries, pass the -O3 optimization
407switch to the compiler, and link against libfoo and libbar 407switch to the compiler, and link against libfoo and libbar
408libraries in addition to the standard ones. 408libraries in addition to the standard ones.
409 409
410For some libraries, like Gtk+, fontconfig and ALSA, `configure' uses 410For some libraries, like Gtk+, fontconfig and ALSA, 'configure' uses
411pkg-config to find where those libraries are installed. 411pkg-config to find where those libraries are installed.
412If you want pkg-config to look in special directories, you have to set 412If you want pkg-config to look in special directories, you have to set
413PKG_CONFIG_PATH to point to the directories where the .pc-files for 413PKG_CONFIG_PATH to point to the directories where the .pc-files for
@@ -417,27 +417,27 @@ those libraries are. For example:
417 PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' 417 PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig'
418 418
4193b) To build in a separate directory, go to that directory 4193b) To build in a separate directory, go to that directory
420and run the program `configure' as follows: 420and run the program 'configure' as follows:
421 421
422 SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ... 422 SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
423 423
424SOURCE-DIR refers to the top-level Emacs source directory which is 424SOURCE-DIR refers to the top-level Emacs source directory which is
425where Emacs's configure script is located. `configure' looks for the 425where Emacs's configure script is located. 'configure' looks for the
426Emacs source code in the directory that `configure' is in. 426Emacs source code in the directory that 'configure' is in.
427 427
4284) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs 4284) Put into './lisp/site-init.el' or './lisp/site-load.el' any Emacs
429Lisp code you want Emacs to load before it is dumped out. Use 429Lisp code you want Emacs to load before it is dumped out. Use
430site-load.el for additional libraries if you arrange for their 430site-load.el for additional libraries if you arrange for their
431documentation strings to be in the etc/DOC file (see 431documentation strings to be in the etc/DOC file (see
432src/Makefile.in if you wish to figure out how to do that). For all 432src/Makefile.in if you wish to figure out how to do that). For all
433else, use site-init.el. Do not load byte-compiled code which 433else, use site-init.el. Do not load byte-compiled code which
434was built with a non-nil value of `byte-compile-dynamic'. 434was built with a non-nil value of 'byte-compile-dynamic'.
435 435
436It is not a good idea to edit the normal .el files that come with Emacs. 436It is not a good idea to edit the normal .el files that come with Emacs.
437Instead, use a file like site-init.el to change settings. 437Instead, use a file like site-init.el to change settings.
438 438
439To change the value of a variable that is already defined in Emacs, 439To change the value of a variable that is already defined in Emacs,
440you should use the Lisp function `setq', not `defvar'. For example, 440you should use the Lisp function 'setq', not 'defvar'. For example,
441 441
442 (setq news-inews-program "/usr/bin/inews") 442 (setq news-inews-program "/usr/bin/inews")
443 443
@@ -449,46 +449,46 @@ variable gets by default! Make sure you know what kind of value the
449variable should have. If you don't pay attention to what you are 449variable should have. If you don't pay attention to what you are
450doing, you'll make a mistake. 450doing, you'll make a mistake.
451 451
452The `site-*.el' files are nonexistent in the distribution. You do not 452The 'site-*.el' files are nonexistent in the distribution. You do not
453need to create them if you have nothing to put in them. 453need to create them if you have nothing to put in them.
454 454
4555) Refer to the file `./etc/TERMS' for information on fields you may 4555) Refer to the file './etc/TERMS' for information on fields you may
456wish to add to various termcap entries. (This is unlikely to be necessary.) 456wish to add to various termcap entries. (This is unlikely to be necessary.)
457 457
4586) Run `make' in the top directory of the Emacs distribution to finish 4586) Run 'make' in the top directory of the Emacs distribution to finish
459building Emacs in the standard way. The final executable file is 459building Emacs in the standard way. The final executable file is
460named `src/emacs'. You can execute this file "in place" without 460named 'src/emacs'. You can execute this file "in place" without
461copying it, if you wish; then it automatically uses the sibling 461copying it, if you wish; then it automatically uses the sibling
462directories ../lisp, ../lib-src, ../info. 462directories ../lisp, ../lib-src, ../info.
463 463
464Or you can "install" the executable and the other files into their 464Or you can "install" the executable and the other files into their
465installed locations, with `make install'. By default, Emacs's files 465installed locations, with 'make install'. By default, Emacs's files
466are installed in the following directories: 466are installed in the following directories:
467 467
468`/usr/local/bin' holds the executable programs users normally run - 468'/usr/local/bin' holds the executable programs users normally run -
469 `emacs', `etags', `ctags', `emacsclient'. 469 'emacs', 'etags', 'ctags', 'emacsclient'.
470 470
471`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; 471'/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
472 `VERSION' stands for the number of the Emacs version 472 'VERSION' stands for the number of the Emacs version
473 you are installing, like `23.1' or `23.2'. Since the 473 you are installing, like '23.1' or '23.2'. Since the
474 Lisp library changes from one version of Emacs to 474 Lisp library changes from one version of Emacs to
475 another, including the version number in the path 475 another, including the version number in the path
476 allows you to have several versions of Emacs installed 476 allows you to have several versions of Emacs installed
477 at the same time; in particular, you don't have to 477 at the same time; in particular, you don't have to
478 make Emacs unavailable while installing a new version. 478 make Emacs unavailable while installing a new version.
479 479
480`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC 480'/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
481 file, and other architecture-independent files Emacs 481 file, and other architecture-independent files Emacs
482 might need while running. 482 might need while running.
483 483
484`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable 484'/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
485 programs used by Emacs that users are not expected to 485 programs used by Emacs that users are not expected to
486 run themselves. 486 run themselves.
487 `VERSION' is the number of the Emacs version you are 487 'VERSION' is the number of the Emacs version you are
488 installing, and `CONFIGURATION-NAME' is the value 488 installing, and 'CONFIGURATION-NAME' is the value
489 deduced by the `configure' program to identify the 489 deduced by the 'configure' program to identify the
490 architecture and operating system of your machine, 490 architecture and operating system of your machine,
491 like `i686-pc-linux-gnu' or `sparc-sun-sunos'. Since 491 like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'. Since
492 these files are specific to the version of Emacs, 492 these files are specific to the version of Emacs,
493 operating system, and architecture in use, including 493 operating system, and architecture in use, including
494 the configuration name in the path allows you to have 494 the configuration name in the path allows you to have
@@ -497,35 +497,35 @@ are installed in the following directories:
497 useful for sites at which different kinds of machines 497 useful for sites at which different kinds of machines
498 share the file system Emacs is installed on. 498 share the file system Emacs is installed on.
499 499
500`/usr/local/share/info' holds the on-line documentation for Emacs, 500'/usr/local/share/info' holds the on-line documentation for Emacs,
501 known as "info files". Many other GNU programs are 501 known as "info files". Many other GNU programs are
502 documented using info files as well, so this directory 502 documented using info files as well, so this directory
503 stands apart from the other, Emacs-specific directories. 503 stands apart from the other, Emacs-specific directories.
504 504
505`/usr/local/share/man/man1' holds the man pages for the programs installed 505'/usr/local/share/man/man1' holds the man pages for the programs installed
506 in `/usr/local/bin'. 506 in '/usr/local/bin'.
507 507
508Any version of Emacs, whether installed or not, also looks for Lisp 508Any version of Emacs, whether installed or not, also looks for Lisp
509files in these directories. 509files in these directories.
510 510
511`/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp 511'/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
512 files installed for Emacs version VERSION only. 512 files installed for Emacs version VERSION only.
513 513
514`/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp 514'/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
515 files installed for all Emacs versions. 515 files installed for all Emacs versions.
516 516
517 When Emacs is installed, it searches for its Lisp files 517 When Emacs is installed, it searches for its Lisp files
518 in `/usr/local/share/emacs/VERSION/site-lisp', then in 518 in '/usr/local/share/emacs/VERSION/site-lisp', then in
519 `/usr/local/share/emacs/site-lisp', and finally in 519 '/usr/local/share/emacs/site-lisp', and finally in
520 `/usr/local/share/emacs/VERSION/lisp'. 520 '/usr/local/share/emacs/VERSION/lisp'.
521 521
522If these directories are not what you want, you can specify where to 522If these directories are not what you want, you can specify where to
523install Emacs's libraries and data files or where Emacs should search 523install Emacs's libraries and data files or where Emacs should search
524for its Lisp files by giving values for `make' variables as part of 524for its Lisp files by giving values for 'make' variables as part of
525the command. See the section below called `MAKE VARIABLES' for more 525the command. See the section below called 'MAKE VARIABLES' for more
526information on this. 526information on this.
527 527
5287) Check the file `dir' in your site's info directory (usually 5287) Check the file 'dir' in your site's info directory (usually
529/usr/local/share/info) to make sure that it has a menu entry for the 529/usr/local/share/info) to make sure that it has a menu entry for the
530Emacs info files. 530Emacs info files.
531 531
@@ -534,51 +534,51 @@ then you might need to make the movemail program setuid or setgid
534to enable it to write the lock files. We believe this is safe. 534to enable it to write the lock files. We believe this is safe.
535 535
5369) You are done! You can remove executables and object files from 5369) You are done! You can remove executables and object files from
537the build directory by typing `make clean'. To also remove the files 537the build directory by typing 'make clean'. To also remove the files
538that `configure' created (so you can compile Emacs for a different 538that 'configure' created (so you can compile Emacs for a different
539configuration), type `make distclean'. 539configuration), type 'make distclean'.
540 540
541 541
542MAKE VARIABLES 542MAKE VARIABLES
543 543
544You can change where the build process installs Emacs and its data 544You can change where the build process installs Emacs and its data
545files by specifying values for `make' variables as part of the `make' 545files by specifying values for 'make' variables as part of the 'make'
546command line. For example, if you type 546command line. For example, if you type
547 547
548 make install bindir=/usr/local/gnubin 548 make install bindir=/usr/local/gnubin
549 549
550the `bindir=/usr/local/gnubin' argument indicates that the Emacs 550the 'bindir=/usr/local/gnubin' argument indicates that the Emacs
551executable files should go in `/usr/local/gnubin', not 551executable files should go in '/usr/local/gnubin', not
552`/usr/local/bin'. 552'/usr/local/bin'.
553 553
554Here is a complete list of the variables you may want to set. 554Here is a complete list of the variables you may want to set.
555 555
556`bindir' indicates where to put executable programs that users can 556'bindir' indicates where to put executable programs that users can
557 run. This defaults to /usr/local/bin. 557 run. This defaults to /usr/local/bin.
558 558
559`datadir' indicates where to put the architecture-independent 559'datadir' indicates where to put the architecture-independent
560 read-only data files that Emacs refers to while it runs; it 560 read-only data files that Emacs refers to while it runs; it
561 defaults to /usr/local/share. We create the following 561 defaults to /usr/local/share. We create the following
562 subdirectories under `datadir': 562 subdirectories under 'datadir':
563 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and 563 - 'emacs/VERSION/lisp', containing the Emacs Lisp library, and
564 - `emacs/VERSION/etc', containing the tutorials, DOC file, etc. 564 - 'emacs/VERSION/etc', containing the tutorials, DOC file, etc.
565 `VERSION' is the number of the Emacs version you are installing, 565 'VERSION' is the number of the Emacs version you are installing,
566 like `23.1' or `23.2'. Since these files vary from one version 566 like '23.1' or '23.2'. Since these files vary from one version
567 of Emacs to another, including the version number in the path 567 of Emacs to another, including the version number in the path
568 allows you to have several versions of Emacs installed at the 568 allows you to have several versions of Emacs installed at the
569 same time; this means that you don't have to make Emacs 569 same time; this means that you don't have to make Emacs
570 unavailable while installing a new version. 570 unavailable while installing a new version.
571 571
572`libexecdir' indicates where to put architecture-specific data files that 572'libexecdir' indicates where to put architecture-specific data files that
573 Emacs refers to as it runs; it defaults to `/usr/local/libexec'. 573 Emacs refers to as it runs; it defaults to '/usr/local/libexec'.
574 We create the following subdirectories under `libexecdir': 574 We create the following subdirectories under 'libexecdir':
575 - `emacs/VERSION/CONFIGURATION-NAME', containing executable 575 - 'emacs/VERSION/CONFIGURATION-NAME', containing executable
576 programs used by Emacs that users are not expected to run 576 programs used by Emacs that users are not expected to run
577 themselves. 577 themselves.
578 `VERSION' is the number of the Emacs version you are installing, 578 'VERSION' is the number of the Emacs version you are installing,
579 and `CONFIGURATION-NAME' is the value deduced by the 579 and 'CONFIGURATION-NAME' is the value deduced by the
580 `configure' program to identify the architecture and operating 580 'configure' program to identify the architecture and operating
581 system of your machine, like `i686-pc-linux-gnu' or `sparc-sun-sunos'. 581 system of your machine, like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'.
582 Since these files are specific to the version of Emacs, 582 Since these files are specific to the version of Emacs,
583 operating system, and architecture in use, including the 583 operating system, and architecture in use, including the
584 configuration name in the path allows you to have several 584 configuration name in the path allows you to have several
@@ -587,57 +587,57 @@ Here is a complete list of the variables you may want to set.
587 at which different kinds of machines share the file system 587 at which different kinds of machines share the file system
588 Emacs is installed on. 588 Emacs is installed on.
589 589
590`infodir' indicates where to put the info files distributed with 590'infodir' indicates where to put the info files distributed with
591 Emacs; it defaults to `/usr/local/share/info'. 591 Emacs; it defaults to '/usr/local/share/info'.
592 592
593`mandir' indicates where to put the man pages for Emacs and its 593'mandir' indicates where to put the man pages for Emacs and its
594 utilities (like `etags'); it defaults to 594 utilities (like 'etags'); it defaults to
595 `/usr/local/share/man/man1'. 595 '/usr/local/share/man/man1'.
596 596
597`prefix' doesn't give a path for any specific part of Emacs; instead, 597'prefix' doesn't give a path for any specific part of Emacs; instead,
598 its value is used to determine the defaults for all the 598 its value is used to determine the defaults for all the
599 architecture-independent path variables - `datadir', 599 architecture-independent path variables - 'datadir',
600 `sharedstatedir', `infodir', and `mandir'. Its default value is 600 'sharedstatedir', 'infodir', and 'mandir'. Its default value is
601 `/usr/local'; the other variables add on `lib' or `man' to it 601 '/usr/local'; the other variables add on 'lib' or 'man' to it
602 by default. 602 by default.
603 603
604 For example, suppose your site generally places GNU software 604 For example, suppose your site generally places GNU software
605 under `/usr/users/software/gnusoft' instead of `/usr/local'. 605 under '/usr/users/software/gnusoft' instead of '/usr/local'.
606 By including 606 By including
607 `prefix=/usr/users/software/gnusoft' 607 'prefix=/usr/users/software/gnusoft'
608 in the arguments to `make', you can instruct the build process 608 in the arguments to 'make', you can instruct the build process
609 to place all of the Emacs data files in the appropriate 609 to place all of the Emacs data files in the appropriate
610 directories under that path. 610 directories under that path.
611 611
612`exec_prefix' serves the same purpose as `prefix', but instead 612'exec_prefix' serves the same purpose as 'prefix', but instead
613 determines the default values for the architecture-dependent 613 determines the default values for the architecture-dependent
614 path variables - `bindir' and `libexecdir'. 614 path variables - 'bindir' and 'libexecdir'.
615 615
616The above variables serve analogous purposes in the makefiles for all 616The above variables serve analogous purposes in the makefiles for all
617GNU software; the following variables are specific to Emacs. 617GNU software; the following variables are specific to Emacs.
618 618
619`archlibdir' indicates where Emacs installs and expects the executable 619'archlibdir' indicates where Emacs installs and expects the executable
620 files and other architecture-dependent data it uses while 620 files and other architecture-dependent data it uses while
621 running. Its default value, based on `libexecdir' (which 621 running. Its default value, based on 'libexecdir' (which
622 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' 622 see), is '/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
623 (where VERSION and CONFIGURATION-NAME are as described above). 623 (where VERSION and CONFIGURATION-NAME are as described above).
624 624
625`GZIP_PROG' is the name of the executable that compresses installed info, 625'GZIP_PROG' is the name of the executable that compresses installed info,
626 manual, and .el files. It defaults to gzip. Setting it to 626 manual, and .el files. It defaults to gzip. Setting it to
627 the empty string suppresses compression. 627 the empty string suppresses compression.
628 628
629Remember that you must specify any variable values you need each time 629Remember that you must specify any variable values you need each time
630you run `make' in the top directory. If you run `make' once to build 630you run 'make' in the top directory. If you run 'make' once to build
631emacs, test it, and then run `make' again to install the files, you 631emacs, test it, and then run 'make' again to install the files, you
632must provide the same variable settings each time. To make the 632must provide the same variable settings each time. To make the
633settings persist, you can edit them into the `Makefile' in the top 633settings persist, you can edit them into the 'Makefile' in the top
634directory, but be aware that running the `configure' program erases 634directory, but be aware that running the 'configure' program erases
635`Makefile' and rebuilds it from `Makefile.in'. 635'Makefile' and rebuilds it from 'Makefile.in'.
636 636
637The path for finding Lisp files is specified in src/epaths.h, 637The path for finding Lisp files is specified in src/epaths.h,
638a file which is generated by running configure. To change the path, 638a file which is generated by running configure. To change the path,
639you can edit the definition of PATH_LOADSEARCH in that file 639you can edit the definition of PATH_LOADSEARCH in that file
640before you run `make'. 640before you run 'make'.
641 641
642The top-level Makefile stores the variable settings it used in the 642The top-level Makefile stores the variable settings it used in the
643Makefiles for the subdirectories, so you don't have to specify them 643Makefiles for the subdirectories, so you don't have to specify them
@@ -646,7 +646,7 @@ when running make in the subdirectories.
646 646
647PROBLEMS 647PROBLEMS
648 648
649See the file `./etc/PROBLEMS' for a list of various problems sometimes 649See the file './etc/PROBLEMS' for a list of various problems sometimes
650encountered, and what to do about them. 650encountered, and what to do about them.
651 651
652This file is part of GNU Emacs. 652This file is part of GNU Emacs.