annotate src/paths.h.in @ 276:6330739388db r21-0b36

Import from CVS: tag r21-0b36
author cvs
date Mon, 13 Aug 2007 10:30:37 +0200
parents
children 90d73dddcdc4
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
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
27 PATH_PREFIX The default value of `prefix-directory'. This is the
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
28 default root for everything.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
29
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
30 PATH_LOADSEARCH The default value of `load-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
31
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
32 PATH_PACKAGEPATH The default value of `package-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
33
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
34 PATH_SITE The default location of site-specific Lisp files.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
35
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
36 PATH_EXEC The default value of `exec-directory' and `exec-path'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
37 (exec-path also contains the value of whatever is in
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
38 the PATH environment variable.)
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
39
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
40 PATH_DATA The default value of `data-directory'. This
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
41 is where architecture-independent files are
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
42 searched for.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
43
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
44 PATH_LOCK The name of the directory that contains lock files
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
45 with which we record what files are being modified in
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
46 Emacs. This directory should be writable by everyone.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
47 If this is specified, the string must end with a slash!
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_INFO This is where the info documentation is installed.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
50
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
51 PATH_INFOPATH The default value of `Info-directory-list'.
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
52 These are additional places info files are searched
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
53 for. */
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
54
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
55 #define PATH_PREFIX "@prefix@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
56
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
57 #ifdef LISPDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
58 #define PATH_LOADSEARCH "@LISPDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
59 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
60
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
61 #ifdef PACKAGE_PATH_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
62 #define PATH_PACKAGEPATH "@PACKAGE_PATH@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
63 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
64
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
65 #ifdef SITELISPDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
66 #define PATH_SITE "@SITELISPDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
67 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
68
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
69 #ifdef ARCHLIBDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
70 #define PATH_EXEC "@ARCHLIBDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
71 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
72
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
73 #ifdef ETCDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
74 #define PATH_DATA "@ETCDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
75 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
76
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
77 #ifdef LOCKDIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
78 #define PATH_LOCK "@LOCKDIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
79 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
80
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
81 #ifdef INFODIR_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
82 #define PATH_INFO "@INFODIR@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
83 #endif
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
84
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
85 #ifdef INFOPATH_USER_DEFINED
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
86 #define PATH_INFOPATH "@INFOPATH@"
6330739388db Import from CVS: tag r21-0b36
cvs
parents:
diff changeset
87 #endif