annotate src/paths.h.in @ 203:850242ba4a81 r20-3b28

Import from CVS: tag r20-3b28
author cvs
date Mon, 13 Aug 2007 10:02:21 +0200
parents 376386a54a3c
children 966663fcf606
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 /* Hey Emacs, this is -*- C -*- code! */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 /* Synched up with: Not synched with FSF. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 /* Think twice before editing this file. Generated automatically by configure.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 The file startup.el guesses at reasonable values for load-path, exec-path,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 and lock-directory. This means that if you move emacs and its associated
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 sub-tree to a different place in the filesystem, or to a different machine,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 you won't have to do anything for it to work.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 If you define the paths in this file then they will take precedence over
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 any value generated by the heuristic in startup.el. The hardcoded paths
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 will be checked to see if they are valid, in which case they will be used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 Otherwise the editor will attempt to make its normal guess.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 See the NEWS file for a description of the heuristic used to locate the lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 and exec directories at startup time. If you are looking at this file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 because you are having trouble, then you would be much better off arranging
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 for those heuristics to succeed than defining the paths in this file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 ** Let me say that again. If you're editing this file, you're making
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 ** a mistake. Re-read the section on installation in ../etc/NEWS.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 If it defines anything, this file should define some subset of the following:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 PATH_PREFIX The default value of `prefix-directory'. This is the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 default root for everything.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 PATH_LOADSEARCH The default value of `load-path'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 PATH_EXEC The default value of `exec-directory' and `exec-path'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 (exec-path also contains the value of whatever is in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 the PATH environment variable.)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 PATH_DATA The default value of `data-directory'. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 is where architecture-independent files are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 searched for.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 PATH_LOCK The name of the directory that contains lock files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 with which we record what files are being modified in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 Emacs. This directory should be writable by everyone.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 If this is specified, the string must end with a slash!
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 PATH_SUPERLOCK The name of the file !!!SuperLock!!! in the lock
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 directory. You probably should let this default...
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47
203
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 0
diff changeset
48 PATH_INFO This is where the info documentation is installed.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 0
diff changeset
49
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 0
diff changeset
50 PATH_INFOPATH The default value of `Info-directory-list'.
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 0
diff changeset
51 These are additional places info files are searched
850242ba4a81 Import from CVS: tag r20-3b28
cvs
parents: 0
diff changeset
52 for. */