Mercurial > emacs
annotate lispref/loading.texi @ 60496:3a569489ffdb
(Single Shell, Shell Options): Fix previous change.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 08 Mar 2005 02:57:30 +0000 |
parents | cfd3265fdbc5 |
children | 32b9b0540e8a 7e3f621f1dd4 |
rev | line source |
---|---|
6453 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
56215 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, |
60052 | 4 @c 2003, 2004, 2005 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
5 @c Free Software Foundation, Inc. |
6453 | 6 @c See the file elisp.texi for copying conditions. |
7 @setfilename ../info/loading | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
8 @node Loading, Byte Compilation, Customization, Top |
6453 | 9 @chapter Loading |
10 @cindex loading | |
11 @cindex library | |
12 @cindex Lisp library | |
13 | |
14 Loading a file of Lisp code means bringing its contents into the Lisp | |
15 environment in the form of Lisp objects. Emacs finds and opens the | |
16 file, reads the text, evaluates each form, and then closes the file. | |
17 | |
18 The load functions evaluate all the expressions in a file just | |
19 as the @code{eval-current-buffer} function evaluates all the | |
20 expressions in a buffer. The difference is that the load functions | |
21 read and evaluate the text in the file as found on disk, not the text | |
22 in an Emacs buffer. | |
23 | |
24 @cindex top-level form | |
25 The loaded file must contain Lisp expressions, either as source code | |
7212 | 26 or as byte-compiled code. Each form in the file is called a |
27 @dfn{top-level form}. There is no special format for the forms in a | |
6453 | 28 loadable file; any form in a file may equally well be typed directly |
29 into a buffer and evaluated there. (Indeed, most code is tested this | |
30 way.) Most often, the forms are function definitions and variable | |
31 definitions. | |
32 | |
33 A file containing Lisp code is often called a @dfn{library}. Thus, | |
34 the ``Rmail library'' is a file containing code for Rmail mode. | |
35 Similarly, a ``Lisp library directory'' is a directory of files | |
36 containing Lisp code. | |
37 | |
38 @menu | |
59139 | 39 * How Programs Do Loading:: The @code{load} function and others. |
40 * Library Search:: Finding a library to load. | |
41 * Loading Non-ASCII:: Non-@acronym{ASCII} characters in Emacs Lisp files. | |
42 * Autoload:: Setting up a function to autoload. | |
43 * Repeated Loading:: Precautions about loading a file twice. | |
44 * Named Features:: Loading a library if it isn't already loaded. | |
45 * Where Defined:: Finding which file defined a certain symbol. | |
59164
a108297939dd
(Loading): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59139
diff
changeset
|
46 * Unloading:: How to ``unload'' a library that was loaded. |
59139 | 47 * Hooks for Loading:: Providing code to be run when |
48 particular libraries are loaded. | |
6453 | 49 @end menu |
50 | |
51 @node How Programs Do Loading | |
52 @section How Programs Do Loading | |
53 | |
54 Emacs Lisp has several interfaces for loading. For example, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
55 @code{autoload} creates a placeholder object for a function defined in a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
56 file; trying to call the autoloading function loads the file to get the |
6453 | 57 function's real definition (@pxref{Autoload}). @code{require} loads a |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
58 file if it isn't already loaded (@pxref{Named Features}). Ultimately, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
59 all these facilities call the @code{load} function to do the work. |
6453 | 60 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
61 @defun load filename &optional missing-ok nomessage nosuffix must-suffix |
6453 | 62 This function finds and opens a file of Lisp code, evaluates all the |
63 forms in it, and closes the file. | |
64 | |
65 To find the file, @code{load} first looks for a file named | |
66 @file{@var{filename}.elc}, that is, for a file whose name is | |
67 @var{filename} with @samp{.elc} appended. If such a file exists, it is | |
68 loaded. If there is no file by that name, then @code{load} looks for a | |
7212 | 69 file named @file{@var{filename}.el}. If that file exists, it is loaded. |
6453 | 70 Finally, if neither of those names is found, @code{load} looks for a |
71 file named @var{filename} with nothing appended, and loads it if it | |
72 exists. (The @code{load} function is not clever about looking at | |
73 @var{filename}. In the perverse case of a file named @file{foo.el.el}, | |
74 evaluation of @code{(load "foo.el")} will indeed find it.) | |
75 | |
76 If the optional argument @var{nosuffix} is non-@code{nil}, then the | |
77 suffixes @samp{.elc} and @samp{.el} are not tried. In this case, you | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
78 must specify the precise file name you want. By specifying the precise |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
79 file name and using @code{t} for @var{nosuffix}, you can prevent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
80 perverse file names such as @file{foo.el.el} from being tried. |
6453 | 81 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
82 If the optional argument @var{must-suffix} is non-@code{nil}, then |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
83 @code{load} insists that the file name used must end in either |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
84 @samp{.el} or @samp{.elc}, unless it contains an explicit directory |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
85 name. If @var{filename} does not contain an explicit directory name, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
86 and does not end in a suffix, then @code{load} insists on adding one. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
87 |
6453 | 88 If @var{filename} is a relative file name, such as @file{foo} or |
89 @file{baz/foo.bar}, @code{load} searches for the file using the variable | |
90 @code{load-path}. It appends @var{filename} to each of the directories | |
91 listed in @code{load-path}, and loads the first file it finds whose name | |
92 matches. The current default directory is tried only if it is specified | |
93 in @code{load-path}, where @code{nil} stands for the default directory. | |
94 @code{load} tries all three possible suffixes in the first directory in | |
95 @code{load-path}, then all three suffixes in the second directory, and | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
96 so on. @xref{Library Search}. |
6453 | 97 |
98 If you get a warning that @file{foo.elc} is older than @file{foo.el}, it | |
99 means you should consider recompiling @file{foo.el}. @xref{Byte | |
100 Compilation}. | |
101 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
102 When loading a source file (not compiled), @code{load} performs |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
103 character set translation just as Emacs would do when visiting the file. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
104 @xref{Coding Systems}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
105 |
6453 | 106 Messages like @samp{Loading foo...} and @samp{Loading foo...done} appear |
107 in the echo area during loading unless @var{nomessage} is | |
108 non-@code{nil}. | |
109 | |
110 @cindex load errors | |
111 Any unhandled errors while loading a file terminate loading. If the | |
7212 | 112 load was done for the sake of @code{autoload}, any function definitions |
113 made during the loading are undone. | |
6453 | 114 |
115 @kindex file-error | |
116 If @code{load} can't find the file to load, then normally it signals the | |
117 error @code{file-error} (with @samp{Cannot open load file | |
118 @var{filename}}). But if @var{missing-ok} is non-@code{nil}, then | |
119 @code{load} just returns @code{nil}. | |
120 | |
12067 | 121 You can use the variable @code{load-read-function} to specify a function |
122 for @code{load} to use instead of @code{read} for reading expressions. | |
123 See below. | |
124 | |
6453 | 125 @code{load} returns @code{t} if the file loads successfully. |
126 @end defun | |
127 | |
128 @deffn Command load-file filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
129 This command loads the file @var{filename}. If @var{filename} is a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
130 relative file name, then the current default directory is assumed. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
131 @code{load-path} is not used, and suffixes are not appended. Use this |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
132 command if you wish to specify precisely the file name to load. |
6453 | 133 @end deffn |
134 | |
135 @deffn Command load-library library | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
136 This command loads the library named @var{library}. It is equivalent to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
137 @code{load}, except in how it reads its argument interactively. |
6453 | 138 @end deffn |
139 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
140 @defvar load-in-progress |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
141 This variable is non-@code{nil} if Emacs is in the process of loading a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
142 file, and it is @code{nil} otherwise. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
143 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
144 |
56215 | 145 @defvar load-read-function |
53299
3abc89cd99a2
(How Programs Do Loading): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
146 @anchor{Definition of load-read-function} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
147 This variable specifies an alternate expression-reading function for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
148 @code{load} and @code{eval-region} to use instead of @code{read}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
149 The function should accept one argument, just as @code{read} does. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
150 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
151 Normally, the variable's value is @code{nil}, which means those |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
152 functions should use @code{read}. |
22419
3967db186db6
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
153 |
52626 | 154 Instead of using this variable, it is cleaner to use another, newer |
155 feature: to pass the function as the @var{read-function} argument to | |
53299
3abc89cd99a2
(How Programs Do Loading): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
156 @code{eval-region}. @xref{Definition of eval-region,, Eval}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
157 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
158 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
159 For information about how @code{load} is used in building Emacs, see |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
160 @ref{Building Emacs}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
161 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
162 @node Library Search |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
163 @section Library Search |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
164 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
165 When Emacs loads a Lisp library, it searches for the library |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
166 in a list of directories specified by the variable @code{load-path}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
167 |
6453 | 168 @defopt load-path |
169 @cindex @code{EMACSLOADPATH} environment variable | |
170 The value of this variable is a list of directories to search when | |
171 loading files with @code{load}. Each element is a string (which must be | |
172 a directory name) or @code{nil} (which stands for the current working | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
173 directory). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
174 @end defopt |
6453 | 175 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
176 The value of @code{load-path} is initialized from the environment |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
177 variable @code{EMACSLOADPATH}, if that exists; otherwise its default |
54035
5089d03a2061
(Unloading): Document unload-feature-special-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
53299
diff
changeset
|
178 value is specified in @file{emacs/src/epaths.h} when Emacs is built. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
179 Then the list is expanded by adding subdirectories of the directories |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
180 in the list. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
181 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
182 The syntax of @code{EMACSLOADPATH} is the same as used for @code{PATH}; |
12098 | 183 @samp{:} (or @samp{;}, according to the operating system) separates |
184 directory names, and @samp{.} is used for the current default directory. | |
185 Here is an example of how to set your @code{EMACSLOADPATH} variable from | |
186 a @code{csh} @file{.login} file: | |
6453 | 187 |
188 @smallexample | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
189 setenv EMACSLOADPATH .:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp |
6453 | 190 @end smallexample |
191 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
192 Here is how to set it using @code{sh}: |
6453 | 193 |
194 @smallexample | |
195 export EMACSLOADPATH | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
196 EMACSLOADPATH=.:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp |
6453 | 197 @end smallexample |
198 | |
25875 | 199 Here is an example of code you can place in your init file (@pxref{Init |
200 File}) to add several directories to the front of your default | |
201 @code{load-path}: | |
6453 | 202 |
203 @smallexample | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
204 @group |
6453 | 205 (setq load-path |
206 (append (list nil "/user/bil/emacs" | |
207 "/usr/local/lisplib" | |
12315
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
208 "~/emacs") |
6453 | 209 load-path)) |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
210 @end group |
6453 | 211 @end smallexample |
212 | |
213 @c Wordy to rid us of an overfull hbox. --rjc 15mar92 | |
214 @noindent | |
215 In this example, the path searches the current working directory first, | |
12315
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
216 followed then by the @file{/user/bil/emacs} directory, the |
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
217 @file{/usr/local/lisplib} directory, and the @file{~/emacs} directory, |
6453 | 218 which are then followed by the standard directories for Lisp code. |
219 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
220 Dumping Emacs uses a special value of @code{load-path}. If the value of |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
221 @code{load-path} at the end of dumping is unchanged (that is, still the |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
222 same special value), the dumped Emacs switches to the ordinary |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
223 @code{load-path} value when it starts up, as described above. But if |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
224 @code{load-path} has any other value at the end of dumping, that value |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
225 is used for execution of the dumped Emacs also. |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
226 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
227 Therefore, if you want to change @code{load-path} temporarily for |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
228 loading a few libraries in @file{site-init.el} or @file{site-load.el}, |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
229 you should bind @code{load-path} locally with @code{let} around the |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
230 calls to @code{load}. |
6453 | 231 |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
232 The default value of @code{load-path}, when running an Emacs which has |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
233 been installed on the system, includes two special directories (and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
234 their subdirectories as well): |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
235 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
236 @smallexample |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
237 "/usr/local/share/emacs/@var{version}/site-lisp" |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
238 @end smallexample |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
239 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
240 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
241 and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
242 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
243 @smallexample |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
244 "/usr/local/share/emacs/site-lisp" |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
245 @end smallexample |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
246 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
247 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
248 The first one is for locally installed packages for a particular Emacs |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
249 version; the second is for locally installed packages meant for use with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
250 all installed Emacs versions. |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
251 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
252 There are several reasons why a Lisp package that works well in one |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
253 Emacs version can cause trouble in another. Sometimes packages need |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
254 updating for incompatible changes in Emacs; sometimes they depend on |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
255 undocumented internal Emacs data that can change without notice; |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
256 sometimes a newer Emacs version incorporates a version of the package, |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
257 and should be used only with that version. |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
258 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
259 Emacs finds these directories' subdirectories and adds them to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
260 @code{load-path} when it starts up. Both immediate subdirectories and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
261 subdirectories multiple levels down are added to @code{load-path}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
262 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
263 Not all subdirectories are included, though. Subdirectories whose |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
264 names do not start with a letter or digit are excluded. Subdirectories |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
265 named @file{RCS} or @file{CVS} are excluded. Also, a subdirectory which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
266 contains a file named @file{.nosearch} is excluded. You can use these |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
267 methods to prevent certain subdirectories of the @file{site-lisp} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
268 directories from being searched. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
269 |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
270 If you run Emacs from the directory where it was built---that is, an |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
271 executable that has not been formally installed---then @code{load-path} |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
272 normally contains two additional directories. These are the @code{lisp} |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
273 and @code{site-lisp} subdirectories of the main build directory. (Both |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
274 are represented as absolute file names.) |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
275 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
276 @deffn Command locate-library library &optional nosuffix path interactive-call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
277 This command finds the precise file name for library @var{library}. It |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
278 searches for the library in the same way @code{load} does, and the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
279 argument @var{nosuffix} has the same meaning as in @code{load}: don't |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
280 add suffixes @samp{.elc} or @samp{.el} to the specified name |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
281 @var{library}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
282 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
283 If the @var{path} is non-@code{nil}, that list of directories is used |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
284 instead of @code{load-path}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
285 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
286 When @code{locate-library} is called from a program, it returns the file |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
287 name as a string. When the user runs @code{locate-library} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
288 interactively, the argument @var{interactive-call} is @code{t}, and this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
289 tells @code{locate-library} to display the file name in the echo area. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
290 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
291 |
51915
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
292 @defvar load-suffixes |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
293 This variable is a list of suffixes (strings) that @code{load} should |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
294 try adding to the specified file name. The default value is |
52764
f2fb09e111f7
(Library Search): Correct default value of load-suffixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52760
diff
changeset
|
295 @code{(".elc" ".el")}. There is no need to include the null suffix. |
51915
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
296 @end defvar |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
297 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
298 @node Loading Non-ASCII |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
299 @section Loading Non-@acronym{ASCII} Characters |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
300 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
301 When Emacs Lisp programs contain string constants with non-@acronym{ASCII} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
302 characters, these can be represented within Emacs either as unibyte |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
303 strings or as multibyte strings (@pxref{Text Representations}). Which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
304 representation is used depends on how the file is read into Emacs. If |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
305 it is read with decoding into multibyte representation, the text of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
306 Lisp program will be multibyte text, and its string constants will be |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
307 multibyte strings. If a file containing Latin-1 characters (for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
308 example) is read without decoding, the text of the program will be |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
309 unibyte text, and its string constants will be unibyte strings. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
310 @xref{Coding Systems}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
311 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
312 To make the results more predictable, Emacs always performs decoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
313 into the multibyte representation when loading Lisp files, even if it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
314 was started with the @samp{--unibyte} option. This means that string |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
315 constants with non-@acronym{ASCII} characters translate into multibyte |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
316 strings. The only exception is when a particular file specifies no |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
317 decoding. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
318 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
319 The reason Emacs is designed this way is so that Lisp programs give |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
320 predictable results, regardless of how Emacs was started. In addition, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
321 this enables programs that depend on using multibyte text to work even |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
322 in a unibyte Emacs. Of course, such programs should be designed to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
323 notice whether the user prefers unibyte or multibyte text, by checking |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
324 @code{default-enable-multibyte-characters}, and convert representations |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
325 appropriately. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
326 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
327 In most Emacs Lisp programs, the fact that non-@acronym{ASCII} strings are |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
328 multibyte strings should not be noticeable, since inserting them in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
329 unibyte buffers converts them to unibyte automatically. However, if |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
330 this does make a difference, you can force a particular Lisp file to be |
22675
cbab915f61bb
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22623
diff
changeset
|
331 interpreted as unibyte by writing @samp{-*-unibyte: t;-*-} in a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
332 comment on the file's first line. With that designator, the file will |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
333 unconditionally be interpreted as unibyte, even in an ordinary |
30499
e603bf6a21ad
Mention keybindings of non-ASCII chars.
Dave Love <fx@gnu.org>
parents:
28603
diff
changeset
|
334 multibyte Emacs session. This can matter when making keybindings to |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
335 non-@acronym{ASCII} characters written as @code{?v@var{literal}}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
336 |
6453 | 337 @node Autoload |
338 @section Autoload | |
339 @cindex autoload | |
340 | |
341 The @dfn{autoload} facility allows you to make a function or macro | |
12098 | 342 known in Lisp, but put off loading the file that defines it. The first |
343 call to the function automatically reads the proper file to install the | |
344 real definition and other associated code, then runs the real definition | |
6453 | 345 as if it had been loaded all along. |
346 | |
347 There are two ways to set up an autoloaded function: by calling | |
348 @code{autoload}, and by writing a special ``magic'' comment in the | |
349 source before the real definition. @code{autoload} is the low-level | |
350 primitive for autoloading; any Lisp program can call @code{autoload} at | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
351 any time. Magic comments are the most convenient way to make a function |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
352 autoload, for packages installed along with Emacs. These comments do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
353 nothing on their own, but they serve as a guide for the command |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
354 @code{update-file-autoloads}, which constructs calls to @code{autoload} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
355 and arranges to execute them when Emacs is built. |
6453 | 356 |
7212 | 357 @defun autoload function filename &optional docstring interactive type |
358 This function defines the function (or macro) named @var{function} so as | |
6453 | 359 to load automatically from @var{filename}. The string @var{filename} |
360 specifies the file to load to get the real definition of @var{function}. | |
361 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
362 If @var{filename} does not contain either a directory name, or the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
363 suffix @code{.el} or @code{.elc}, then @code{autoload} insists on adding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
364 one of these suffixes, and it will not load from a file whose name is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
365 just @var{filename} with no added suffix. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
366 |
6453 | 367 The argument @var{docstring} is the documentation string for the |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
368 function. Specifying the documentation string in the call to |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
369 @code{autoload} makes it possible to look at the documentation without |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
370 loading the function's real definition. Normally, this should be |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
371 identical to the documentation string in the function definition |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
372 itself. If it isn't, the function definition's documentation string |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
373 takes effect when it is loaded. |
6453 | 374 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
375 If @var{interactive} is non-@code{nil}, that says @var{function} can be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
376 called interactively. This lets completion in @kbd{M-x} work without |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
377 loading @var{function}'s real definition. The complete interactive |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
378 specification is not given here; it's not needed unless the user |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
379 actually calls @var{function}, and when that happens, it's time to load |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
380 the real definition. |
6453 | 381 |
382 You can autoload macros and keymaps as well as ordinary functions. | |
383 Specify @var{type} as @code{macro} if @var{function} is really a macro. | |
384 Specify @var{type} as @code{keymap} if @var{function} is really a | |
385 keymap. Various parts of Emacs need to know this information without | |
386 loading the real definition. | |
387 | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
388 An autoloaded keymap loads automatically during key lookup when a prefix |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
389 key's binding is the symbol @var{function}. Autoloading does not occur |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
390 for other kinds of access to the keymap. In particular, it does not |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
391 happen when a Lisp program gets the keymap from the value of a variable |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
392 and calls @code{define-key}; not even if the variable name is the same |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
393 symbol @var{function}. |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
394 |
6453 | 395 @cindex function cell in autoload |
7212 | 396 If @var{function} already has a non-void function definition that is not |
6453 | 397 an autoload object, @code{autoload} does nothing and returns @code{nil}. |
7212 | 398 If the function cell of @var{function} is void, or is already an autoload |
6453 | 399 object, then it is defined as an autoload object like this: |
400 | |
401 @example | |
402 (autoload @var{filename} @var{docstring} @var{interactive} @var{type}) | |
403 @end example | |
404 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
405 For example, |
6453 | 406 |
407 @example | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
408 @group |
6453 | 409 (symbol-function 'run-prolog) |
410 @result{} (autoload "prolog" 169681 t nil) | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
411 @end group |
6453 | 412 @end example |
413 | |
414 @noindent | |
415 In this case, @code{"prolog"} is the name of the file to load, 169681 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
416 refers to the documentation string in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
417 @file{emacs/etc/DOC-@var{version}} file (@pxref{Documentation Basics}), |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
418 @code{t} means the function is interactive, and @code{nil} that it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
419 not a macro or a keymap. |
6453 | 420 @end defun |
421 | |
422 @cindex autoload errors | |
423 The autoloaded file usually contains other definitions and may require | |
424 or provide one or more features. If the file is not completely loaded | |
425 (due to an error in the evaluation of its contents), any function | |
426 definitions or @code{provide} calls that occurred during the load are | |
427 undone. This is to ensure that the next attempt to call any function | |
428 autoloading from this file will try again to load the file. If not for | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
429 this, then some of the functions in the file might be defined by the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
430 aborted load, but fail to work properly for the lack of certain |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
431 subroutines not loaded successfully because they come later in the file. |
6453 | 432 |
433 If the autoloaded file fails to define the desired Lisp function or | |
434 macro, then an error is signaled with data @code{"Autoloading failed to | |
435 define function @var{function-name}"}. | |
436 | |
437 @findex update-file-autoloads | |
438 @findex update-directory-autoloads | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
439 A magic autoload comment consists of @samp{;;;###autoload}, on a line |
6453 | 440 by itself, just before the real definition of the function in its |
441 autoloadable source file. The command @kbd{M-x update-file-autoloads} | |
442 writes a corresponding @code{autoload} call into @file{loaddefs.el}. | |
443 Building Emacs loads @file{loaddefs.el} and thus calls @code{autoload}. | |
444 @kbd{M-x update-directory-autoloads} is even more powerful; it updates | |
445 autoloads for all files in the current directory. | |
446 | |
447 The same magic comment can copy any kind of form into | |
448 @file{loaddefs.el}. If the form following the magic comment is not a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
449 function-defining form or a @code{defcustom} form, it is copied |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
450 verbatim. ``Function-defining forms'' include @code{define-skeleton}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
451 @code{define-derived-mode}, @code{define-generic-mode} and |
28603
cb9db16dba12
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
452 @code{define-minor-mode} as well as @code{defun} and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
453 @code{defmacro}. To save space, a @code{defcustom} form is converted to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
454 a @code{defvar} in @file{loaddefs.el}, with some additional information |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
455 if it uses @code{:require}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
456 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
457 You can also use a magic comment to execute a form at build time |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
458 @emph{without} executing it when the file itself is loaded. To do this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
459 write the form @emph{on the same line} as the magic comment. Since it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
460 is in a comment, it does nothing when you load the source file; but |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
461 @kbd{M-x update-file-autoloads} copies it to @file{loaddefs.el}, where |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
462 it is executed while building Emacs. |
6453 | 463 |
464 The following example shows how @code{doctor} is prepared for | |
465 autoloading with a magic comment: | |
466 | |
467 @smallexample | |
468 ;;;###autoload | |
469 (defun doctor () | |
470 "Switch to *doctor* buffer and start giving psychotherapy." | |
471 (interactive) | |
472 (switch-to-buffer "*doctor*") | |
473 (doctor-mode)) | |
474 @end smallexample | |
475 | |
476 @noindent | |
477 Here's what that produces in @file{loaddefs.el}: | |
478 | |
479 @smallexample | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
480 (autoload 'doctor "doctor" "\ |
6453 | 481 Switch to *doctor* buffer and start giving psychotherapy." |
482 t) | |
483 @end smallexample | |
484 | |
485 @noindent | |
486 The backslash and newline immediately following the double-quote are a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
487 convention used only in the preloaded uncompiled Lisp files such as |
6453 | 488 @file{loaddefs.el}; they tell @code{make-docfile} to put the |
489 documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
490 See also the commentary in @file{lib-src/make-docfile.c}. |
6453 | 491 |
42769
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
492 If you write a function definition with an unusual macro that is not |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
493 one of the known and recognized function definition methods, use of an |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
494 ordinary magic autoload comment would copy the whole definition into |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
495 @code{loaddefs.el}. That is not desirable. You can put the desired |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
496 @code{autoload} call into @code{loaddefs.el} instead by writing this: |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
497 |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
498 @smallexample |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
499 ;;;###autoload (autoload 'foo "myfile") |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
500 (mydefunmacro foo |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
501 ...) |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
502 @end smallexample |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
503 |
6453 | 504 @node Repeated Loading |
505 @section Repeated Loading | |
506 @cindex repeated loading | |
507 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
508 You can load a given file more than once in an Emacs session. For |
6453 | 509 example, after you have rewritten and reinstalled a function definition |
510 by editing it in a buffer, you may wish to return to the original | |
511 version; you can do this by reloading the file it came from. | |
512 | |
513 When you load or reload files, bear in mind that the @code{load} and | |
514 @code{load-library} functions automatically load a byte-compiled file | |
515 rather than a non-compiled file of similar name. If you rewrite a file | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
516 that you intend to save and reinstall, you need to byte-compile the new |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
517 version; otherwise Emacs will load the older, byte-compiled file instead |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
518 of your newer, non-compiled file! If that happens, the message |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
519 displayed when loading the file includes, @samp{(compiled; note, source is |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
520 newer)}, to remind you to recompile it. |
6453 | 521 |
522 When writing the forms in a Lisp library file, keep in mind that the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
523 file might be loaded more than once. For example, think about whether |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
524 each variable should be reinitialized when you reload the library; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
525 @code{defvar} does not change the value if the variable is already |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
526 initialized. (@xref{Defining Variables}.) |
6453 | 527 |
528 The simplest way to add an element to an alist is like this: | |
529 | |
530 @example | |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
531 (push '(leif-mode " Leif") minor-mode-alist) |
6453 | 532 @end example |
533 | |
534 @noindent | |
535 But this would add multiple elements if the library is reloaded. | |
536 To avoid the problem, write this: | |
537 | |
538 @example | |
539 (or (assq 'leif-mode minor-mode-alist) | |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
540 (push '(leif-mode " Leif") minor-mode-alist)) |
6453 | 541 @end example |
542 | |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
543 @noindent |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
544 or this: |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
545 |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
546 @example |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
547 (add-to-list '(leif-mode " Leif") minor-mode-alist) |
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
548 @end example |
12098 | 549 |
6453 | 550 Occasionally you will want to test explicitly whether a library has |
551 already been loaded. Here's one way to test, in a library, whether it | |
552 has been loaded before: | |
553 | |
554 @example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
555 (defvar foo-was-loaded nil) |
12098 | 556 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
557 (unless foo-was-loaded |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
558 @var{execute-first-time-only} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
559 (setq foo-was-loaded t)) |
6453 | 560 @end example |
561 | |
562 @noindent | |
563 If the library uses @code{provide} to provide a named feature, you can | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
564 use @code{featurep} earlier in the file to test whether the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
565 @code{provide} call has been executed before. |
27193 | 566 @ifnottex |
12098 | 567 @xref{Named Features}. |
27193 | 568 @end ifnottex |
6453 | 569 |
12098 | 570 @node Named Features |
6453 | 571 @section Features |
572 @cindex features | |
573 @cindex requiring features | |
574 @cindex providing features | |
575 | |
576 @code{provide} and @code{require} are an alternative to | |
577 @code{autoload} for loading files automatically. They work in terms of | |
578 named @dfn{features}. Autoloading is triggered by calling a specific | |
579 function, but a feature is loaded the first time another program asks | |
580 for it by name. | |
581 | |
582 A feature name is a symbol that stands for a collection of functions, | |
583 variables, etc. The file that defines them should @dfn{provide} the | |
584 feature. Another program that uses them may ensure they are defined by | |
585 @dfn{requiring} the feature. This loads the file of definitions if it | |
586 hasn't been loaded already. | |
587 | |
588 To require the presence of a feature, call @code{require} with the | |
589 feature name as argument. @code{require} looks in the global variable | |
590 @code{features} to see whether the desired feature has been provided | |
591 already. If not, it loads the feature from the appropriate file. This | |
7212 | 592 file should call @code{provide} at the top level to add the feature to |
6453 | 593 @code{features}; if it fails to do so, @code{require} signals an error. |
594 @cindex load error with require | |
595 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
596 For example, in @file{emacs/lisp/prolog.el}, |
6453 | 597 the definition for @code{run-prolog} includes the following code: |
598 | |
599 @smallexample | |
600 (defun run-prolog () | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15767
diff
changeset
|
601 "Run an inferior Prolog process, with I/O via buffer *prolog*." |
6453 | 602 (interactive) |
603 (require 'comint) | |
604 (switch-to-buffer (make-comint "prolog" prolog-program-name)) | |
605 (inferior-prolog-mode)) | |
606 @end smallexample | |
607 | |
608 @noindent | |
609 The expression @code{(require 'comint)} loads the file @file{comint.el} | |
610 if it has not yet been loaded. This ensures that @code{make-comint} is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
611 defined. Features are normally named after the files that provide them, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
612 so that @code{require} need not be given the file name. |
6453 | 613 |
614 The @file{comint.el} file contains the following top-level expression: | |
615 | |
616 @smallexample | |
617 (provide 'comint) | |
618 @end smallexample | |
619 | |
620 @noindent | |
621 This adds @code{comint} to the global @code{features} list, so that | |
622 @code{(require 'comint)} will henceforth know that nothing needs to be | |
623 done. | |
624 | |
625 @cindex byte-compiling @code{require} | |
7212 | 626 When @code{require} is used at top level in a file, it takes effect |
6453 | 627 when you byte-compile that file (@pxref{Byte Compilation}) as well as |
628 when you load it. This is in case the required package contains macros | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
629 that the byte compiler must know about. It also avoids byte-compiler |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
630 warnings for functions and variables defined in the file loaded with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
631 @code{require}. |
6453 | 632 |
633 Although top-level calls to @code{require} are evaluated during | |
634 byte compilation, @code{provide} calls are not. Therefore, you can | |
635 ensure that a file of definitions is loaded before it is byte-compiled | |
636 by including a @code{provide} followed by a @code{require} for the same | |
637 feature, as in the following example. | |
638 | |
639 @smallexample | |
640 @group | |
641 (provide 'my-feature) ; @r{Ignored by byte compiler,} | |
642 ; @r{evaluated by @code{load}.} | |
643 (require 'my-feature) ; @r{Evaluated by byte compiler.} | |
644 @end group | |
645 @end smallexample | |
646 | |
7212 | 647 @noindent |
648 The compiler ignores the @code{provide}, then processes the | |
649 @code{require} by loading the file in question. Loading the file does | |
650 execute the @code{provide} call, so the subsequent @code{require} call | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
651 does nothing when the file is loaded. |
7212 | 652 |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
653 @defun provide feature &optional subfeatures |
6453 | 654 This function announces that @var{feature} is now loaded, or being |
655 loaded, into the current Emacs session. This means that the facilities | |
656 associated with @var{feature} are or will be available for other Lisp | |
657 programs. | |
658 | |
659 The direct effect of calling @code{provide} is to add @var{feature} to | |
660 the front of the list @code{features} if it is not already in the list. | |
661 The argument @var{feature} must be a symbol. @code{provide} returns | |
662 @var{feature}. | |
663 | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
664 If provided, @var{subfeatures} should be a list of symbols indicating |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
665 a set of specific subfeatures provided by this version of @var{feature}. |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
666 You can test the presence of a subfeature using @code{featurep}. |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
667 |
6453 | 668 @smallexample |
669 features | |
670 @result{} (bar bish) | |
671 | |
672 (provide 'foo) | |
673 @result{} foo | |
674 features | |
675 @result{} (foo bar bish) | |
676 @end smallexample | |
677 | |
12098 | 678 When a file is loaded to satisfy an autoload, and it stops due to an |
52764
f2fb09e111f7
(Library Search): Correct default value of load-suffixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52760
diff
changeset
|
679 error in the evaluation of its contents, any function definitions or |
12098 | 680 @code{provide} calls that occurred during the load are undone. |
681 @xref{Autoload}. | |
6453 | 682 @end defun |
683 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22675
diff
changeset
|
684 @defun require feature &optional filename noerror |
6453 | 685 This function checks whether @var{feature} is present in the current |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
686 Emacs session (using @code{(featurep @var{feature})}; see below). The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
687 argument @var{feature} must be a symbol. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
688 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
689 If the feature is not present, then @code{require} loads @var{filename} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
690 with @code{load}. If @var{filename} is not supplied, then the name of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
691 the symbol @var{feature} is used as the base file name to load. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
692 However, in this case, @code{require} insists on finding @var{feature} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
693 with an added suffix; a file whose name is just @var{feature} won't be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
694 used. |
6453 | 695 |
55860
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
696 If @var{noerror} is non-@code{nil}, that suppresses errors from actual |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
697 loading of the file. In that case, @code{require} returns @code{nil} |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
698 if loading the file fails. Normally, @code{require} returns |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
699 @var{feature}. |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
700 |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
701 If loading the file succeeds but does not provide @var{feature}, |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
702 @code{require} signals an error, @samp{Required feature @var{feature} |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
703 was not provided}. |
6453 | 704 @end defun |
705 | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
706 @defun featurep feature &optional subfeature |
51681
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
707 This function returns @code{t} if @var{feature} has been provided in |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
708 the current Emacs session (i.e.@:, if @var{feature} is a member of |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
709 @code{features}.) If @var{subfeature} is non-@code{nil}, then the |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
710 function returns @code{t} only if that subfeature is provided as well |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
711 (i.e.@: if @var{subfeature} is a member of the @code{subfeature} |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
712 property of the @var{feature} symbol.) |
6453 | 713 @end defun |
714 | |
715 @defvar features | |
716 The value of this variable is a list of symbols that are the features | |
717 loaded in the current Emacs session. Each symbol was put in this list | |
718 with a call to @code{provide}. The order of the elements in the | |
719 @code{features} list is not significant. | |
720 @end defvar | |
721 | |
59134
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
722 @node Where Defined |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
723 @section Which File Defined a Certain Symbol |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
724 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
725 @defun symbol-file symbol &optional type |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
726 This function returns the name of the file that defined @var{symbol}. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
727 If @var{type} is @code{nil}, then any kind of definition is |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
728 acceptable. If @var{type} is @code{defun} or @code{defvar}, that |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
729 specifies function definition only or variable definition only. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
730 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
731 The value is the file name as it was specified to @code{load}: |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
732 either an absolute file name, or a library name |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
733 (with no directory name and no @samp{.el} or @samp{.elc} at the end). |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
734 It can also be @code{nil}, if the definition is not associated with any file. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
735 @end defun |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
736 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
737 The basis for @code{symbol-file} is the data in the variable |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
738 @code{load-history}. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
739 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
740 @defvar load-history |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
741 This variable's value is an alist connecting library names with the |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
742 names of functions and variables they define, the features they provide, |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
743 and the features they require. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
744 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
745 Each element is a list and describes one library. The @sc{car} of the |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
746 list is the name of the library, as a string. The rest of the list |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
747 elements have these forms: |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
748 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
749 @table @code |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
750 @item @var{var} |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
751 The symbol @var{var} was defined as a variable. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
752 @item (defun . @var{fun}) |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
753 The function @var{fun} was defined. |
59134
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
754 @item (t . @var{fun}) |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
755 The function @var{fun} was previously an autoload before this library |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
756 redefined it as a function. The following element is always |
60052 | 757 @code{(defun . @var{fun})}, which represents defining @var{fun} as a |
60041
123a4dbb8a87
(Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents:
59164
diff
changeset
|
758 function. |
59134
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
759 @item (autoload . @var{fun}) |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
760 The function @var{fun} was defined as an autoload. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
761 @item (require . @var{feature}) |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
762 The feature @var{feature} was required. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
763 @item (provide . @var{feature}) |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
764 The feature @var{feature} was provided. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
765 @end table |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
766 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
767 The value of @code{load-history} may have one element whose @sc{car} is |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
768 @code{nil}. This element describes definitions made with |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
769 @code{eval-buffer} on a buffer that is not visiting a file. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
770 @end defvar |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
771 |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
772 The command @code{eval-region} updates @code{load-history}, but does so |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
773 by adding the symbols defined to the element for the file being visited, |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
774 rather than replacing that element. @xref{Eval}. |
26d02bae850d
(Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents:
56215
diff
changeset
|
775 |
6453 | 776 @node Unloading |
777 @section Unloading | |
778 @cindex unloading | |
779 | |
780 @c Emacs 19 feature | |
781 You can discard the functions and variables loaded by a library to | |
782 reclaim memory for other Lisp objects. To do this, use the function | |
783 @code{unload-feature}: | |
784 | |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
785 @deffn Command unload-feature feature &optional force |
6453 | 786 This command unloads the library that provided feature @var{feature}. |
7212 | 787 It undefines all functions, macros, and variables defined in that |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
788 library with @code{defun}, @code{defalias}, @code{defsubst}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
789 @code{defmacro}, @code{defconst}, @code{defvar}, and @code{defcustom}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
790 It then restores any autoloads formerly associated with those symbols. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 (Loading saves these in the @code{autoload} property of the symbol.) |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
792 |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
793 @vindex unload-feature-special-hooks |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
794 Before restoring the previous definitions, @code{unload-feature} runs |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
795 @code{remove-hook} to remove functions in the library from certain |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
796 hooks. These hooks include variables whose names end in @samp{hook} |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
797 or @samp{-hooks}, plus those listed in |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
798 @code{unload-feature-special-hooks}. This is to prevent Emacs from |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
799 ceasing to function because important hooks refer to functions that |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
800 are no longer defined. |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
801 |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
802 @vindex @var{feature}-unload-hook |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
803 If these measures are not sufficient to prevent malfunction, a library |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
804 can define an explicit unload hook. If @code{@var{feature}-unload-hook} |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
805 is defined, it is run as a normal hook before restoring the previous |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
806 definitions, @emph{instead of} the usual hook-removing actions. The |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
807 unload hook ought to undo all the global state changes made by the |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
808 library that might cease to work once the library is unloaded. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
809 @code{unload-feature} can cause problems with libraries that fail to do |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
810 this, so it should be used with caution. |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
811 |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
812 Ordinarily, @code{unload-feature} refuses to unload a library on which |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
813 other loaded libraries depend. (A library @var{a} depends on library |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
814 @var{b} if @var{a} contains a @code{require} for @var{b}.) If the |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
815 optional argument @var{force} is non-@code{nil}, dependencies are |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
816 ignored and you can unload any library. |
6453 | 817 @end deffn |
818 | |
819 The @code{unload-feature} function is written in Lisp; its actions are | |
820 based on the variable @code{load-history}. | |
821 | |
54035
5089d03a2061
(Unloading): Document unload-feature-special-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
53299
diff
changeset
|
822 @defvar unload-feature-special-hooks |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
823 This variable holds a list of hooks to be scanned before unloading a |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
824 library, to remove functions defined in the library. |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
825 @end defvar |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
826 |
6453 | 827 @node Hooks for Loading |
828 @section Hooks for Loading | |
829 @cindex loading hooks | |
830 @cindex hooks for loading | |
831 | |
832 You can ask for code to be executed if and when a particular library is | |
833 loaded, by calling @code{eval-after-load}. | |
834 | |
835 @defun eval-after-load library form | |
836 This function arranges to evaluate @var{form} at the end of loading the | |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
837 library @var{library}, if and when @var{library} is loaded. If |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
838 @var{library} is already loaded, it evaluates @var{form} right away. |
6453 | 839 |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
840 If @var{library} is a string, it must exactly match the argument of |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
841 @code{load} used to load the library. To get the proper results when an |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
842 installed library is found by searching @code{load-path}, you should not |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
843 include any directory names in @var{library}. |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
844 |
47625
8a11d295c3f3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45979
diff
changeset
|
845 @var{library} can also be a feature (i.e.@: a symbol), in which case |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
846 @var{form} is evaluated when @code{(provide @var{library})} is called. |
6453 | 847 |
848 An error in @var{form} does not undo the load, but does prevent | |
849 execution of the rest of @var{form}. | |
850 @end defun | |
851 | |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
852 In general, well-designed Lisp programs should not use this feature. |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
853 The clean and modular ways to interact with a Lisp library are (1) |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
854 examine and set the library's variables (those which are meant for |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
855 outside use), and (2) call the library's functions. If you wish to |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
856 do (1), you can do it immediately---there is no need to wait for when |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
857 the library is loaded. To do (2), you must load the library (preferably |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
858 with @code{require}). |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
859 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
860 But it is OK to use @code{eval-after-load} in your personal |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
861 customizations if you don't feel they must meet the design standards for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
862 programs meant for wider use. |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
863 |
6453 | 864 @defvar after-load-alist |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
865 This variable holds an alist of expressions to evaluate if and when |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
866 particular libraries are loaded. Each element looks like this: |
6453 | 867 |
868 @example | |
869 (@var{filename} @var{forms}@dots{}) | |
870 @end example | |
871 | |
872 The function @code{load} checks @code{after-load-alist} in order to | |
873 implement @code{eval-after-load}. | |
874 @end defvar | |
875 | |
876 @c Emacs 19 feature | |
52401 | 877 |
878 @ignore | |
879 arch-tag: df731f89-0900-4389-a436-9105241b6f7a | |
880 @end ignore |