Mercurial > hg > xemacs-beta

comparison man/xemacs/startup.texi @ 373:6240c7796c7a r21-2b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2b2
author cvs
date Mon, 13 Aug 2007 11:04:06 +0200
parents cc15677e0335
children 8626e4521993
comparison
equal deleted inserted replaced
372:49e1ed2d7ed8 373:6240c7796c7a
6 @cindex directories 6 @cindex directories
7 7
8 XEmacs deals with a multitude of files during operation. These files 8 XEmacs deals with a multitude of files during operation. These files
9 are spread over many directories, and XEmacs determines the location of 9 are spread over many directories, and XEmacs determines the location of
10 most of these directories at startup and organizes them into various 10 most of these directories at startup and organizes them into various
11 paths. (A @emph{path}, 11 paths. (A @dfn{path},
12 @cindex path 12 @cindex path
13 for the purposes of this section, is simply a list of directories which 13 for the purposes of this section, is simply a list of directories which
14 XEmacs searches successively in order to locate a file.) 14 XEmacs searches successively in order to locate a file.)
15 15
16 @subsection XEmacs Directory Hierarchies 16 @subsection XEmacs Directory Hierarchies
28 matter where they may be hidden. 28 matter where they may be hidden.
29 29
30 XEmacs will always respect directory options passed to @code{configure}. 30 XEmacs will always respect directory options passed to @code{configure}.
31 However, if it cannot locate a directory at the configured place, it 31 However, if it cannot locate a directory at the configured place, it
32 will initiate a search for the directory in any of a number of 32 will initiate a search for the directory in any of a number of
33 @emph{hierachies} rooted under a directory which XEmacs assumes contain 33 @dfn{hierachies} rooted under a directory which XEmacs assumes contain
34 parts of the XEmacs installation; it may locate several such hierarchies 34 parts of the XEmacs installation; it may locate several such hierarchies
35 and search across them. (Typically, there are just one or two 35 and search across them. (Typically, there are just one or two
36 hierarchies: the hierarchy where XEmacs was or will be installed, and 36 hierarchies: the hierarchy where XEmacs was or will be installed, and
37 the one where it is being built.) Such a directory containing a 37 the one where it is being built.) Such a directory containing a
38 hierarchy is called a @emph{root}. 38 hierarchy is called a @dfn{root}.
39 @cindex root of a hierarchy 39 @cindex root of a hierarchy
40 Whenever this section refers to a directory using the shorthand 40 Whenever this section refers to a directory using the shorthand
41 @code{<root>}, it means that XEmacs searches for it under all 41 @code{<root>}, it means that XEmacs searches for it under all
42 hierarchies under all hierarchies XEmacs was able to scrounge up. In a 42 hierarchies under all hierarchies XEmacs was able to scrounge up. In a
43 running XEmacs, the hierarchy roots are stored in the variable 43 running XEmacs, the hierarchy roots are stored in the variable
51 the core installation. They are part of any of the many packages 51 the core installation. They are part of any of the many packages
52 usually installed on top of an XEmacs installation. (@xref{Packages}.) 52 usually installed on top of an XEmacs installation. (@xref{Packages}.)
53 Hence, they play a prominent role in the various paths XEmacs sets up. 53 Hence, they play a prominent role in the various paths XEmacs sets up.
54 54
55 XEmacs locates packages in any of a number of package hierarchies. 55 XEmacs locates packages in any of a number of package hierarchies.
56 Package hierarchies fall into three groups: @emph{early}, @emph{late}, 56 Package hierarchies fall into three groups: @dfn{early}, @dfn{late},
57 and @emph{last}, 57 and @dfn{last},
58 @cindex early package hierarchies 58 @cindex early package hierarchies
59 @cindex late package hierarchies 59 @cindex late package hierarchies
60 @cindex last package hierarchies 60 @cindex last package hierarchies
61 according to the relative location at which they show 61 according to the relative location at which they show
62 up in the various XEmacs paths. Early package hierarchies are at the 62 up in the various XEmacs paths. Early package hierarchies are at the
67 subdirectory @file{.xemacs} of the user's home directory. 67 subdirectory @file{.xemacs} of the user's home directory.
68 68
69 Moreover, XEmacs expects late hierarchies in the subdirectories 69 Moreover, XEmacs expects late hierarchies in the subdirectories
70 @file{site-packages}, @file{mule-packages}, and @file{xemacs-packages} 70 @file{site-packages}, @file{mule-packages}, and @file{xemacs-packages}
71 (in that order) of the @file{<root>/lib/xemacs} subdirectory of one of 71 (in that order) of the @file{<root>/lib/xemacs} subdirectory of one of
72 the installation hierarchies. (If you run in-place, these are directr 72 the installation hierarchies. (If you run in-place, these are direct
73 subdirectories of the build directory.) Furthermore, XEmacs will also 73 subdirectories of the build directory.) Furthermore, XEmacs will also
74 search these subdirectories in the @file{<root>/lib/xemacs-<VERSION>} 74 search these subdirectories in the @file{<root>/lib/xemacs-<VERSION>}
75 subdirectory and prefer directories found there. 75 subdirectory and prefer directories found there.
76 76
77 By default, XEmacs does not have a pre-configured last package 77 By default, XEmacs does not have a pre-configured last package
78 hierarchy. Last hierarchies are primarily for using package 78 hierarchy. Last hierarchies are primarily for using package hierarchies
79 hierarchies of outdated versions of XEmacs as a fallback option. For 79 of outdated versions of XEmacs as a fallback option. For example, it is
80 example, it is possible to run XEmacs with the 20.4 package hierarchy 80 possible to run XEmacs 21.0 with the 20.4 package hierarchy as a last
81 as a last hierarchy. 81 hierarchy.
82 82
83 It is possible to specify at configure-time the location of the various 83 It is possible to specify at configure-time the location of the various
84 package hierarchies with the @code{--package-path} option to configure. 84 package hierarchies with the @code{--package-path} option to configure.
85 @cindex package path 85 @cindex package path
86 The early, late, and last components of the package path are separated 86 The early, late, and last components of the package path are separated
101 @subsection Directories and Paths 101 @subsection Directories and Paths
102 @cindex paths 102 @cindex paths
103 103
104 Here is a list of the various directories and paths XEmacs tries to 104 Here is a list of the various directories and paths XEmacs tries to
105 locate during startup. XEmacs distinguishes between directories and 105 locate during startup. XEmacs distinguishes between directories and
106 paths specific to @emph{version}, @emph{site}, and @emph{architecture} 106 paths specific to @dfn{version}, @dfn{site}, and @dfn{architecture}
107 when looking for them. 107 when looking for them.
108 108
109 @table @code 109 @table @code
110 @item version-specific 110 @item version-specific
111 @cindex version-specific directories
111 directories are specific to the version of XEmacs they belong to and 112 directories are specific to the version of XEmacs they belong to and
112 typically reside under @file{<root>/lib/xemacs-<VERSION>}. 113 typically reside under @file{<root>/lib/xemacs-<VERSION>}.
113 @item site-specific 114 @item site-specific
115 @cindex site-specific directories
114 directories are independent of the version of XEmacs they belong to and 116 directories are independent of the version of XEmacs they belong to and
115 typically reside under @file{<root>/lib/xemacs} 117 typically reside under @file{<root>/lib/xemacs}
116 @item architecture-specific 118 @item architecture-specific
119 @cindex architecture-specific directories
117 directories are specific both to the version of XEmacs and the 120 directories are specific both to the version of XEmacs and the
118 architecture it runs on and typically reside under 121 architecture it runs on and typically reside under
119 @file{<root>/lib/xemacs-<VERSION>/<ARCHITECTURE>}. 122 @file{<root>/lib/xemacs-<VERSION>/<ARCHITECTURE>}.
120 @end table 123 @end table
121 124
175 Is the path for executables which XEmacs may want to start. It contains 178 Is the path for executables which XEmacs may want to start. It contains
176 the package executable paths as well as @code{exec-directory}, and the 179 the package executable paths as well as @code{exec-directory}, and the
177 directories of the environment variables @code{PATH} 180 directories of the environment variables @code{PATH}
178 @vindex PATH 181 @vindex PATH
179 and @code{EMACSPATH}. 182 and @code{EMACSPATH}.
180 @vindex EMCSPATH 183 @vindex EMACSPATH
181 184
182 @item doc-directory 185 @item doc-directory
183 @vindex doc-directory 186 @vindex doc-directory
184 Is the directory containing the architecture-specific @file{DOC} file 187 Is the directory containing the architecture-specific @file{DOC} file
185 that contains documentation for XEmacs' commands. 188 that contains documentation for XEmacs' commands.