annotate src/paths.h.in @ 398:74fd4e045ea6 r21-2-29

Import from CVS: tag r21-2-29
author cvs
date Mon, 13 Aug 2007 11:13:30 +0200
parents aabb7f5b1c81
children 501cfd01ee6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
1 /* Hey Emacs, this is -*- C -*- code! */
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
2
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
3 /* Synched up with: Not synched with FSF. */
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
4
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
5 /* Think twice before editing this file. Generated automatically by configure.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
6
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
7 The file startup.el guesses at reasonable values for load-path, exec-path,
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
8 and lock-directory. This means that if you move emacs and its associated
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
9 sub-tree to a different place in the filesystem, or to a different machine,
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
10 you won't have to do anything for it to work.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
11
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
12 If you define the paths in this file then they will take precedence over
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
13 any value generated by the heuristic in startup.el. The hardcoded paths
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
14 will be checked to see if they are valid, in which case they will be used.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
15 Otherwise the editor will attempt to make its normal guess.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
16
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
17 See the NEWS file for a description of the heuristic used to locate the lisp
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
18 and exec directories at startup time. If you are looking at this file
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
19 because you are having trouble, then you would be much better off arranging
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
20 for those heuristics to succeed than defining the paths in this file.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
21
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
22 ** Let me say that again. If you're editing this file, you're making
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
23 ** a mistake. Re-read the section on installation in ../etc/NEWS.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
24
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
25 If it defines anything, this file should define some subset of the following:
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
26
280
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
27 PATH_PROGNAME The name of the Emacs variant that's running.
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
28
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
29 PATH_VERSION The version id of the Emacs variant that's running.
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
30
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
31 PATH_EXEC_PREFIX The value of --exec-prefix.
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
32
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
33 PATH_PREFIX The value of --prefix.
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
34
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
35 PATH_LOADSEARCH The default value of `load-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
36
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
37 PATH_MODULESEARCH The default value of `module-load-path'.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
38
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
39 PATH_PACKAGEPATH The default value of `package-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
40
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
41 PATH_SITE The default location of site-specific Lisp files.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
42
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
43 PATH_SITE_MODULES The default location of site-specific modules.
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
44
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
45 PATH_EXEC The default value of `exec-directory' and `exec-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
46 (exec-path also contains the value of whatever is in
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
47 the PATH environment variable.)
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
48
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
49 PATH_DATA The default value of `data-directory'. This
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
50 is where architecture-independent files are
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
51 searched for.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
52
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
53 PATH_LOCK The name of the directory that contains lock files
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
54 with which we record what files are being modified in
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
55 Emacs. This directory should be writable by everyone.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
56 If this is specified, the string must end with a slash!
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
57
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
58 PATH_INFO This is where the info documentation is installed.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
59
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
60 PATH_INFOPATH The default value of `Info-directory-list'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
61 These are additional places info files are searched
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
62 for. */
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
63
280
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
64 #define PATH_PROGNAME "@PROGNAME@"
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
65
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
66 #define PATH_VERSION "@version@"
7df0dd720c89 Import from CVS: tag r21-0b38
cvs
parents: 278
diff changeset
67
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
68 #ifdef EXEC_PREFIX_USER_DEFINED
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
69 #define PATH_EXEC_PREFIX "@EXEC_PREFIX@"
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
70 #endif
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
71
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
72 #ifdef PREFIX_USER_DEFINED
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
73 #define PATH_PREFIX "@PREFIX@"
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
74 #endif
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
75
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
76 #ifdef LISPDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
77 #define PATH_LOADSEARCH "@LISPDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
78 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
79
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
80 #ifdef MODULEDIR_USER_DEFINED
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
81 #define PATH_MODULESEARCH "@MODULEDIR@"
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
82 #endif
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
83
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
84 #ifdef SITELISPDIR_USER_DEFINED
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
85 #define PATH_SITE "@SITELISPDIR@"
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
86 #endif
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
87
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
88 #ifdef SITEMODULEDIR_USER_DEFINED
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
89 #define PATH_SITE_MODULES "@SITEMODULEDIR@"
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
90 #endif
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents: 371
diff changeset
91
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
92 #ifdef PACKAGE_PATH_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
93 #define PATH_PACKAGEPATH "@PACKAGE_PATH@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
94 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
95
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
96 #ifdef ARCHLIBDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
97 #define PATH_EXEC "@ARCHLIBDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
98 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
99
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
100 #ifdef ETCDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
101 #define PATH_DATA "@ETCDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
102 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
103
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
104 #ifdef LOCKDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
105 #define PATH_LOCK "@LOCKDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
106 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
107
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
108 #ifdef DOCDIR_USER_DEFINED
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
109 #define PATH_DOC "@DOCDIR@"
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
110 #endif
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 388
diff changeset
111
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
112 #ifdef INFODIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
113 #define PATH_INFO "@INFODIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
114 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
115
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
116 #ifdef INFOPATH_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
117 #define PATH_INFOPATH "@INFOPATH@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
118 #endif