Mercurial > emacs
annotate lispref/files.texi @ 33424:82e71ffbac94
Fix header,
(feedmail) <defgroup>: Add :link.
author | Dave Love <fx@gnu.org> |
---|---|
date | Sun, 12 Nov 2000 00:57:08 +0000 |
parents | 7600e7ac0dcd |
children | fdf780ddf0ae |
rev | line source |
---|---|
6555 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6555 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/files | |
7 @node Files, Backups and Auto-Saving, Documentation, Top | |
8 @comment node-name, next, previous, up | |
9 @chapter Files | |
10 | |
11 In Emacs, you can find, create, view, save, and otherwise work with | |
12 files and file directories. This chapter describes most of the | |
13 file-related functions of Emacs Lisp, but a few others are described in | |
14 @ref{Buffers}, and those related to backups and auto-saving are | |
15 described in @ref{Backups and Auto-Saving}. | |
16 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
17 Many of the file functions take one or more arguments that are file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
18 names. A file name is actually a string. Most of these functions |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
19 expand file name arguments by calling @code{expand-file-name}, so that |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
20 @file{~} is handled correctly, as are relative file names (including |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
21 @samp{../}). These functions don't recognize environment variable |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
22 substitutions such as @samp{$HOME}. @xref{File Name Expansion}. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
23 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
24 When file I/O functions signal Lisp errors, they usually use the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
25 condition @code{file-error} (@pxref{Handling Errors}). The error |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
26 message is in most cases obtained from the operating system, according |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
27 to locale @code{system-message-locale}, and decoded using coding system |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
28 @code{locale-coding-system} (@pxref{Locales}). |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
29 |
6555 | 30 @menu |
31 * Visiting Files:: Reading files into Emacs buffers for editing. | |
32 * Saving Buffers:: Writing changed buffers back into files. | |
33 * Reading from Files:: Reading files into buffers without visiting. | |
34 * Writing to Files:: Writing new files from parts of buffers. | |
35 * File Locks:: Locking and unlocking files, to prevent | |
36 simultaneous editing by two people. | |
37 * Information about Files:: Testing existence, accessibility, size of files. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
38 * Changing Files:: Renaming files, changing protection, etc. |
6555 | 39 * File Names:: Decomposing and expanding file names. |
40 * Contents of Directories:: Getting a list of the files in a directory. | |
41 * Create/Delete Dirs:: Creating and Deleting Directories. | |
42 * Magic File Names:: Defining "magic" special handling | |
43 for certain file names. | |
12067 | 44 * Format Conversion:: Conversion to and from various file formats. |
6555 | 45 @end menu |
46 | |
47 @node Visiting Files | |
48 @section Visiting Files | |
49 @cindex finding files | |
50 @cindex visiting files | |
51 | |
52 Visiting a file means reading a file into a buffer. Once this is | |
53 done, we say that the buffer is @dfn{visiting} that file, and call the | |
54 file ``the visited file'' of the buffer. | |
55 | |
56 A file and a buffer are two different things. A file is information | |
57 recorded permanently in the computer (unless you delete it). A buffer, | |
58 on the other hand, is information inside of Emacs that will vanish at | |
59 the end of the editing session (or when you kill the buffer). Usually, | |
60 a buffer contains information that you have copied from a file; then we | |
61 say the buffer is visiting that file. The copy in the buffer is what | |
62 you modify with editing commands. Such changes to the buffer do not | |
63 change the file; therefore, to make the changes permanent, you must | |
64 @dfn{save} the buffer, which means copying the altered buffer contents | |
65 back into the file. | |
66 | |
67 In spite of the distinction between files and buffers, people often | |
68 refer to a file when they mean a buffer and vice-versa. Indeed, we say, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
69 ``I am editing a file,'' rather than, ``I am editing a buffer that I |
6555 | 70 will soon save as a file of the same name.'' Humans do not usually need |
71 to make the distinction explicit. When dealing with a computer program, | |
72 however, it is good to keep the distinction in mind. | |
73 | |
74 @menu | |
75 * Visiting Functions:: The usual interface functions for visiting. | |
76 * Subroutines of Visiting:: Lower-level subroutines that they use. | |
77 @end menu | |
78 | |
79 @node Visiting Functions | |
80 @subsection Functions for Visiting Files | |
81 | |
82 This section describes the functions normally used to visit files. | |
83 For historical reasons, these functions have names starting with | |
84 @samp{find-} rather than @samp{visit-}. @xref{Buffer File Name}, for | |
85 functions and variables that access the visited file name of a buffer or | |
86 that find an existing buffer by its visited file name. | |
87 | |
12098 | 88 In a Lisp program, if you want to look at the contents of a file but |
89 not alter it, the fastest way is to use @code{insert-file-contents} in a | |
90 temporary buffer. Visiting the file is not necessary and takes longer. | |
91 @xref{Reading from Files}. | |
92 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
93 @deffn Command find-file filename &optional wildcards |
6555 | 94 This command selects a buffer visiting the file @var{filename}, |
95 using an existing buffer if there is one, and otherwise creating a | |
96 new buffer and reading the file into it. It also returns that buffer. | |
97 | |
98 The body of the @code{find-file} function is very simple and looks | |
99 like this: | |
100 | |
101 @example | |
102 (switch-to-buffer (find-file-noselect filename)) | |
103 @end example | |
104 | |
105 @noindent | |
106 (See @code{switch-to-buffer} in @ref{Displaying Buffers}.) | |
107 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
108 If @var{wildcards} is non-@code{nil}, which is always true in an |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
109 interactive call, then @code{find-file} expands wildcard characters in |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
110 @var{filename} and visits all the matching files. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
111 |
6555 | 112 When @code{find-file} is called interactively, it prompts for |
113 @var{filename} in the minibuffer. | |
114 @end deffn | |
115 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
116 @defun find-file-noselect filename &optional nowarn rawfile wildcards |
6555 | 117 This function is the guts of all the file-visiting functions. It finds |
118 or creates a buffer visiting the file @var{filename}, and returns it. | |
119 It uses an existing buffer if there is one, and otherwise creates a new | |
120 buffer and reads the file into it. You may make the buffer current or | |
121 display it in a window if you wish, but this function does not do so. | |
122 | |
24952 | 123 If @var{wildcards} is non-@code{nil}, |
124 then @code{find-file-noselect} expands wildcard | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
125 characters in @var{filename} and visits all the matching files. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
126 |
6555 | 127 When @code{find-file-noselect} uses an existing buffer, it first |
128 verifies that the file has not changed since it was last visited or | |
129 saved in that buffer. If the file has changed, then this function asks | |
130 the user whether to reread the changed file. If the user says | |
131 @samp{yes}, any changes previously made in the buffer are lost. | |
132 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
133 This function displays warning or advisory messages in various peculiar |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
134 cases, unless the optional argument @var{nowarn} is non-@code{nil}. For |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
135 example, if it needs to create a buffer, and there is no file named |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
136 @var{filename}, it displays the message @samp{(New file)} in the echo |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
137 area, and leaves the buffer empty. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
138 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
139 The @code{find-file-noselect} function normally calls |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
140 @code{after-find-file} after reading the file (@pxref{Subroutines of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
141 Visiting}). That function sets the buffer major mode, parses local |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
142 variables, warns the user if there exists an auto-save file more recent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
143 than the file just visited, and finishes by running the functions in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
144 @code{find-file-hooks}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
145 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
146 If the optional argument @var{rawfile} is non-@code{nil}, then |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
147 @code{after-find-file} is not called, and the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
148 @code{find-file-not-found-hooks} are not run in case of failure. What's |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
149 more, a non-@code{nil} @var{rawfile} value suppresses coding system |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
150 conversion (@pxref{Coding Systems}) and format conversion (@pxref{Format |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
151 Conversion}). |
6555 | 152 |
32842
b10fc3a9befa
(Visiting Functions): Return value of find-file-noselect may be a list
Kenichi Handa <handa@m17n.org>
parents:
30501
diff
changeset
|
153 The @code{find-file-noselect} function usually returns the buffer that |
b10fc3a9befa
(Visiting Functions): Return value of find-file-noselect may be a list
Kenichi Handa <handa@m17n.org>
parents:
30501
diff
changeset
|
154 is visiting the file @var{filename}. But, if wildcards are actually |
32859
7600e7ac0dcd
(Visiting Functions): Typos.
Gerd Moellmann <gerd@gnu.org>
parents:
32842
diff
changeset
|
155 used and expanded, it returns a list of buffers that are visiting the |
32842
b10fc3a9befa
(Visiting Functions): Return value of find-file-noselect may be a list
Kenichi Handa <handa@m17n.org>
parents:
30501
diff
changeset
|
156 various files. |
6555 | 157 |
158 @example | |
159 @group | |
160 (find-file-noselect "/etc/fstab") | |
161 @result{} #<buffer fstab> | |
162 @end group | |
163 @end example | |
164 @end defun | |
165 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
166 @deffn Command find-file-other-window filename &optional wildcards |
6555 | 167 This command selects a buffer visiting the file @var{filename}, but |
168 does so in a window other than the selected window. It may use another | |
169 existing window or split a window; see @ref{Displaying Buffers}. | |
170 | |
171 When this command is called interactively, it prompts for | |
172 @var{filename}. | |
173 @end deffn | |
174 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
175 @deffn Command find-file-read-only filename &optional wildcards |
6555 | 176 This command selects a buffer visiting the file @var{filename}, like |
177 @code{find-file}, but it marks the buffer as read-only. @xref{Read Only | |
178 Buffers}, for related functions and variables. | |
179 | |
180 When this command is called interactively, it prompts for | |
181 @var{filename}. | |
182 @end deffn | |
183 | |
184 @deffn Command view-file filename | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
185 This command visits @var{filename} using View mode, returning to the |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
186 previous buffer when you exit View mode. View mode is a minor mode that |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
187 provides commands to skim rapidly through the file, but does not let you |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
188 modify the text. Entering View mode runs the normal hook |
12098 | 189 @code{view-mode-hook}. @xref{Hooks}. |
6555 | 190 |
191 When @code{view-file} is called interactively, it prompts for | |
192 @var{filename}. | |
193 @end deffn | |
194 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
195 @tindex find-file-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
196 @defvar find-file-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
197 If this variable is non-@code{nil}, then the various @code{find-file} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
198 commands check for wildcard characters and visit all the files that |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
199 match them. If this is @code{nil}, then wildcard characters are |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
200 not treated specially. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
201 @end defvar |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
202 |
6555 | 203 @defvar find-file-hooks |
204 The value of this variable is a list of functions to be called after a | |
205 file is visited. The file's local-variables specification (if any) will | |
206 have been processed before the hooks are run. The buffer visiting the | |
207 file is current when the hook functions are run. | |
208 | |
209 This variable works just like a normal hook, but we think that renaming | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
210 it would not be advisable. @xref{Hooks}. |
6555 | 211 @end defvar |
212 | |
213 @defvar find-file-not-found-hooks | |
214 The value of this variable is a list of functions to be called when | |
215 @code{find-file} or @code{find-file-noselect} is passed a nonexistent | |
216 file name. @code{find-file-noselect} calls these functions as soon as | |
217 it detects a nonexistent file. It calls them in the order of the list, | |
218 until one of them returns non-@code{nil}. @code{buffer-file-name} is | |
219 already set up. | |
220 | |
221 This is not a normal hook because the values of the functions are | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
222 used, and in many cases only some of the functions are called. |
6555 | 223 @end defvar |
224 | |
225 @node Subroutines of Visiting | |
226 @comment node-name, next, previous, up | |
227 @subsection Subroutines of Visiting | |
228 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
229 The @code{find-file-noselect} function uses two important subroutines |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
230 which are sometimes useful in user Lisp code: @code{create-file-buffer} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
231 and @code{after-find-file}. This section explains how to use them. |
6555 | 232 |
233 @defun create-file-buffer filename | |
234 This function creates a suitably named buffer for visiting | |
235 @var{filename}, and returns it. It uses @var{filename} (sans directory) | |
236 as the name if that name is free; otherwise, it appends a string such as | |
237 @samp{<2>} to get an unused name. See also @ref{Creating Buffers}. | |
238 | |
239 @strong{Please note:} @code{create-file-buffer} does @emph{not} | |
240 associate the new buffer with a file and does not select the buffer. | |
12098 | 241 It also does not use the default major mode. |
6555 | 242 |
243 @example | |
244 @group | |
245 (create-file-buffer "foo") | |
246 @result{} #<buffer foo> | |
247 @end group | |
248 @group | |
249 (create-file-buffer "foo") | |
250 @result{} #<buffer foo<2>> | |
251 @end group | |
252 @group | |
253 (create-file-buffer "foo") | |
254 @result{} #<buffer foo<3>> | |
255 @end group | |
256 @end example | |
257 | |
258 This function is used by @code{find-file-noselect}. | |
259 It uses @code{generate-new-buffer} (@pxref{Creating Buffers}). | |
260 @end defun | |
261 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
262 @defun after-find-file &optional error warn noauto after-find-file-from-revert-buffer nomodes |
6555 | 263 This function sets the buffer major mode, and parses local variables |
264 (@pxref{Auto Major Mode}). It is called by @code{find-file-noselect} | |
265 and by the default revert function (@pxref{Reverting}). | |
266 | |
267 @cindex new file message | |
268 @cindex file open error | |
269 If reading the file got an error because the file does not exist, but | |
270 its directory does exist, the caller should pass a non-@code{nil} value | |
271 for @var{error}. In that case, @code{after-find-file} issues a warning: | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
272 @samp{(New file)}. For more serious errors, the caller should usually not |
6555 | 273 call @code{after-find-file}. |
274 | |
275 If @var{warn} is non-@code{nil}, then this function issues a warning | |
276 if an auto-save file exists and is more recent than the visited file. | |
277 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
278 If @var{noauto} is non-@code{nil}, that says not to enable or disable |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
279 Auto-Save mode. The mode remains enabled if it was enabled before. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
280 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
281 If @var{after-find-file-from-revert-buffer} is non-@code{nil}, that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
282 means this call was from @code{revert-buffer}. This has no direct |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
283 effect, but some mode functions and hook functions check the value |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
284 of this variable. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
285 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
286 If @var{nomodes} is non-@code{nil}, that means don't alter the buffer's |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
287 major mode, don't process local variables specifications in the file, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
288 and don't run @code{find-file-hooks}. This feature is used by |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
289 @code{revert-buffer} in some cases. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
290 |
6555 | 291 The last thing @code{after-find-file} does is call all the functions |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
292 in the list @code{find-file-hooks}. |
6555 | 293 @end defun |
294 | |
295 @node Saving Buffers | |
296 @section Saving Buffers | |
297 | |
298 When you edit a file in Emacs, you are actually working on a buffer | |
299 that is visiting that file---that is, the contents of the file are | |
300 copied into the buffer and the copy is what you edit. Changes to the | |
301 buffer do not change the file until you @dfn{save} the buffer, which | |
302 means copying the contents of the buffer into the file. | |
303 | |
304 @deffn Command save-buffer &optional backup-option | |
305 This function saves the contents of the current buffer in its visited | |
306 file if the buffer has been modified since it was last visited or saved. | |
307 Otherwise it does nothing. | |
308 | |
309 @code{save-buffer} is responsible for making backup files. Normally, | |
310 @var{backup-option} is @code{nil}, and @code{save-buffer} makes a backup | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
311 file only if this is the first save since visiting the file. Other |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
312 values for @var{backup-option} request the making of backup files in |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
313 other circumstances: |
6555 | 314 |
315 @itemize @bullet | |
316 @item | |
317 With an argument of 4 or 64, reflecting 1 or 3 @kbd{C-u}'s, the | |
318 @code{save-buffer} function marks this version of the file to be | |
319 backed up when the buffer is next saved. | |
320 | |
321 @item | |
322 With an argument of 16 or 64, reflecting 2 or 3 @kbd{C-u}'s, the | |
323 @code{save-buffer} function unconditionally backs up the previous | |
324 version of the file before saving it. | |
325 @end itemize | |
326 @end deffn | |
327 | |
26770
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
328 @deffn Command save-some-buffers &optional save-silently-p pred |
6555 | 329 This command saves some modified file-visiting buffers. Normally it |
330 asks the user about each buffer. But if @var{save-silently-p} is | |
331 non-@code{nil}, it saves all the file-visiting buffers without querying | |
332 the user. | |
333 | |
26770
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
334 The optional @var{pred} argument controls which buffers to ask about. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
335 If it is @code{nil}, that means to ask only about file-visiting buffers. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
336 If it is @code{t}, that means also offer to save certain other non-file |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
337 buffers---those that have a non-@code{nil} buffer-local value of |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
338 @code{buffer-offer-save}. (A user who says @samp{yes} to saving a |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
339 non-file buffer is asked to specify the file name to use.) The |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
340 @code{save-buffers-kill-emacs} function passes the value @code{t} for |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
341 @var{pred}. |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
342 |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
343 If @var{pred} is neither @code{t} nor @code{nil}, then it should be |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
344 a function of no arguments. It will be called in each buffer to decide |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
345 whether to offer to save that buffer. If it returns a non-@code{nil} |
2d8554ed8748
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26696
diff
changeset
|
346 value in a certain buffer, that means do offer to save that buffer. |
6555 | 347 @end deffn |
348 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
349 @deffn Command write-file filename &optional confirm |
6555 | 350 This function writes the current buffer into file @var{filename}, makes |
351 the buffer visit that file, and marks it not modified. Then it renames | |
352 the buffer based on @var{filename}, appending a string like @samp{<2>} | |
353 if necessary to make a unique buffer name. It does most of this work by | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
354 calling @code{set-visited-file-name} (@pxref{Buffer File Name}) and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
355 @code{save-buffer}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
356 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
357 If @var{confirm} is non-@code{nil}, that means to ask for confirmation |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
358 before overwriting an existing file. |
6555 | 359 @end deffn |
360 | |
15913
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
361 Saving a buffer runs several hooks. It also performs format |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
362 conversion (@pxref{Format Conversion}), and may save text properties in |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
363 ``annotations'' (@pxref{Saving Properties}). |
f415fdc67ad3
Add xrefs from Saving Buffers to Format Conversion and Saving
Richard M. Stallman <rms@gnu.org>
parents:
15765
diff
changeset
|
364 |
6555 | 365 @defvar write-file-hooks |
366 The value of this variable is a list of functions to be called before | |
367 writing out a buffer to its visited file. If one of them returns | |
368 non-@code{nil}, the file is considered already written and the rest of | |
369 the functions are not called, nor is the usual code for writing the file | |
370 executed. | |
371 | |
372 If a function in @code{write-file-hooks} returns non-@code{nil}, it | |
373 is responsible for making a backup file (if that is appropriate). | |
374 To do so, execute the following code: | |
375 | |
376 @example | |
377 (or buffer-backed-up (backup-buffer)) | |
378 @end example | |
379 | |
380 You might wish to save the file modes value returned by | |
381 @code{backup-buffer} and use that to set the mode bits of the file that | |
382 you write. This is what @code{save-buffer} normally does. | |
383 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
384 The hook functions in @code{write-file-hooks} are also responsible for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
385 encoding the data (if desired): they must choose a suitable coding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
386 system (@pxref{Lisp and Coding Systems}), perform the encoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
387 (@pxref{Explicit Encoding}), and set @code{last-coding-system-used} to |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
388 the coding system that was used (@pxref{Encoding and I/O}). |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
389 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
390 Do not make this variable buffer-local. To set up buffer-specific hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
391 functions, use @code{write-contents-hooks} instead. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
392 |
6555 | 393 Even though this is not a normal hook, you can use @code{add-hook} and |
394 @code{remove-hook} to manipulate the list. @xref{Hooks}. | |
395 @end defvar | |
396 | |
397 @c Emacs 19 feature | |
398 @defvar local-write-file-hooks | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
399 This works just like @code{write-file-hooks}, but it is intended to be |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
400 made buffer-local in particular buffers, and used for hooks that pertain |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
401 to the file name or the way the buffer contents were obtained. |
6555 | 402 |
403 The variable is marked as a permanent local, so that changing the major | |
404 mode does not alter a buffer-local value. This is convenient for | |
405 packages that read ``file'' contents in special ways, and set up hooks | |
406 to save the data in a corresponding way. | |
407 @end defvar | |
408 | |
409 @c Emacs 19 feature | |
410 @defvar write-contents-hooks | |
411 This works just like @code{write-file-hooks}, but it is intended for | |
412 hooks that pertain to the contents of the file, as opposed to hooks that | |
8364 | 413 pertain to where the file came from. Such hooks are usually set up by |
14152
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
414 major modes, as buffer-local bindings for this variable. |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
415 |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
416 This variable automatically becomes buffer-local whenever it is set; |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
417 switching to a new major mode always resets this variable. When you use |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
418 @code{add-hooks} to add an element to this hook, you should @emph{not} |
9c9debb5950f
Clarify write-contents-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
12674
diff
changeset
|
419 specify a non-@code{nil} @var{local} argument, since this variable is |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
420 used @emph{only} buffer-locally. |
6555 | 421 @end defvar |
422 | |
423 @c Emacs 19 feature | |
424 @defvar after-save-hook | |
425 This normal hook runs after a buffer has been saved in its visited file. | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
426 One use of this hook is in Fast Lock mode; it uses this hook to save the |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
427 highlighting information in a cache file. |
6555 | 428 @end defvar |
429 | |
430 @defvar file-precious-flag | |
431 If this variable is non-@code{nil}, then @code{save-buffer} protects | |
432 against I/O errors while saving by writing the new file to a temporary | |
433 name instead of the name it is supposed to have, and then renaming it to | |
434 the intended name after it is clear there are no errors. This procedure | |
435 prevents problems such as a lack of disk space from resulting in an | |
436 invalid file. | |
437 | |
12226 | 438 As a side effect, backups are necessarily made by copying. @xref{Rename |
439 or Copy}. Yet, at the same time, saving a precious file always breaks | |
440 all hard links between the file you save and other file names. | |
6555 | 441 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
442 Some modes give this variable a non-@code{nil} buffer-local value |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
443 in particular buffers. |
6555 | 444 @end defvar |
445 | |
446 @defopt require-final-newline | |
447 This variable determines whether files may be written out that do | |
448 @emph{not} end with a newline. If the value of the variable is | |
449 @code{t}, then @code{save-buffer} silently adds a newline at the end of | |
450 the file whenever the buffer being saved does not already end in one. | |
451 If the value of the variable is non-@code{nil}, but not @code{t}, then | |
452 @code{save-buffer} asks the user whether to add a newline each time the | |
453 case arises. | |
454 | |
455 If the value of the variable is @code{nil}, then @code{save-buffer} | |
456 doesn't add newlines at all. @code{nil} is the default value, but a few | |
457 major modes set it to @code{t} in particular buffers. | |
458 @end defopt | |
459 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
460 See also the function @code{set-visited-file-name} (@pxref{Buffer File |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
461 Name}). |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
462 |
6555 | 463 @node Reading from Files |
464 @comment node-name, next, previous, up | |
465 @section Reading from Files | |
466 | |
467 You can copy a file from the disk and insert it into a buffer | |
468 using the @code{insert-file-contents} function. Don't use the user-level | |
469 command @code{insert-file} in a Lisp program, as that sets the mark. | |
470 | |
471 @defun insert-file-contents filename &optional visit beg end replace | |
472 This function inserts the contents of file @var{filename} into the | |
12226 | 473 current buffer after point. It returns a list of the absolute file name |
6555 | 474 and the length of the data inserted. An error is signaled if |
475 @var{filename} is not the name of a file that can be read. | |
476 | |
12098 | 477 The function @code{insert-file-contents} checks the file contents |
478 against the defined file formats, and converts the file contents if | |
479 appropriate. @xref{Format Conversion}. It also calls the functions in | |
480 the list @code{after-insert-file-functions}; see @ref{Saving | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
481 Properties}. Normally, one of the functions in the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
482 @code{after-insert-file-functions} list determines the coding system |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
483 (@pxref{Coding Systems}) used for decoding the file's contents. |
6555 | 484 |
485 If @var{visit} is non-@code{nil}, this function additionally marks the | |
486 buffer as unmodified and sets up various fields in the buffer so that it | |
487 is visiting the file @var{filename}: these include the buffer's visited | |
488 file name and its last save file modtime. This feature is used by | |
489 @code{find-file-noselect} and you probably should not use it yourself. | |
490 | |
491 If @var{beg} and @var{end} are non-@code{nil}, they should be integers | |
492 specifying the portion of the file to insert. In this case, @var{visit} | |
493 must be @code{nil}. For example, | |
494 | |
495 @example | |
496 (insert-file-contents filename nil 0 500) | |
497 @end example | |
498 | |
499 @noindent | |
500 inserts the first 500 characters of a file. | |
501 | |
502 If the argument @var{replace} is non-@code{nil}, it means to replace the | |
503 contents of the buffer (actually, just the accessible portion) with the | |
504 contents of the file. This is better than simply deleting the buffer | |
505 contents and inserting the whole file, because (1) it preserves some | |
506 marker positions and (2) it puts less data in the undo list. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
507 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
508 It is possible to read a special file (such as a FIFO or an I/O device) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
509 with @code{insert-file-contents}, as long as @var{replace} and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
510 @var{visit} are @code{nil}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
511 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
512 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
513 @defun insert-file-contents-literally filename &optional visit beg end replace |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
514 This function works like @code{insert-file-contents} except that it does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
515 not do format decoding (@pxref{Format Conversion}), does not do |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
516 character code conversion (@pxref{Coding Systems}), does not run |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
517 @code{find-file-hooks}, does not perform automatic uncompression, and so |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
518 on. |
6555 | 519 @end defun |
520 | |
521 If you want to pass a file name to another process so that another | |
522 program can read the file, use the function @code{file-local-copy}; see | |
523 @ref{Magic File Names}. | |
524 | |
525 @node Writing to Files | |
526 @comment node-name, next, previous, up | |
527 @section Writing to Files | |
528 | |
529 You can write the contents of a buffer, or part of a buffer, directly | |
530 to a file on disk using the @code{append-to-file} and | |
531 @code{write-region} functions. Don't use these functions to write to | |
532 files that are being visited; that could cause confusion in the | |
533 mechanisms for visiting. | |
534 | |
535 @deffn Command append-to-file start end filename | |
536 This function appends the contents of the region delimited by | |
537 @var{start} and @var{end} in the current buffer to the end of file | |
538 @var{filename}. If that file does not exist, it is created. This | |
539 function returns @code{nil}. | |
540 | |
541 An error is signaled if @var{filename} specifies a nonwritable file, | |
542 or a nonexistent file in a directory where files cannot be created. | |
543 @end deffn | |
544 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
545 @deffn Command write-region start end filename &optional append visit lockname mustbenew |
6555 | 546 This function writes the region delimited by @var{start} and @var{end} |
547 in the current buffer into the file specified by @var{filename}. | |
548 | |
549 @c Emacs 19 feature | |
550 If @var{start} is a string, then @code{write-region} writes or appends | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
551 that string, rather than text from the buffer. @var{end} is ignored in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
552 this case. |
6555 | 553 |
554 If @var{append} is non-@code{nil}, then the specified text is appended | |
28853 | 555 to the existing file contents (if any). Starting in Emacs 21, if |
556 @var{append} is an integer, then @code{write-region} seeks to that byte | |
557 offset from the start of the file and writes the data from there. | |
6555 | 558 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
559 If @var{mustbenew} is non-@code{nil}, then @code{write-region} asks |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
560 for confirmation if @var{filename} names an existing file. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
561 Starting in Emacs 21, if @var{mustbenew} is the symbol @code{excl}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
562 then @code{write-region} does not ask for confirmation, but instead |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
563 it signals an error @code{file-already-exists} if the file already |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
564 exists. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
565 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
566 The test for an existing file, when @var{mustbenew} is @code{excl}, uses |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
567 a special system feature. At least for files on a local disk, there is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
568 no chance that some other program could create a file of the same name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
569 before Emacs does, without Emacs's noticing. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
570 |
6555 | 571 If @var{visit} is @code{t}, then Emacs establishes an association |
572 between the buffer and the file: the buffer is then visiting that file. | |
573 It also sets the last file modification time for the current buffer to | |
574 @var{filename}'s modtime, and marks the buffer as not modified. This | |
575 feature is used by @code{save-buffer}, but you probably should not use | |
576 it yourself. | |
577 | |
578 @c Emacs 19 feature | |
579 If @var{visit} is a string, it specifies the file name to visit. This | |
580 way, you can write the data to one file (@var{filename}) while recording | |
581 the buffer as visiting another file (@var{visit}). The argument | |
582 @var{visit} is used in the echo area message and also for file locking; | |
583 @var{visit} is stored in @code{buffer-file-name}. This feature is used | |
584 to implement @code{file-precious-flag}; don't use it yourself unless you | |
585 really know what you're doing. | |
586 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
587 The optional argument @var{lockname}, if non-@code{nil}, specifies the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
588 file name to use for purposes of locking and unlocking, overriding |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
589 @var{filename} and @var{visit} for that purpose. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
590 |
12098 | 591 The function @code{write-region} converts the data which it writes to |
592 the appropriate file formats specified by @code{buffer-file-format}. | |
593 @xref{Format Conversion}. It also calls the functions in the list | |
594 @code{write-region-annotate-functions}; see @ref{Saving Properties}. | |
6555 | 595 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
596 Normally, @code{write-region} displays the message @samp{Wrote |
6555 | 597 @var{filename}} in the echo area. If @var{visit} is neither @code{t} |
598 nor @code{nil} nor a string, then this message is inhibited. This | |
599 feature is useful for programs that use files for internal purposes, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
600 files that the user does not need to know about. |
6555 | 601 @end deffn |
602 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
603 @defmac with-temp-file file body... |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
604 The @code{with-temp-file} macro evaluates the @var{body} forms with a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
605 temporary buffer as the current buffer; then, at the end, it writes the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
606 buffer contents into file @var{file}. It kills the temporary buffer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
607 when finished, restoring the buffer that was current before the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
608 @code{with-temp-file} form. Then it returns the value of the last form |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
609 in @var{body}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
610 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
611 The current buffer is restored even in case of an abnormal exit via |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
612 @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
613 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
614 See also @code{with-temp-buffer} in @ref{Current Buffer}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
615 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
616 |
6555 | 617 @node File Locks |
618 @section File Locks | |
619 @cindex file locks | |
620 | |
621 When two users edit the same file at the same time, they are likely to | |
622 interfere with each other. Emacs tries to prevent this situation from | |
623 arising by recording a @dfn{file lock} when a file is being modified. | |
624 Emacs can then detect the first attempt to modify a buffer visiting a | |
625 file that is locked by another Emacs job, and ask the user what to do. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
626 The file lock is really a file, a symbolic link with a special name, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
627 stored in the same directory as the file you are editing. |
6555 | 628 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
629 When you access files using NFS, there may be a small probability that |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
630 you and another user will both lock the same file ``simultaneously''. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
631 If this happens, it is possible for the two users to make changes |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
632 simultaneously, but Emacs will still warn the user who saves second. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
633 Also, the detection of modification of a buffer visiting a file changed |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
634 on disk catches some cases of simultaneous editing; see |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
635 @ref{Modification Time}. |
6555 | 636 |
637 @defun file-locked-p filename | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
638 This function returns @code{nil} if the file @var{filename} is not |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
639 locked. It returns @code{t} if it is locked by this Emacs process, and |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
640 it returns the name of the user who has locked it if it is locked by |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
641 some other job. |
6555 | 642 |
643 @example | |
644 @group | |
645 (file-locked-p "foo") | |
646 @result{} nil | |
647 @end group | |
648 @end example | |
649 @end defun | |
650 | |
651 @defun lock-buffer &optional filename | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
652 This function locks the file @var{filename}, if the current buffer is |
6555 | 653 modified. The argument @var{filename} defaults to the current buffer's |
654 visited file. Nothing is done if the current buffer is not visiting a | |
655 file, or is not modified. | |
656 @end defun | |
657 | |
658 @defun unlock-buffer | |
659 This function unlocks the file being visited in the current buffer, | |
660 if the buffer is modified. If the buffer is not modified, then | |
661 the file should not be locked, so this function does nothing. It also | |
662 does nothing if the current buffer is not visiting a file. | |
663 @end defun | |
664 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
665 File locking is not supported on some systems. On systems that do not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
666 support it, the functions @code{lock-buffer}, @code{unlock-buffer} and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
667 @code{file-locked-p} do nothing and return @code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
668 |
6555 | 669 @defun ask-user-about-lock file other-user |
670 This function is called when the user tries to modify @var{file}, but it | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
671 is locked by another user named @var{other-user}. The default |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
672 definition of this function asks the user to say what to do. The value |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
673 this function returns determines what Emacs does next: |
6555 | 674 |
675 @itemize @bullet | |
676 @item | |
677 A value of @code{t} says to grab the lock on the file. Then | |
678 this user may edit the file and @var{other-user} loses the lock. | |
679 | |
680 @item | |
681 A value of @code{nil} says to ignore the lock and let this | |
682 user edit the file anyway. | |
683 | |
684 @item | |
685 @kindex file-locked | |
686 This function may instead signal a @code{file-locked} error, in which | |
687 case the change that the user was about to make does not take place. | |
688 | |
689 The error message for this error looks like this: | |
690 | |
691 @example | |
692 @error{} File is locked: @var{file} @var{other-user} | |
693 @end example | |
694 | |
695 @noindent | |
696 where @code{file} is the name of the file and @var{other-user} is the | |
697 name of the user who has locked the file. | |
698 @end itemize | |
699 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
700 If you wish, you can replace the @code{ask-user-about-lock} function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
701 with your own version that makes the decision in another way. The code |
6555 | 702 for its usual definition is in @file{userlock.el}. |
703 @end defun | |
704 | |
705 @node Information about Files | |
706 @section Information about Files | |
707 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
708 The functions described in this section all operate on strings that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
709 designate file names. All the functions have names that begin with the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
710 word @samp{file}. These functions all return information about actual |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
711 files or directories, so their arguments must all exist as actual files |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
712 or directories unless otherwise noted. |
6555 | 713 |
714 @menu | |
715 * Testing Accessibility:: Is a given file readable? Writable? | |
716 * Kinds of Files:: Is it a directory? A symbolic link? | |
717 * Truenames:: Eliminating symbolic links from a file name. | |
718 * File Attributes:: How large is it? Any other names? Etc. | |
719 @end menu | |
720 | |
721 @node Testing Accessibility | |
722 @comment node-name, next, previous, up | |
723 @subsection Testing Accessibility | |
724 @cindex accessibility of a file | |
725 @cindex file accessibility | |
726 | |
727 These functions test for permission to access a file in specific ways. | |
728 | |
729 @defun file-exists-p filename | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
730 This function returns @code{t} if a file named @var{filename} appears to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
731 exist. This does not mean you can necessarily read the file, only that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
732 you can find out its attributes. (On Unix and GNU/Linux, this is true |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
733 if the file exists and you have execute permission on the containing |
6555 | 734 directories, regardless of the protection of the file itself.) |
735 | |
736 If the file does not exist, or if fascist access control policies | |
737 prevent you from finding the attributes of the file, this function | |
738 returns @code{nil}. | |
739 @end defun | |
740 | |
741 @defun file-readable-p filename | |
742 This function returns @code{t} if a file named @var{filename} exists | |
743 and you can read it. It returns @code{nil} otherwise. | |
744 | |
745 @example | |
746 @group | |
747 (file-readable-p "files.texi") | |
748 @result{} t | |
749 @end group | |
750 @group | |
751 (file-exists-p "/usr/spool/mqueue") | |
752 @result{} t | |
753 @end group | |
754 @group | |
755 (file-readable-p "/usr/spool/mqueue") | |
756 @result{} nil | |
757 @end group | |
758 @end example | |
759 @end defun | |
760 | |
761 @c Emacs 19 feature | |
762 @defun file-executable-p filename | |
763 This function returns @code{t} if a file named @var{filename} exists and | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
764 you can execute it. It returns @code{nil} otherwise. On Unix and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
765 GNU/Linux, if the file is a directory, execute permission means you can |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
766 check the existence and attributes of files inside the directory, and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
767 open those files if their modes permit. |
6555 | 768 @end defun |
769 | |
770 @defun file-writable-p filename | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
771 This function returns @code{t} if the file @var{filename} can be written |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
772 or created by you, and @code{nil} otherwise. A file is writable if the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
773 file exists and you can write it. It is creatable if it does not exist, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
774 but the specified directory does exist and you can write in that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
775 directory. |
6555 | 776 |
777 In the third example below, @file{foo} is not writable because the | |
778 parent directory does not exist, even though the user could create such | |
779 a directory. | |
780 | |
781 @example | |
782 @group | |
783 (file-writable-p "~/foo") | |
784 @result{} t | |
785 @end group | |
786 @group | |
787 (file-writable-p "/foo") | |
788 @result{} nil | |
789 @end group | |
790 @group | |
791 (file-writable-p "~/no-such-dir/foo") | |
792 @result{} nil | |
793 @end group | |
794 @end example | |
795 @end defun | |
796 | |
797 @c Emacs 19 feature | |
798 @defun file-accessible-directory-p dirname | |
799 This function returns @code{t} if you have permission to open existing | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
800 files in the directory whose name as a file is @var{dirname}; otherwise |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
801 (or if there is no such directory), it returns @code{nil}. The value |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
802 of @var{dirname} may be either a directory name or the file name of a |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
803 file which is a directory. |
6555 | 804 |
805 Example: after the following, | |
806 | |
807 @example | |
808 (file-accessible-directory-p "/foo") | |
809 @result{} nil | |
810 @end example | |
811 | |
812 @noindent | |
813 we can deduce that any attempt to read a file in @file{/foo/} will | |
814 give an error. | |
815 @end defun | |
816 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
817 @defun access-file filename string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
818 This function opens file @var{filename} for reading, then closes it and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
819 returns @code{nil}. However, if the open fails, it signals an error |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
820 using @var{string} as the error message text. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
821 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
822 |
12067 | 823 @defun file-ownership-preserved-p filename |
824 This function returns @code{t} if deleting the file @var{filename} and | |
825 then creating it anew would keep the file's owner unchanged. | |
826 @end defun | |
827 | |
6555 | 828 @defun file-newer-than-file-p filename1 filename2 |
829 @cindex file age | |
830 @cindex file modification time | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
831 This function returns @code{t} if the file @var{filename1} is |
6555 | 832 newer than file @var{filename2}. If @var{filename1} does not |
833 exist, it returns @code{nil}. If @var{filename2} does not exist, | |
834 it returns @code{t}. | |
835 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
836 In the following example, assume that the file @file{aug-19} was written |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
837 on the 19th, @file{aug-20} was written on the 20th, and the file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
838 @file{no-file} doesn't exist at all. |
6555 | 839 |
840 @example | |
841 @group | |
842 (file-newer-than-file-p "aug-19" "aug-20") | |
843 @result{} nil | |
844 @end group | |
845 @group | |
846 (file-newer-than-file-p "aug-20" "aug-19") | |
847 @result{} t | |
848 @end group | |
849 @group | |
850 (file-newer-than-file-p "aug-19" "no-file") | |
851 @result{} t | |
852 @end group | |
853 @group | |
854 (file-newer-than-file-p "no-file" "aug-19") | |
855 @result{} nil | |
856 @end group | |
857 @end example | |
858 | |
859 You can use @code{file-attributes} to get a file's last modification | |
860 time as a list of two numbers. @xref{File Attributes}. | |
861 @end defun | |
862 | |
863 @node Kinds of Files | |
864 @comment node-name, next, previous, up | |
865 @subsection Distinguishing Kinds of Files | |
866 | |
12098 | 867 This section describes how to distinguish various kinds of files, such |
868 as directories, symbolic links, and ordinary files. | |
6555 | 869 |
870 @defun file-symlink-p filename | |
871 @cindex file symbolic links | |
872 If the file @var{filename} is a symbolic link, the @code{file-symlink-p} | |
873 function returns the file name to which it is linked. This may be the | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
874 name of a text file, a directory, or even another symbolic link, or it |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
875 may be a nonexistent file name. |
6555 | 876 |
877 If the file @var{filename} is not a symbolic link (or there is no such file), | |
878 @code{file-symlink-p} returns @code{nil}. | |
879 | |
880 @example | |
881 @group | |
882 (file-symlink-p "foo") | |
883 @result{} nil | |
884 @end group | |
885 @group | |
886 (file-symlink-p "sym-link") | |
887 @result{} "foo" | |
888 @end group | |
889 @group | |
890 (file-symlink-p "sym-link2") | |
891 @result{} "sym-link" | |
892 @end group | |
893 @group | |
894 (file-symlink-p "/bin") | |
895 @result{} "/pub/bin" | |
896 @end group | |
897 @end example | |
898 | |
899 @c !!! file-symlink-p: should show output of ls -l for comparison | |
900 @end defun | |
901 | |
902 @defun file-directory-p filename | |
903 This function returns @code{t} if @var{filename} is the name of an | |
904 existing directory, @code{nil} otherwise. | |
905 | |
906 @example | |
907 @group | |
908 (file-directory-p "~rms") | |
909 @result{} t | |
910 @end group | |
911 @group | |
912 (file-directory-p "~rms/lewis/files.texi") | |
913 @result{} nil | |
914 @end group | |
915 @group | |
916 (file-directory-p "~rms/lewis/no-such-file") | |
917 @result{} nil | |
918 @end group | |
919 @group | |
920 (file-directory-p "$HOME") | |
921 @result{} nil | |
922 @end group | |
923 @group | |
924 (file-directory-p | |
925 (substitute-in-file-name "$HOME")) | |
926 @result{} t | |
927 @end group | |
928 @end example | |
929 @end defun | |
930 | |
12067 | 931 @defun file-regular-p filename |
932 This function returns @code{t} if the file @var{filename} exists and is | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
933 a regular file (not a directory, named pipe, terminal, or |
12067 | 934 other I/O device). |
935 @end defun | |
936 | |
6555 | 937 @node Truenames |
938 @subsection Truenames | |
939 @cindex truename (of file) | |
940 | |
941 @c Emacs 19 features | |
942 The @dfn{truename} of a file is the name that you get by following | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
943 symbolic links at all levels until none remain, then simplifying away |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
944 @samp{.}@: and @samp{..}@: appearing as name components. This results |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
945 in a sort of canonical name for the file. A file does not always have a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
946 unique truename; the number of distinct truenames a file has is equal to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
947 the number of hard links to the file. However, truenames are useful |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
948 because they eliminate symbolic links as a cause of name variation. |
6555 | 949 |
950 @defun file-truename filename | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
951 The function @code{file-truename} returns the truename of the file |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
952 @var{filename}. The argument must be an absolute file name. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
953 @end defun |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
954 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
955 @defun file-chase-links filename |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
956 This function follows symbolic links, starting with @var{filename}, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
957 until it finds a file name which is not the name of a symbolic link. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
958 Then it returns that file name. |
6555 | 959 @end defun |
960 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
961 To illustrate the difference between @code{file-chase-links} and |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
962 @code{file-truename}, suppose that @file{/usr/foo} is a symbolic link to |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
963 the directory @file{/home/foo}, and @file{/home/foo/hello} is an |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
964 ordinary file (or at least, not a symbolic link) or nonexistent. Then |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
965 we would have: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
966 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
967 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
968 (file-chase-links "/usr/foo/hello") |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
969 ;; @r{This does not follow the links in the parent directories.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
970 @result{} "/usr/foo/hello" |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
971 (file-truename "/usr/foo/hello") |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
972 ;; @r{Assuming that @file{/home} is not a symbolic link.} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
973 @result{} "/home/foo/hello" |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
974 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
975 |
6555 | 976 @xref{Buffer File Name}, for related information. |
977 | |
978 @node File Attributes | |
979 @comment node-name, next, previous, up | |
980 @subsection Other Information about Files | |
981 | |
982 This section describes the functions for getting detailed information | |
983 about a file, other than its contents. This information includes the | |
984 mode bits that control access permission, the owner and group numbers, | |
985 the number of names, the inode number, the size, and the times of access | |
986 and modification. | |
987 | |
988 @defun file-modes filename | |
989 @cindex permission | |
990 @cindex file attributes | |
991 This function returns the mode bits of @var{filename}, as an integer. | |
992 The mode bits are also called the file permissions, and they specify | |
993 access control in the usual Unix fashion. If the low-order bit is 1, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
994 then the file is executable by all users, if the second-lowest-order bit |
6555 | 995 is 1, then the file is writable by all users, etc. |
996 | |
997 The highest value returnable is 4095 (7777 octal), meaning that | |
998 everyone has read, write, and execute permission, that the @sc{suid} bit | |
999 is set for both others and group, and that the sticky bit is set. | |
1000 | |
1001 @example | |
1002 @group | |
1003 (file-modes "~/junk/diffs") | |
1004 @result{} 492 ; @r{Decimal integer.} | |
1005 @end group | |
1006 @group | |
1007 (format "%o" 492) | |
1008 @result{} "754" ; @r{Convert to octal.} | |
1009 @end group | |
1010 | |
1011 @group | |
1012 (set-file-modes "~/junk/diffs" 438) | |
1013 @result{} nil | |
1014 @end group | |
1015 | |
1016 @group | |
1017 (format "%o" 438) | |
1018 @result{} "666" ; @r{Convert to octal.} | |
1019 @end group | |
1020 | |
1021 @group | |
1022 % ls -l diffs | |
1023 -rw-rw-rw- 1 lewis 0 3063 Oct 30 16:00 diffs | |
1024 @end group | |
1025 @end example | |
1026 @end defun | |
1027 | |
1028 @defun file-nlinks filename | |
1029 This functions returns the number of names (i.e., hard links) that | |
1030 file @var{filename} has. If the file does not exist, then this function | |
1031 returns @code{nil}. Note that symbolic links have no effect on this | |
1032 function, because they are not considered to be names of the files they | |
1033 link to. | |
1034 | |
1035 @example | |
1036 @group | |
1037 % ls -l foo* | |
1038 -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo | |
1039 -rw-rw-rw- 2 rms 4 Aug 19 01:27 foo1 | |
1040 @end group | |
1041 | |
1042 @group | |
1043 (file-nlinks "foo") | |
1044 @result{} 2 | |
1045 @end group | |
1046 @group | |
1047 (file-nlinks "doesnt-exist") | |
1048 @result{} nil | |
1049 @end group | |
1050 @end example | |
1051 @end defun | |
1052 | |
1053 @defun file-attributes filename | |
1054 This function returns a list of attributes of file @var{filename}. If | |
1055 the specified file cannot be opened, it returns @code{nil}. | |
1056 | |
1057 The elements of the list, in order, are: | |
1058 | |
1059 @enumerate 0 | |
1060 @item | |
1061 @code{t} for a directory, a string for a symbolic link (the name | |
1062 linked to), or @code{nil} for a text file. | |
1063 | |
1064 @c Wordy so as to prevent an overfull hbox. --rjc 15mar92 | |
1065 @item | |
1066 The number of names the file has. Alternate names, also known as hard | |
1067 links, can be created by using the @code{add-name-to-file} function | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1068 (@pxref{Changing Files}). |
6555 | 1069 |
1070 @item | |
1071 The file's @sc{uid}. | |
1072 | |
1073 @item | |
1074 The file's @sc{gid}. | |
1075 | |
1076 @item | |
1077 The time of last access, as a list of two integers. | |
1078 The first integer has the high-order 16 bits of time, | |
1079 the second has the low 16 bits. (This is similar to the | |
1080 value of @code{current-time}; see @ref{Time of Day}.) | |
1081 | |
1082 @item | |
1083 The time of last modification as a list of two integers (as above). | |
1084 | |
1085 @item | |
1086 The time of last status change as a list of two integers (as above). | |
1087 | |
1088 @item | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
1089 The size of the file in bytes. If the size is too large to fit in a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
1090 Lisp integer, this is a floating point number. |
6555 | 1091 |
1092 @item | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1093 The file's modes, as a string of ten letters or dashes, |
6555 | 1094 as in @samp{ls -l}. |
1095 | |
1096 @item | |
1097 @code{t} if the file's @sc{gid} would change if file were | |
1098 deleted and recreated; @code{nil} otherwise. | |
1099 | |
1100 @item | |
17919
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1101 The file's inode number. If possible, this is an integer. If the inode |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1102 number is too large to be represented as an integer in Emacs Lisp, then |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1103 the value has the form @code{(@var{high} . @var{low})}, where @var{low} |
eb712b69e495
The inode number can be an integer.
Richard M. Stallman <rms@gnu.org>
parents:
17398
diff
changeset
|
1104 holds the low 16 bits. |
6555 | 1105 |
1106 @item | |
1107 The file system number of the file system that the file is in. This | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1108 element and the file's inode number together give enough information to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1109 distinguish any two files on the system---no two files can have the same |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1110 values for both of these numbers. |
6555 | 1111 @end enumerate |
1112 | |
1113 For example, here are the file attributes for @file{files.texi}: | |
1114 | |
1115 @example | |
1116 @group | |
1117 (file-attributes "files.texi") | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1118 @result{} (nil 1 2235 75 |
6555 | 1119 (8489 20284) |
1120 (8489 20284) | |
1121 (8489 20285) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1122 14906 "-rw-rw-rw-" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1123 nil 129500 -32252) |
6555 | 1124 @end group |
1125 @end example | |
1126 | |
1127 @noindent | |
1128 and here is how the result is interpreted: | |
1129 | |
1130 @table @code | |
1131 @item nil | |
1132 is neither a directory nor a symbolic link. | |
1133 | |
1134 @item 1 | |
1135 has only one name (the name @file{files.texi} in the current default | |
1136 directory). | |
1137 | |
1138 @item 2235 | |
1139 is owned by the user with @sc{uid} 2235. | |
1140 | |
1141 @item 75 | |
1142 is in the group with @sc{gid} 75. | |
1143 | |
1144 @item (8489 20284) | |
12522 | 1145 was last accessed on Aug 19 00:09. |
6555 | 1146 |
1147 @item (8489 20284) | |
1148 was last modified on Aug 19 00:09. | |
1149 | |
1150 @item (8489 20285) | |
1151 last had its inode changed on Aug 19 00:09. | |
1152 | |
1153 @item 14906 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1154 is 14906 bytes long. (It may not contain 14906 characters, though, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1155 if some of the bytes belong to multibyte sequences.) |
6555 | 1156 |
1157 @item "-rw-rw-rw-" | |
1158 has a mode of read and write access for the owner, group, and world. | |
1159 | |
1160 @item nil | |
1161 would retain the same @sc{gid} if it were recreated. | |
1162 | |
1163 @item 129500 | |
1164 has an inode number of 129500. | |
1165 @item -32252 | |
1166 is on file system number -32252. | |
1167 @end table | |
1168 @end defun | |
1169 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1170 @node Changing Files |
6555 | 1171 @section Changing File Names and Attributes |
1172 @cindex renaming files | |
1173 @cindex copying files | |
1174 @cindex deleting files | |
1175 @cindex linking files | |
1176 @cindex setting modes of files | |
1177 | |
1178 The functions in this section rename, copy, delete, link, and set the | |
1179 modes of files. | |
1180 | |
1181 In the functions that have an argument @var{newname}, if a file by the | |
1182 name of @var{newname} already exists, the actions taken depend on the | |
1183 value of the argument @var{ok-if-already-exists}: | |
1184 | |
1185 @itemize @bullet | |
1186 @item | |
1187 Signal a @code{file-already-exists} error if | |
1188 @var{ok-if-already-exists} is @code{nil}. | |
1189 | |
1190 @item | |
1191 Request confirmation if @var{ok-if-already-exists} is a number. | |
1192 | |
1193 @item | |
1194 Replace the old file without confirmation if @var{ok-if-already-exists} | |
1195 is any other value. | |
1196 @end itemize | |
1197 | |
1198 @defun add-name-to-file oldname newname &optional ok-if-already-exists | |
1199 @cindex file with multiple names | |
1200 @cindex file hard link | |
1201 This function gives the file named @var{oldname} the additional name | |
1202 @var{newname}. This means that @var{newname} becomes a new ``hard | |
1203 link'' to @var{oldname}. | |
1204 | |
1205 In the first part of the following example, we list two files, | |
1206 @file{foo} and @file{foo3}. | |
1207 | |
1208 @example | |
1209 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1210 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1211 81908 -rw-rw-rw- 1 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1212 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 |
6555 | 1213 @end group |
1214 @end example | |
1215 | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1216 Now we create a hard link, by calling @code{add-name-to-file}, then list |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1217 the files again. This shows two names for one file, @file{foo} and |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1218 @file{foo2}. |
6555 | 1219 |
1220 @example | |
1221 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1222 (add-name-to-file "foo" "foo2") |
6555 | 1223 @result{} nil |
1224 @end group | |
1225 | |
1226 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1227 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1228 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1229 81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo2 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1230 84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3 |
6555 | 1231 @end group |
1232 @end example | |
1233 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1234 Finally, we evaluate the following: |
6555 | 1235 |
1236 @example | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1237 (add-name-to-file "foo" "foo3" t) |
6555 | 1238 @end example |
1239 | |
1240 @noindent | |
1241 and list the files again. Now there are three names | |
1242 for one file: @file{foo}, @file{foo2}, and @file{foo3}. The old | |
1243 contents of @file{foo3} are lost. | |
1244 | |
1245 @example | |
1246 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1247 (add-name-to-file "foo1" "foo3") |
6555 | 1248 @result{} nil |
1249 @end group | |
1250 | |
1251 @group | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1252 % ls -li fo* |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1253 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1254 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo2 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1255 81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo3 |
6555 | 1256 @end group |
1257 @end example | |
1258 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1259 This function is meaningless on operating systems where multiple names |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1260 for one file are not allowed. Some systems implement multiple names |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1261 by copying the file instead. |
6555 | 1262 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1263 See also @code{file-nlinks} in @ref{File Attributes}. |
6555 | 1264 @end defun |
1265 | |
1266 @deffn Command rename-file filename newname &optional ok-if-already-exists | |
1267 This command renames the file @var{filename} as @var{newname}. | |
1268 | |
1269 If @var{filename} has additional names aside from @var{filename}, it | |
1270 continues to have those names. In fact, adding the name @var{newname} | |
1271 with @code{add-name-to-file} and then deleting @var{filename} has the | |
1272 same effect as renaming, aside from momentary intermediate states. | |
1273 | |
1274 In an interactive call, this function prompts for @var{filename} and | |
1275 @var{newname} in the minibuffer; also, it requests confirmation if | |
1276 @var{newname} already exists. | |
1277 @end deffn | |
1278 | |
1279 @deffn Command copy-file oldname newname &optional ok-if-exists time | |
1280 This command copies the file @var{oldname} to @var{newname}. An | |
1281 error is signaled if @var{oldname} does not exist. | |
1282 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1283 If @var{time} is non-@code{nil}, then this function gives the new file |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1284 the same last-modified time that the old one has. (This works on only |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1285 some operating systems.) If setting the time gets an error, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1286 @code{copy-file} signals a @code{file-date-error} error. |
6555 | 1287 |
1288 In an interactive call, this function prompts for @var{filename} and | |
1289 @var{newname} in the minibuffer; also, it requests confirmation if | |
1290 @var{newname} already exists. | |
1291 @end deffn | |
1292 | |
1293 @deffn Command delete-file filename | |
1294 @pindex rm | |
1295 This command deletes the file @var{filename}, like the shell command | |
1296 @samp{rm @var{filename}}. If the file has multiple names, it continues | |
1297 to exist under the other names. | |
1298 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1299 A suitable kind of @code{file-error} error is signaled if the file does |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1300 not exist, or is not deletable. (On Unix and GNU/Linux, a file is |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1301 deletable if its directory is writable.) |
6555 | 1302 |
1303 See also @code{delete-directory} in @ref{Create/Delete Dirs}. | |
1304 @end deffn | |
1305 | |
1306 @deffn Command make-symbolic-link filename newname &optional ok-if-exists | |
1307 @pindex ln | |
1308 @kindex file-already-exists | |
1309 This command makes a symbolic link to @var{filename}, named | |
1310 @var{newname}. This is like the shell command @samp{ln -s | |
1311 @var{filename} @var{newname}}. | |
1312 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1313 In an interactive call, this function prompts for @var{filename} and |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1314 @var{newname} in the minibuffer; also, it requests confirmation if |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1315 @var{newname} already exists. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1316 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1317 This function is not available on systems that don't support symbolic |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1318 links. |
6555 | 1319 @end deffn |
1320 | |
1321 @defun define-logical-name varname string | |
1322 This function defines the logical name @var{name} to have the value | |
1323 @var{string}. It is available only on VMS. | |
1324 @end defun | |
1325 | |
1326 @defun set-file-modes filename mode | |
1327 This function sets mode bits of @var{filename} to @var{mode} (which must | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1328 be an integer). Only the low 12 bits of @var{mode} are used. |
6555 | 1329 @end defun |
1330 | |
1331 @c Emacs 19 feature | |
1332 @defun set-default-file-modes mode | |
1333 This function sets the default file protection for new files created by | |
1334 Emacs and its subprocesses. Every file created with Emacs initially has | |
28074
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1335 this protection, or a subset of it (@code{write-region} will not give a |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1336 file execute permission even if the default file protection allows |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1337 execute permission). On Unix and GNU/Linux, the default protection is |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1338 the bitwise complement of the ``umask'' value. |
6555 | 1339 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1340 The argument @var{mode} must be an integer. On most systems, only the |
28074
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1341 low 9 bits of @var{mode} are meaningful. You can use the Lisp construct |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1342 for octal character codes to enter @var{mode}; for example, |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1343 |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1344 @example |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1345 (set-default-file-modes ?\644) |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1346 @end example |
6555 | 1347 |
1348 Saving a modified version of an existing file does not count as creating | |
28074
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1349 the file; it preserves the existing file's mode, whatever that is. So |
25557ce6a3a0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27259
diff
changeset
|
1350 the default file protection has no effect. |
6555 | 1351 @end defun |
1352 | |
1353 @defun default-file-modes | |
1354 This function returns the current default protection value. | |
1355 @end defun | |
1356 | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1357 @cindex MS-DOS and file modes |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1358 @cindex file modes and MS-DOS |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1359 On MS-DOS, there is no such thing as an ``executable'' file mode bit. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1360 So Emacs considers a file executable if its name ends in one of the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1361 standard executable extensions, such as @file{.com}, @file{.bat}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1362 @file{.exe}, and some others. Files that begin with the Unix-standard |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1363 @samp{#!} signature, such as shell and Perl scripts, are also considered |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1364 as executable files. This is reflected in the values returned by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1365 @code{file-modes} and @code{file-attributes}. Directories are also |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1366 reported with executable bit set, for compatibility with Unix. |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
1367 |
6555 | 1368 @node File Names |
1369 @section File Names | |
1370 @cindex file names | |
1371 | |
1372 Files are generally referred to by their names, in Emacs as elsewhere. | |
1373 File names in Emacs are represented as strings. The functions that | |
1374 operate on a file all expect a file name argument. | |
1375 | |
1376 In addition to operating on files themselves, Emacs Lisp programs | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1377 often need to operate on file names; i.e., to take them apart and to use |
6555 | 1378 part of a name to construct related file names. This section describes |
1379 how to manipulate file names. | |
1380 | |
1381 The functions in this section do not actually access files, so they | |
1382 can operate on file names that do not refer to an existing file or | |
1383 directory. | |
1384 | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1385 On MS-DOS and MS-Windows, these functions (like the function that |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1386 actually operate on files) accept MS-DOS or MS-Windows file-name syntax, |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1387 where backslashes separate the components, as well as Unix syntax; but |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1388 they always return Unix syntax. On VMS, these functions (and the ones |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1389 that operate on files) understand both VMS file-name syntax and Unix |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1390 syntax. This enables Lisp programs to specify file names in Unix syntax |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1391 and work properly on all systems without change. |
6555 | 1392 |
1393 @menu | |
1394 * File Name Components:: The directory part of a file name, and the rest. | |
1395 * Directory Names:: A directory's name as a directory | |
1396 is different from its name as a file. | |
1397 * Relative File Names:: Some file names are relative to a current directory. | |
1398 * File Name Expansion:: Converting relative file names to absolute ones. | |
1399 * Unique File Names:: Generating names for temporary files. | |
1400 * File Name Completion:: Finding the completions for a given file name. | |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1401 * Standard File Names:: If your package uses a fixed file name, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1402 how to handle various operating systems simply. |
6555 | 1403 @end menu |
1404 | |
1405 @node File Name Components | |
1406 @subsection File Name Components | |
1407 @cindex directory part (of file name) | |
1408 @cindex nondirectory part (of file name) | |
1409 @cindex version number (in file name) | |
1410 | |
1411 The operating system groups files into directories. To specify a | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1412 file, you must specify the directory and the file's name within that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1413 directory. Therefore, Emacs considers a file name as having two main |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1414 parts: the @dfn{directory name} part, and the @dfn{nondirectory} part |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1415 (or @dfn{file name within the directory}). Either part may be empty. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1416 Concatenating these two parts reproduces the original file name. |
6555 | 1417 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1418 On most systems, the directory part is everything up to and including |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1419 the last slash (backslash is also allowed in input on MS-DOS or |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1420 MS-Windows); the nondirectory part is the rest. The rules in VMS syntax |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1421 are complicated. |
6555 | 1422 |
1423 For some purposes, the nondirectory part is further subdivided into | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1424 the name proper and the @dfn{version number}. On most systems, only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1425 backup files have version numbers in their names. On VMS, every file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1426 has a version number, but most of the time the file name actually used |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1427 in Emacs omits the version number, so that version numbers in Emacs are |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1428 found mostly in directory lists. |
6555 | 1429 |
1430 @defun file-name-directory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1431 This function returns the directory part of @var{filename} (or |
6555 | 1432 @code{nil} if @var{filename} does not include a directory part). On |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1433 most systems, the function returns a string ending in a slash. On VMS, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1434 it returns a string ending in one of the three characters @samp{:}, |
6555 | 1435 @samp{]}, or @samp{>}. |
1436 | |
1437 @example | |
1438 @group | |
1439 (file-name-directory "lewis/foo") ; @r{Unix example} | |
1440 @result{} "lewis/" | |
1441 @end group | |
1442 @group | |
1443 (file-name-directory "foo") ; @r{Unix example} | |
1444 @result{} nil | |
1445 @end group | |
1446 @group | |
1447 (file-name-directory "[X]FOO.TMP") ; @r{VMS example} | |
1448 @result{} "[X]" | |
1449 @end group | |
1450 @end example | |
1451 @end defun | |
1452 | |
1453 @defun file-name-nondirectory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1454 This function returns the nondirectory part of @var{filename}. |
6555 | 1455 |
1456 @example | |
1457 @group | |
1458 (file-name-nondirectory "lewis/foo") | |
1459 @result{} "foo" | |
1460 @end group | |
1461 @group | |
1462 (file-name-nondirectory "foo") | |
1463 @result{} "foo" | |
1464 @end group | |
1465 @group | |
1466 ;; @r{The following example is accurate only on VMS.} | |
1467 (file-name-nondirectory "[X]FOO.TMP") | |
1468 @result{} "FOO.TMP" | |
1469 @end group | |
1470 @end example | |
1471 @end defun | |
1472 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1473 @defun file-name-sans-versions filename &optional keep-backup-version |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1474 This function returns @var{filename} with any file version numbers, |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1475 backup version numbers, or trailing tildes discarded. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1476 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1477 If @var{keep-backup-version} is non-@code{nil}, then true file version |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1478 numbers understood as such by the file system are discarded from the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1479 return value, but backup version numbers are kept. |
6555 | 1480 |
1481 @example | |
1482 @group | |
1483 (file-name-sans-versions "~rms/foo.~1~") | |
1484 @result{} "~rms/foo" | |
1485 @end group | |
1486 @group | |
1487 (file-name-sans-versions "~rms/foo~") | |
1488 @result{} "~rms/foo" | |
1489 @end group | |
1490 @group | |
1491 (file-name-sans-versions "~rms/foo") | |
1492 @result{} "~rms/foo" | |
1493 @end group | |
1494 @group | |
1495 ;; @r{The following example applies to VMS only.} | |
1496 (file-name-sans-versions "foo;23") | |
1497 @result{} "foo" | |
1498 @end group | |
1499 @end example | |
1500 @end defun | |
1501 | |
12067 | 1502 @defun file-name-sans-extension filename |
12098 | 1503 This function returns @var{filename} minus its ``extension,'' if any. |
1504 The extension, in a file name, is the part that starts with the last | |
1505 @samp{.} in the last name component. For example, | |
1506 | |
1507 @example | |
1508 (file-name-sans-extension "foo.lose.c") | |
1509 @result{} "foo.lose" | |
1510 (file-name-sans-extension "big.hack/foo") | |
1511 @result{} "big.hack/foo" | |
1512 @end example | |
12067 | 1513 @end defun |
1514 | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1515 @ignore |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1516 Andrew Innes says that this |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1517 |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1518 @c @defvar directory-sep-char |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1519 @c @tindex directory-sep-char |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1520 This variable holds the character that Emacs normally uses to separate |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1521 file name components. The default value is @code{?/}, but on MS-Windows |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1522 you can set it to @code{?\\}; then the functions that transform file names |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1523 use backslashes in their output. |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1524 |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1525 File names using backslashes work as input to Lisp primitives even on |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1526 MS-DOS and MS-Windows, even if @code{directory-sep-char} has its default |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1527 value of @code{?/}. |
28608
c46c2efa3731
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28074
diff
changeset
|
1528 @end defvar |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1529 @end ignore |
28608
c46c2efa3731
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28074
diff
changeset
|
1530 |
30501 | 1531 @defun file-name-extension filename &optional period |
1532 This function returns @var{filename}'s final ``extension,'' if any, | |
1533 after applying @code{file-name-sans-versions} to remove any | |
1534 version/backup part. If @var{period} is non-nil, then the returned | |
1535 value includes the period that delimits the extension, and if | |
1536 @var{filename} has no extension, the value is @code{""}. | |
1537 @end defun | |
1538 | |
6555 | 1539 @node Directory Names |
1540 @comment node-name, next, previous, up | |
1541 @subsection Directory Names | |
1542 @cindex directory name | |
1543 @cindex file name of directory | |
1544 | |
1545 A @dfn{directory name} is the name of a directory. A directory is a | |
1546 kind of file, and it has a file name, which is related to the directory | |
1547 name but not identical to it. (This is not quite the same as the usual | |
1548 Unix terminology.) These two different names for the same entity are | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1549 related by a syntactic transformation. On most systems, this is simple: |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1550 a directory name ends in a slash (or backslash), whereas the directory's |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1551 name as a file lacks that slash. On VMS, the relationship is more |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1552 complicated. |
6555 | 1553 |
1554 The difference between a directory name and its name as a file is | |
1555 subtle but crucial. When an Emacs variable or function argument is | |
1556 described as being a directory name, a file name of a directory is not | |
1557 acceptable. | |
1558 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1559 The following two functions convert between directory names and file |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1560 names. They do nothing special with environment variable substitutions |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1561 such as @samp{$HOME}, and the constructs @samp{~}, and @samp{..}. |
6555 | 1562 |
1563 @defun file-name-as-directory filename | |
1564 This function returns a string representing @var{filename} in a form | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1565 that the operating system will interpret as the name of a directory. On |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1566 most systems, this means appending a slash to the string (if it does not |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1567 already end in one). On VMS, the function converts a string of the form |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1568 @file{[X]Y.DIR.1} to the form @file{[X.Y]}. |
6555 | 1569 |
1570 @example | |
1571 @group | |
1572 (file-name-as-directory "~rms/lewis") | |
1573 @result{} "~rms/lewis/" | |
1574 @end group | |
1575 @end example | |
1576 @end defun | |
1577 | |
1578 @defun directory-file-name dirname | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1579 This function returns a string representing @var{dirname} in a form that |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1580 the operating system will interpret as the name of a file. On most |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1581 systems, this means removing the final slash (or backslash) from the |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1582 string. On VMS, the function converts a string of the form @file{[X.Y]} |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1583 to @file{[X]Y.DIR.1}. |
6555 | 1584 |
1585 @example | |
1586 @group | |
1587 (directory-file-name "~lewis/") | |
1588 @result{} "~lewis" | |
1589 @end group | |
1590 @end example | |
1591 @end defun | |
1592 | |
1593 @cindex directory name abbreviation | |
1594 Directory name abbreviations are useful for directories that are | |
1595 normally accessed through symbolic links. Sometimes the users recognize | |
1596 primarily the link's name as ``the name'' of the directory, and find it | |
1597 annoying to see the directory's ``real'' name. If you define the link | |
1598 name as an abbreviation for the ``real'' name, Emacs shows users the | |
1599 abbreviation instead. | |
1600 | |
1601 @defvar directory-abbrev-alist | |
1602 The variable @code{directory-abbrev-alist} contains an alist of | |
1603 abbreviations to use for file directories. Each element has the form | |
1604 @code{(@var{from} . @var{to})}, and says to replace @var{from} with | |
1605 @var{to} when it appears in a directory name. The @var{from} string is | |
1606 actually a regular expression; it should always start with @samp{^}. | |
1607 The function @code{abbreviate-file-name} performs these substitutions. | |
1608 | |
1609 You can set this variable in @file{site-init.el} to describe the | |
1610 abbreviations appropriate for your site. | |
1611 | |
1612 Here's an example, from a system on which file system @file{/home/fsf} | |
1613 and so on are normally accessed through symbolic links named @file{/fsf} | |
1614 and so on. | |
1615 | |
1616 @example | |
1617 (("^/home/fsf" . "/fsf") | |
1618 ("^/home/gp" . "/gp") | |
1619 ("^/home/gd" . "/gd")) | |
1620 @end example | |
1621 @end defvar | |
1622 | |
1623 To convert a directory name to its abbreviation, use this | |
1624 function: | |
1625 | |
1626 @defun abbreviate-file-name dirname | |
1627 This function applies abbreviations from @code{directory-abbrev-alist} | |
1628 to its argument, and substitutes @samp{~} for the user's home | |
1629 directory. | |
1630 @end defun | |
1631 | |
1632 @node Relative File Names | |
1633 @subsection Absolute and Relative File Names | |
1634 @cindex absolute file name | |
1635 @cindex relative file name | |
1636 | |
1637 All the directories in the file system form a tree starting at the | |
1638 root directory. A file name can specify all the directory names | |
1639 starting from the root of the tree; then it is called an @dfn{absolute} | |
1640 file name. Or it can specify the position of the file in the tree | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1641 relative to a default directory; then it is called a @dfn{relative} file |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1642 name. On Unix and GNU/Linux, an absolute file name starts with a slash |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1643 or a tilde (@samp{~}), and a relative one does not. On MS-DOS and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1644 MS-Windows, an absolute file name starts with a slash or a backslash, or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1645 with a drive specification @samp{@var{x}:/}, where @var{x} is the |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1646 @dfn{drive letter}. The rules on VMS are complicated. |
6555 | 1647 |
1648 @defun file-name-absolute-p filename | |
1649 This function returns @code{t} if file @var{filename} is an absolute | |
1650 file name, @code{nil} otherwise. On VMS, this function understands both | |
1651 Unix syntax and VMS syntax. | |
1652 | |
1653 @example | |
1654 @group | |
1655 (file-name-absolute-p "~rms/foo") | |
1656 @result{} t | |
1657 @end group | |
1658 @group | |
1659 (file-name-absolute-p "rms/foo") | |
1660 @result{} nil | |
1661 @end group | |
1662 @group | |
1663 (file-name-absolute-p "/user/rms/foo") | |
1664 @result{} t | |
1665 @end group | |
1666 @end example | |
1667 @end defun | |
1668 | |
1669 @node File Name Expansion | |
1670 @subsection Functions that Expand Filenames | |
1671 @cindex expansion of file names | |
1672 | |
1673 @dfn{Expansion} of a file name means converting a relative file name | |
1674 to an absolute one. Since this is done relative to a default directory, | |
1675 you must specify the default directory name as well as the file name to | |
1676 be expanded. Expansion also simplifies file names by eliminating | |
1677 redundancies such as @file{./} and @file{@var{name}/../}. | |
1678 | |
1679 @defun expand-file-name filename &optional directory | |
1680 This function converts @var{filename} to an absolute file name. If | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1681 @var{directory} is supplied, it is the default directory to start with |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1682 if @var{filename} is relative. (The value of @var{directory} should |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1683 itself be an absolute directory name; it may start with @samp{~}.) |
6555 | 1684 Otherwise, the current buffer's value of @code{default-directory} is |
1685 used. For example: | |
1686 | |
1687 @example | |
1688 @group | |
1689 (expand-file-name "foo") | |
1690 @result{} "/xcssun/users/rms/lewis/foo" | |
1691 @end group | |
1692 @group | |
1693 (expand-file-name "../foo") | |
1694 @result{} "/xcssun/users/rms/foo" | |
1695 @end group | |
1696 @group | |
1697 (expand-file-name "foo" "/usr/spool/") | |
1698 @result{} "/usr/spool/foo" | |
1699 @end group | |
1700 @group | |
1701 (expand-file-name "$HOME/foo") | |
1702 @result{} "/xcssun/users/rms/lewis/$HOME/foo" | |
1703 @end group | |
1704 @end example | |
1705 | |
1706 Filenames containing @samp{.} or @samp{..} are simplified to their | |
1707 canonical form: | |
1708 | |
1709 @example | |
1710 @group | |
1711 (expand-file-name "bar/../foo") | |
1712 @result{} "/xcssun/users/rms/lewis/foo" | |
1713 @end group | |
1714 @end example | |
1715 | |
1716 Note that @code{expand-file-name} does @emph{not} expand environment | |
1717 variables; only @code{substitute-in-file-name} does that. | |
1718 @end defun | |
1719 | |
1720 @c Emacs 19 feature | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1721 @defun file-relative-name filename &optional directory |
6555 | 1722 This function does the inverse of expansion---it tries to return a |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
1723 relative name that is equivalent to @var{filename} when interpreted |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1724 relative to @var{directory}. If @var{directory} is omitted or |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
1725 @code{nil}, it defaults to the current buffer's default directory. |
17398
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1726 |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1727 On some operating systems, an absolute file name begins with a device |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1728 name. On such systems, @var{filename} has no relative equivalent based |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1729 on @var{directory} if they start with two different device names. In |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1730 this case, @code{file-relative-name} returns @var{filename} in absolute |
a5d9cbc4e2c5
(file-relative-name): Say correctly when the value is absolute.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1731 form. |
6555 | 1732 |
1733 @example | |
1734 (file-relative-name "/foo/bar" "/foo/") | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1735 @result{} "bar" |
6555 | 1736 (file-relative-name "/foo/bar" "/hack/") |
28681
bf112ad58dc7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28635
diff
changeset
|
1737 @result{} "../foo/bar" |
6555 | 1738 @end example |
1739 @end defun | |
1740 | |
1741 @defvar default-directory | |
1742 The value of this buffer-local variable is the default directory for the | |
1743 current buffer. It should be an absolute directory name; it may start | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1744 with @samp{~}. This variable is buffer-local in every buffer. |
6555 | 1745 |
1746 @code{expand-file-name} uses the default directory when its second | |
1747 argument is @code{nil}. | |
1748 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1749 Aside from VMS, the value is always a string ending with a slash. |
6555 | 1750 |
1751 @example | |
1752 @group | |
1753 default-directory | |
1754 @result{} "/user/lewis/manual/" | |
1755 @end group | |
1756 @end example | |
1757 @end defvar | |
1758 | |
1759 @defun substitute-in-file-name filename | |
1760 This function replaces environment variables references in | |
1761 @var{filename} with the environment variable values. Following standard | |
1762 Unix shell syntax, @samp{$} is the prefix to substitute an environment | |
1763 variable value. | |
1764 | |
1765 The environment variable name is the series of alphanumeric characters | |
1766 (including underscores) that follow the @samp{$}. If the character following | |
1767 the @samp{$} is a @samp{@{}, then the variable name is everything up to the | |
1768 matching @samp{@}}. | |
1769 | |
1770 @c Wordy to avoid overfull hbox. --rjc 15mar92 | |
1771 Here we assume that the environment variable @code{HOME}, which holds | |
1772 the user's home directory name, has value @samp{/xcssun/users/rms}. | |
1773 | |
1774 @example | |
1775 @group | |
1776 (substitute-in-file-name "$HOME/foo") | |
1777 @result{} "/xcssun/users/rms/foo" | |
1778 @end group | |
1779 @end example | |
1780 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1781 After substitution, if a @samp{~} or a @samp{/} appears following a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1782 @samp{/}, everything before the following @samp{/} is discarded: |
6555 | 1783 |
1784 @example | |
1785 @group | |
1786 (substitute-in-file-name "bar/~/foo") | |
1787 @result{} "~/foo" | |
1788 @end group | |
1789 @group | |
1790 (substitute-in-file-name "/usr/local/$HOME/foo") | |
1791 @result{} "/xcssun/users/rms/foo" | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1792 ;; @r{@file{/usr/local/} has been discarded.} |
6555 | 1793 @end group |
1794 @end example | |
1795 | |
1796 On VMS, @samp{$} substitution is not done, so this function does nothing | |
1797 on VMS except discard superfluous initial components as shown above. | |
1798 @end defun | |
1799 | |
1800 @node Unique File Names | |
1801 @subsection Generating Unique File Names | |
1802 | |
1803 Some programs need to write temporary files. Here is the usual way to | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1804 construct a name for such a file, starting in Emacs 21: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1805 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1806 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1807 (make-temp-file @var{name-of-application}) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1808 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1809 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1810 @noindent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1811 The job of @code{make-temp-file} is to prevent two different users or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1812 two different jobs from trying to use the exact same file name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1813 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1814 @defun make-temp-file prefix &optional dir-flag |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1815 @tindex make-temp-file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1816 This function creates a temporary file and returns its name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1817 The name starts with @var{prefix}; it also contains a number that is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1818 different in each Emacs job. If @var{prefix} is a relative file name, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1819 it is expanded against @code{temporary-file-directory}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1820 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1821 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1822 @group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1823 (make-temp-file "foo") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1824 @result{} "/tmp/foo232J6v" |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1825 @end group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1826 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1827 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1828 When @code{make-temp-file} returns, the file has been created and is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1829 empty. At that point, you should write the intended contents into the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1830 file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1831 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1832 If @var{dir-flag} is non-@code{nil}, @code{make-temp-file} creates |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1833 an empty directory instead of an empty file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1834 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1835 To prevent conflicts among different libraries running in the same |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1836 Emacs, each Lisp program that uses @code{make-temp-file} should have its |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1837 own @var{prefix}. The number added to the end of @var{prefix} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1838 distinguishes between the same application running in different Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1839 jobs. Additional added characters permit a large number of distinct |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1840 names even in one Emacs job. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1841 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1842 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1843 The default directory for temporary files is controlled by the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1844 variable @code{temporary-file-directory}. This variable gives the user |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1845 a uniform way to specify the directory for all temporary files. Some |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1846 programs use @code{small-temporary-file-directory} instead, if that is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1847 non-@code{nil}. To use it, you should expand the prefix against |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1848 the proper directory before calling @code{make-temp-file}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1849 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1850 In older Emacs versions where @code{make-temp-file} does not exist, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1851 you should use @code{make-temp-name} instead: |
6555 | 1852 |
1853 @example | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1854 (make-temp-name |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
1855 (expand-file-name @var{name-of-application} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1856 temporary-file-directory)) |
6555 | 1857 @end example |
1858 | |
1859 @defun make-temp-name string | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1860 This function generates a string that can be used as a unique file name. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1861 The name starts with @var{string}, and contains a number that is |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1862 different in each Emacs job. It is like @code{make-temp-file} except |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1863 that it just constructs a name, and does not create a file. On MS-DOS, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1864 the @var{string} prefix can be truncated to fit into the 8+3 file-name |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1865 limits. |
6555 | 1866 @end defun |
1867 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1868 @defvar temporary-file-directory |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1869 @cindex @code{TMPDIR} environment variable |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1870 @cindex @code{TMP} environment variable |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1871 @cindex @code{TEMP} environment variable |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1872 This variable specifies the directory name for creating temporary files. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1873 Its value should be a directory name (@pxref{Directory Names}), but it |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1874 is good for Lisp programs to cope if the value is a directory's file |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1875 name instead. Using the value as the second argument to |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1876 @code{expand-file-name} is a good way to achieve that. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1877 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1878 The default value is determined in a reasonable way for your operating |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1879 system; it is based on the @code{TMPDIR}, @code{TMP} and @code{TEMP} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1880 environment variables, with a fall-back to a system-dependent name if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1881 none of these variables is defined. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1882 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1883 Even if you do not use @code{make-temp-name} to choose the temporary |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1884 file's name, you should still use this variable to decide which |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1885 directory to put the file in. However, if you expect the file to be |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1886 small, you should use @code{small-temporary-file-directory} first if |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1887 that is non-@code{nil}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1888 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1889 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1890 @tindex small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1891 @defvar small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1892 This variable (new in Emacs 21) specifies the directory name for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1893 creating certain temporary files, which are likely to be small. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1894 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1895 If you want to write a temporary file which is likely to be small, you |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1896 should compute the directory like this: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1897 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1898 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1899 (make-temp-file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1900 (expand-file-name @var{prefix} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1901 (or small-temporary-file-directory |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1902 temporary-file-directory))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
1903 @end example |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1904 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1905 |
6555 | 1906 @node File Name Completion |
1907 @subsection File Name Completion | |
1908 @cindex file name completion subroutines | |
1909 @cindex completion, file name | |
1910 | |
1911 This section describes low-level subroutines for completing a file | |
1912 name. For other completion functions, see @ref{Completion}. | |
1913 | |
1914 @defun file-name-all-completions partial-filename directory | |
1915 This function returns a list of all possible completions for a file | |
1916 whose name starts with @var{partial-filename} in directory | |
1917 @var{directory}. The order of the completions is the order of the files | |
1918 in the directory, which is unpredictable and conveys no useful | |
1919 information. | |
1920 | |
1921 The argument @var{partial-filename} must be a file name containing no | |
28635
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1922 directory part and no slash (or backslash on some systems). The current |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1923 buffer's default directory is prepended to @var{directory}, if |
cda2b6ed6aec
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28608
diff
changeset
|
1924 @var{directory} is not absolute. |
6555 | 1925 |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1926 In the following example, suppose that @file{~rms/lewis} is the current |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
1927 default directory, and has five files whose names begin with @samp{f}: |
6555 | 1928 @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and |
1929 @file{file.c.~2~}.@refill | |
1930 | |
1931 @example | |
1932 @group | |
1933 (file-name-all-completions "f" "") | |
1934 @result{} ("foo" "file~" "file.c.~2~" | |
1935 "file.c.~1~" "file.c") | |
1936 @end group | |
1937 | |
1938 @group | |
1939 (file-name-all-completions "fo" "") | |
1940 @result{} ("foo") | |
1941 @end group | |
1942 @end example | |
1943 @end defun | |
1944 | |
1945 @defun file-name-completion filename directory | |
1946 This function completes the file name @var{filename} in directory | |
1947 @var{directory}. It returns the longest prefix common to all file names | |
1948 in directory @var{directory} that start with @var{filename}. | |
1949 | |
1950 If only one match exists and @var{filename} matches it exactly, the | |
1951 function returns @code{t}. The function returns @code{nil} if directory | |
1952 @var{directory} contains no name starting with @var{filename}. | |
1953 | |
1954 In the following example, suppose that the current default directory | |
1955 has five files whose names begin with @samp{f}: @file{foo}, | |
1956 @file{file~}, @file{file.c}, @file{file.c.~1~}, and | |
1957 @file{file.c.~2~}.@refill | |
1958 | |
1959 @example | |
1960 @group | |
1961 (file-name-completion "fi" "") | |
1962 @result{} "file" | |
1963 @end group | |
1964 | |
1965 @group | |
1966 (file-name-completion "file.c.~1" "") | |
1967 @result{} "file.c.~1~" | |
1968 @end group | |
1969 | |
1970 @group | |
1971 (file-name-completion "file.c.~1~" "") | |
1972 @result{} t | |
1973 @end group | |
1974 | |
1975 @group | |
1976 (file-name-completion "file.c.~3" "") | |
1977 @result{} nil | |
1978 @end group | |
1979 @end example | |
1980 @end defun | |
1981 | |
1982 @defopt completion-ignored-extensions | |
1983 @code{file-name-completion} usually ignores file names that end in any | |
1984 string in this list. It does not ignore them when all the possible | |
1985 completions end in one of these suffixes or when a buffer showing all | |
1986 possible completions is displayed.@refill | |
1987 | |
1988 A typical value might look like this: | |
1989 | |
1990 @example | |
1991 @group | |
1992 completion-ignored-extensions | |
1993 @result{} (".o" ".elc" "~" ".dvi") | |
1994 @end group | |
1995 @end example | |
1996 @end defopt | |
1997 | |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1998 @node Standard File Names |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
1999 @subsection Standard File Names |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2000 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2001 Most of the file names used in Lisp programs are entered by the user. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2002 But occasionally a Lisp program needs to specify a standard file name |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2003 for a particular use---typically, to hold customization information |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2004 about each user. For example, abbrev definitions are stored (by |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2005 default) in the file @file{~/.abbrev_defs}; the @code{completion} |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2006 package stores completions in the file @file{~/.completions}. These are |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2007 two of the many standard file names used by parts of Emacs for certain |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2008 purposes. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2009 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2010 Various operating systems have their own conventions for valid file |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2011 names and for which file names to use for user profile data. A Lisp |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2012 program which reads a file using a standard file name ought to use, on |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2013 each type of system, a file name suitable for that system. The function |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2014 @code{convert-standard-filename} makes this easy to do. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2015 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2016 @defun convert-standard-filename filename |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2017 This function alters the file name @var{filename} to fit the conventions |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2018 of the operating system in use, and returns the result as a new string. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2019 @end defun |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2020 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2021 The recommended way to specify a standard file name in a Lisp program |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2022 is to choose a name which fits the conventions of GNU and Unix systems, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2023 usually with a nondirectory part that starts with a period, and pass it |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2024 to @code{convert-standard-filename} instead of using it directly. Here |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2025 is an example from the @code{completion} package: |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2026 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2027 @example |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2028 (defvar save-completions-file-name |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2029 (convert-standard-filename "~/.completions") |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2030 "*The file name to save completions to.") |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2031 @end example |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2032 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2033 On GNU and Unix systems, and on some other systems as well, |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2034 @code{convert-standard-filename} returns its argument unchanged. On |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2035 some other systems, it alters the name to fit the system's conventions. |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2036 |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2037 For example, on MS-DOS the alterations made by this function include |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2038 converting a leading @samp{.} to @samp{_}, converting a @samp{_} in the |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2039 middle of the name to @samp{.} if there is no other @samp{.}, inserting |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2040 a @samp{.} after eight characters if there is none, and truncating to |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2041 three characters after the @samp{.}. (It makes other changes as well.) |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2042 Thus, @file{.abbrev_defs} becomes @file{_abbrev.def}, and |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2043 @file{.completions} becomes @file{_complet.ion}. |
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2044 |
6555 | 2045 @node Contents of Directories |
2046 @section Contents of Directories | |
2047 @cindex directory-oriented functions | |
2048 @cindex file names in directory | |
2049 | |
2050 A directory is a kind of file that contains other files entered under | |
2051 various names. Directories are a feature of the file system. | |
2052 | |
2053 Emacs can list the names of the files in a directory as a Lisp list, | |
2054 or display the names in a buffer using the @code{ls} shell command. In | |
2055 the latter case, it can optionally display information about each file, | |
2056 depending on the options passed to the @code{ls} command. | |
2057 | |
2058 @defun directory-files directory &optional full-name match-regexp nosort | |
2059 This function returns a list of the names of the files in the directory | |
2060 @var{directory}. By default, the list is in alphabetical order. | |
2061 | |
2062 If @var{full-name} is non-@code{nil}, the function returns the files' | |
2063 absolute file names. Otherwise, it returns the names relative to | |
2064 the specified directory. | |
2065 | |
2066 If @var{match-regexp} is non-@code{nil}, this function returns only | |
2067 those file names that contain a match for that regular expression---the | |
2068 other file names are excluded from the list. | |
2069 | |
2070 @c Emacs 19 feature | |
2071 If @var{nosort} is non-@code{nil}, @code{directory-files} does not sort | |
2072 the list, so you get the file names in no particular order. Use this if | |
2073 you want the utmost possible speed and don't care what order the files | |
2074 are processed in. If the order of processing is visible to the user, | |
2075 then the user will probably be happier if you do sort the names. | |
2076 | |
2077 @example | |
2078 @group | |
2079 (directory-files "~lewis") | |
2080 @result{} ("#foo#" "#foo.el#" "." ".." | |
2081 "dired-mods.el" "files.texi" | |
2082 "files.texi.~1~") | |
2083 @end group | |
2084 @end example | |
2085 | |
2086 An error is signaled if @var{directory} is not the name of a directory | |
2087 that can be read. | |
2088 @end defun | |
2089 | |
2090 @defun file-name-all-versions file dirname | |
2091 This function returns a list of all versions of the file named | |
2092 @var{file} in directory @var{dirname}. | |
2093 @end defun | |
2094 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2095 @tindex file-expand-wildcards |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2096 @defun file-expand-wildcards pattern &optional full |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2097 This function expands the wildcard pattern @var{pattern}, returning |
24952 | 2098 a list of file names that match it. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2099 |
24952 | 2100 If @var{pattern} is written as an absolute file name, |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2101 the values are absolute also. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2102 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2103 If @var{pattern} is written as a relative file name, it is interpreted |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2104 relative to the current default directory. The file names returned are |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2105 normally also relative to the current default directory. However, if |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2106 @var{full} is non-@code{nil}, they are absolute. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2107 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
2108 |
6555 | 2109 @defun insert-directory file switches &optional wildcard full-directory-p |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2110 This function inserts (in the current buffer) a directory listing for |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2111 directory @var{file}, formatted with @code{ls} according to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2112 @var{switches}. It leaves point after the inserted text. |
6555 | 2113 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2114 The argument @var{file} may be either a directory name or a file |
6555 | 2115 specification including wildcard characters. If @var{wildcard} is |
2116 non-@code{nil}, that means treat @var{file} as a file specification with | |
2117 wildcards. | |
2118 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2119 If @var{full-directory-p} is non-@code{nil}, that means the directory |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2120 listing is expected to show the full contents of a directory. You |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2121 should specify @code{t} when @var{file} is a directory and switches do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2122 not contain @samp{-d}. (The @samp{-d} option to @code{ls} says to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2123 describe a directory itself as a file, rather than showing its |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2124 contents.) |
6555 | 2125 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2126 On most systems, this function works by running a directory listing |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2127 program whose name is in the variable @code{insert-directory-program}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2128 If @var{wildcard} is non-@code{nil}, it also runs the shell specified by |
6555 | 2129 @code{shell-file-name}, to expand the wildcards. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2130 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2131 MS-DOS and MS-Windows systems usually lack the standard Unix program |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2132 @code{ls}, so this function emulates the standard Unix program @code{ls} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2133 with Lisp code. |
6555 | 2134 @end defun |
2135 | |
2136 @defvar insert-directory-program | |
2137 This variable's value is the program to run to generate a directory listing | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2138 for the function @code{insert-directory}. It is ignored on systems |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2139 which generate the listing with Lisp code. |
6555 | 2140 @end defvar |
2141 | |
2142 @node Create/Delete Dirs | |
2143 @section Creating and Deleting Directories | |
2144 @c Emacs 19 features | |
2145 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2146 Most Emacs Lisp file-manipulation functions get errors when used on |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2147 files that are directories. For example, you cannot delete a directory |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2148 with @code{delete-file}. These special functions exist to create and |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2149 delete directories. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2150 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2151 @defun make-directory dirname &optional parents |
6555 | 2152 This function creates a directory named @var{dirname}. |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2153 If @var{parents} is non-@code{nil}, that means to create |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
25751
diff
changeset
|
2154 the parent directories first, if they don't already exist. |
6555 | 2155 @end defun |
2156 | |
2157 @defun delete-directory dirname | |
2158 This function deletes the directory named @var{dirname}. The function | |
2159 @code{delete-file} does not work for files that are directories; you | |
12098 | 2160 must use @code{delete-directory} for them. If the directory contains |
2161 any files, @code{delete-directory} signals an error. | |
6555 | 2162 @end defun |
2163 | |
2164 @node Magic File Names | |
2165 @section Making Certain File Names ``Magic'' | |
2166 @cindex magic file names | |
2167 | |
2168 @c Emacs 19 feature | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2169 You can implement special handling for certain file names. This is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2170 called making those names @dfn{magic}. The principal use for this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2171 feature is in implementing remote file names (@pxref{Remote Files,, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2172 Remote Files, emacs, The GNU Emacs Manual}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2173 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2174 To define a kind of magic file name, you must supply a regular |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2175 expression to define the class of names (all those that match the |
6555 | 2176 regular expression), plus a handler that implements all the primitive |
2177 Emacs file operations for file names that do match. | |
2178 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2179 The variable @code{file-name-handler-alist} holds a list of handlers, |
6555 | 2180 together with regular expressions that determine when to apply each |
2181 handler. Each element has this form: | |
2182 | |
2183 @example | |
2184 (@var{regexp} . @var{handler}) | |
2185 @end example | |
2186 | |
2187 @noindent | |
2188 All the Emacs primitives for file access and file name transformation | |
2189 check the given file name against @code{file-name-handler-alist}. If | |
2190 the file name matches @var{regexp}, the primitives handle that file by | |
2191 calling @var{handler}. | |
2192 | |
2193 The first argument given to @var{handler} is the name of the primitive; | |
2194 the remaining arguments are the arguments that were passed to that | |
2195 operation. (The first of these arguments is typically the file name | |
2196 itself.) For example, if you do this: | |
2197 | |
2198 @example | |
2199 (file-exists-p @var{filename}) | |
2200 @end example | |
2201 | |
2202 @noindent | |
2203 and @var{filename} has handler @var{handler}, then @var{handler} is | |
2204 called like this: | |
2205 | |
2206 @example | |
2207 (funcall @var{handler} 'file-exists-p @var{filename}) | |
2208 @end example | |
2209 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2210 Here are the operations that a magic file name handler gets to handle: |
6555 | 2211 |
27193 | 2212 @ifnottex |
6555 | 2213 @noindent |
2214 @code{add-name-to-file}, @code{copy-file}, @code{delete-directory}, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2215 @code{delete-file}, |
12226 | 2216 @code{diff-latest-backup-file}, |
6555 | 2217 @code{directory-file-name}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2218 @code{directory-files}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2219 @code{dired-call-process}, |
6555 | 2220 @code{dired-compress-file}, @code{dired-uncache}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2221 @code{expand-file-name}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2222 @code{file-accessible-directory-p},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2223 @code{file-attributes}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2224 @code{file-directory-p}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2225 @code{file-executable-p}, @code{file-exists-p},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2226 @code{file-local-copy}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2227 @code{file-modes}, @code{file-name-all-completions},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2228 @code{file-name-as-directory}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2229 @code{file-name-completion}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2230 @code{file-name-directory}, |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2231 @code{file-name-nondirectory}, |
6555 | 2232 @code{file-name-sans-versions}, @code{file-newer-than-file-p}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2233 @code{file-ownership-preserved-p}, |
11626
0b86aef0c387
Mention file-regular-p operation.
Richard M. Stallman <rms@gnu.org>
parents:
8364
diff
changeset
|
2234 @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, |
12226 | 2235 @code{file-truename}, @code{file-writable-p}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2236 @code{find-backup-file-name}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2237 @code{get-file-buffer},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2238 @code{insert-directory}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2239 @code{insert-file-contents}, |
15765
8cc15b664c4c
New node Standard File Names.
Richard M. Stallman <rms@gnu.org>
parents:
14152
diff
changeset
|
2240 @code{load}, @code{make-directory}, |
6555 | 2241 @code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes}, |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2242 @code{set-visited-file-modtime}, @code{shell-command},@* |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2243 @code{unhandled-file-name-directory}, |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15913
diff
changeset
|
2244 @code{vc-registered}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2245 @code{verify-visited-file-modtime},@* |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2246 @code{write-region}. |
27193 | 2247 @end ifnottex |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2248 @iftex |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2249 @noindent |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2250 @flushleft |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2251 @code{add-name-to-file}, @code{copy-file}, @code{delete-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2252 @code{delete-file}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2253 @code{diff-latest-backup-file}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2254 @code{directory-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2255 @code{directory-files}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2256 @code{dired-call-process}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2257 @code{dired-compress-file}, @code{dired-uncache}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2258 @code{expand-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2259 @code{file-accessible-direc@discretionary{}{}{}tory-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2260 @code{file-attributes}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2261 @code{file-direct@discretionary{}{}{}ory-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2262 @code{file-executable-p}, @code{file-exists-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2263 @code{file-local-copy}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2264 @code{file-modes}, @code{file-name-all-completions}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2265 @code{file-name-as-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2266 @code{file-name-completion}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2267 @code{file-name-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2268 @code{file-name-nondirec@discretionary{}{}{}tory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2269 @code{file-name-sans-versions}, @code{file-newer-than-file-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2270 @code{file-ownership-pre@discretionary{}{}{}served-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2271 @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2272 @code{file-truename}, @code{file-writable-p}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2273 @code{find-backup-file-name}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2274 @code{get-file-buffer}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2275 @code{insert-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2276 @code{insert-file-contents}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2277 @code{load}, @code{make-direc@discretionary{}{}{}tory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2278 @code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2279 @code{set-visited-file-modtime}, @code{shell-command}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2280 @code{unhandled-file-name-directory}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2281 @code{vc-regis@discretionary{}{}{}tered}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2282 @code{verify-visited-file-modtime}, |
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2283 @code{write-region}. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24952
diff
changeset
|
2284 @end flushleft |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2285 @end iftex |
6555 | 2286 |
8118
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2287 Handlers for @code{insert-file-contents} typically need to clear the |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2288 buffer's modified flag, with @code{(set-buffer-modified-p nil)}, if the |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2289 @var{visit} argument is non-@code{nil}. This also has the effect of |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2290 unlocking the buffer if it is locked. |
56b5ed321f8d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2291 |
6555 | 2292 The handler function must handle all of the above operations, and |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2293 possibly others to be added in the future. It need not implement all |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2294 these operations itself---when it has nothing special to do for a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2295 certain operation, it can reinvoke the primitive, to handle the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2296 operation ``in the usual way''. It should always reinvoke the primitive |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2297 for an operation it does not recognize. Here's one way to do this: |
6555 | 2298 |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2299 @smallexample |
6555 | 2300 (defun my-file-handler (operation &rest args) |
2301 ;; @r{First check for the specific operations} | |
2302 ;; @r{that we have special handling for.} | |
2303 (cond ((eq operation 'insert-file-contents) @dots{}) | |
2304 ((eq operation 'write-region) @dots{}) | |
2305 @dots{} | |
2306 ;; @r{Handle any operation we don't know about.} | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2307 (t (let ((inhibit-file-name-handlers |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2308 (cons 'my-file-handler |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2309 (and (eq inhibit-file-name-operation operation) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2310 inhibit-file-name-handlers))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2311 (inhibit-file-name-operation operation)) |
6555 | 2312 (apply operation args))))) |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2313 @end smallexample |
6555 | 2314 |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2315 When a handler function decides to call the ordinary Emacs primitive for |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2316 the operation at hand, it needs to prevent the primitive from calling |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2317 the same handler once again, thus leading to an infinite recursion. The |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2318 example above shows how to do this, with the variables |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2319 @code{inhibit-file-name-handlers} and |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2320 @code{inhibit-file-name-operation}. Be careful to use them exactly as |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2321 shown above; the details are crucial for proper behavior in the case of |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2322 multiple handlers, and for operations that have two file names that may |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2323 each have handlers. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2324 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2325 @defvar inhibit-file-name-handlers |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2326 This variable holds a list of handlers whose use is presently inhibited |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2327 for a certain operation. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2328 @end defvar |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2329 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2330 @defvar inhibit-file-name-operation |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2331 The operation for which certain handlers are presently inhibited. |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2332 @end defvar |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2333 |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2334 @defun find-file-name-handler file operation |
6555 | 2335 This function returns the handler function for file name @var{file}, or |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2336 @code{nil} if there is none. The argument @var{operation} should be the |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2337 operation to be performed on the file---the value you will pass to the |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2338 handler as its first argument when you call it. The operation is needed |
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2339 for comparison with @code{inhibit-file-name-operation}. |
6555 | 2340 @end defun |
2341 | |
2342 @defun file-local-copy filename | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2343 This function copies file @var{filename} to an ordinary non-magic file, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2344 if it isn't one already. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2345 |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2346 If @var{filename} specifies a magic file name, which programs |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2347 outside Emacs cannot directly read or write, this copies the contents to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7088
diff
changeset
|
2348 an ordinary file and returns that file's name. |
6555 | 2349 |
2350 If @var{filename} is an ordinary file name, not magic, then this function | |
2351 does nothing and returns @code{nil}. | |
2352 @end defun | |
2353 | |
2354 @defun unhandled-file-name-directory filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2355 This function returns the name of a directory that is not magic. It |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2356 uses the directory part of @var{filename} if that is not magic. For a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2357 magic file name, it invokes the file name handler, which therefore |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2358 decides what value to return. |
6555 | 2359 |
2360 This is useful for running a subprocess; every subprocess must have a | |
2361 non-magic directory to serve as its current directory, and this function | |
2362 is a good way to come up with one. | |
2363 @end defun | |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2364 |
12067 | 2365 @node Format Conversion |
2366 @section File Format Conversion | |
2367 | |
2368 @cindex file format conversion | |
2369 @cindex encoding file formats | |
2370 @cindex decoding file formats | |
2371 The variable @code{format-alist} defines a list of @dfn{file formats}, | |
12098 | 2372 which describe textual representations used in files for the data (text, |
12067 | 2373 text-properties, and possibly other information) in an Emacs buffer. |
12098 | 2374 Emacs performs format conversion if appropriate when reading and writing |
2375 files. | |
12067 | 2376 |
2377 @defvar format-alist | |
2378 This list contains one format definition for each defined file format. | |
2379 @end defvar | |
2380 | |
2381 @cindex format definition | |
2382 Each format definition is a list of this form: | |
2383 | |
2384 @example | |
2385 (@var{name} @var{doc-string} @var{regexp} @var{from-fn} @var{to-fn} @var{modify} @var{mode-fn}) | |
2386 @end example | |
2387 | |
2388 Here is what the elements in a format definition mean: | |
2389 | |
2390 @table @var | |
2391 @item name | |
2392 The name of this format. | |
2393 | |
2394 @item doc-string | |
2395 A documentation string for the format. | |
2396 | |
2397 @item regexp | |
2398 A regular expression which is used to recognize files represented in | |
2399 this format. | |
2400 | |
2401 @item from-fn | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2402 A shell command or function to decode data in this format (to convert |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2403 file data into the usual Emacs data representation). |
12067 | 2404 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2405 A shell command is represented as a string; Emacs runs the command as a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2406 filter to perform the conversion. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2407 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2408 If @var{from-fn} is a function, it is called with two arguments, @var{begin} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2409 and @var{end}, which specify the part of the buffer it should convert. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2410 It should convert the text by editing it in place. Since this can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2411 change the length of the text, @var{from-fn} should return the modified |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2412 end position. |
12067 | 2413 |
12098 | 2414 One responsibility of @var{from-fn} is to make sure that the beginning |
12067 | 2415 of the file no longer matches @var{regexp}. Otherwise it is likely to |
2416 get called again. | |
2417 | |
2418 @item to-fn | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2419 A shell command or function to encode data in this format---that is, to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2420 convert the usual Emacs data representation into this format. |
12067 | 2421 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2422 If @var{to-fn} is a string, it is a shell command; Emacs runs the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2423 command as a filter to perform the conversion. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2424 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2425 If @var{to-fn} is a function, it is called with two arguments, @var{begin} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2426 and @var{end}, which specify the part of the buffer it should convert. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2427 There are two ways it can do the conversion: |
12067 | 2428 |
2429 @itemize @bullet | |
2430 @item | |
2431 By editing the buffer in place. In this case, @var{to-fn} should | |
2432 return the end-position of the range of text, as modified. | |
2433 | |
2434 @item | |
2435 By returning a list of annotations. This is a list of elements of the | |
2436 form @code{(@var{position} . @var{string})}, where @var{position} is an | |
2437 integer specifying the relative position in the text to be written, and | |
2438 @var{string} is the annotation to add there. The list must be sorted in | |
2439 order of position when @var{to-fn} returns it. | |
2440 | |
2441 When @code{write-region} actually writes the text from the buffer to the | |
2442 file, it intermixes the specified annotations at the corresponding | |
2443 positions. All this takes place without modifying the buffer. | |
2444 @end itemize | |
2445 | |
2446 @item modify | |
2447 A flag, @code{t} if the encoding function modifies the buffer, and | |
2448 @code{nil} if it works by returning a list of annotations. | |
2449 | |
27259
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2450 @item mode-fn |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2451 A minor-mode function to call after visiting a file converted from this |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2452 format. The function is called with one argument, the integer 1; |
c41efa6c4be1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2453 that tells a minor-mode function to enable the mode. |
12067 | 2454 @end table |
2455 | |
2456 The function @code{insert-file-contents} automatically recognizes file | |
2457 formats when it reads the specified file. It checks the text of the | |
2458 beginning of the file against the regular expressions of the format | |
2459 definitions, and if it finds a match, it calls the decoding function for | |
2460 that format. Then it checks all the known formats over again. | |
2461 It keeps checking them until none of them is applicable. | |
2462 | |
2463 Visiting a file, with @code{find-file-noselect} or the commands that use | |
2464 it, performs conversion likewise (because it calls | |
12098 | 2465 @code{insert-file-contents}); it also calls the mode function for each |
2466 format that it decodes. It stores a list of the format names in the | |
2467 buffer-local variable @code{buffer-file-format}. | |
12067 | 2468 |
2469 @defvar buffer-file-format | |
12098 | 2470 This variable states the format of the visited file. More precisely, |
2471 this is a list of the file format names that were decoded in the course | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2472 of visiting the current buffer's file. It is always buffer-local in all |
12067 | 2473 buffers. |
2474 @end defvar | |
2475 | |
2476 When @code{write-region} writes data into a file, it first calls the | |
12098 | 2477 encoding functions for the formats listed in @code{buffer-file-format}, |
2478 in the order of appearance in the list. | |
12067 | 2479 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2480 @deffn Command format-write-file file format |
12067 | 2481 This command writes the current buffer contents into the file @var{file} |
2482 in format @var{format}, and makes that format the default for future | |
12098 | 2483 saves of the buffer. The argument @var{format} is a list of format |
2484 names. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2485 @end deffn |
12067 | 2486 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2487 @deffn Command format-find-file file format |
12226 | 2488 This command finds the file @var{file}, converting it according to |
2489 format @var{format}. It also makes @var{format} the default if the | |
2490 buffer is saved later. | |
2491 | |
2492 The argument @var{format} is a list of format names. If @var{format} is | |
2493 @code{nil}, no conversion takes place. Interactively, typing just | |
2494 @key{RET} for @var{format} specifies @code{nil}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2495 @end deffn |
12226 | 2496 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2497 @deffn Command format-insert-file file format &optional beg end |
12226 | 2498 This command inserts the contents of file @var{file}, converting it |
2499 according to format @var{format}. If @var{beg} and @var{end} are | |
2500 non-@code{nil}, they specify which part of the file to read, as in | |
2501 @code{insert-file-contents} (@pxref{Reading from Files}). | |
2502 | |
2503 The return value is like what @code{insert-file-contents} returns: a | |
2504 list of the absolute file name and the length of the data inserted | |
2505 (after conversion). | |
2506 | |
2507 The argument @var{format} is a list of format names. If @var{format} is | |
2508 @code{nil}, no conversion takes place. Interactively, typing just | |
2509 @key{RET} for @var{format} specifies @code{nil}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17919
diff
changeset
|
2510 @end deffn |
12226 | 2511 |
12067 | 2512 @defvar auto-save-file-format |
2513 This variable specifies the format to use for auto-saving. Its value is | |
2514 a list of format names, just like the value of | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2515 @code{buffer-file-format}; however, it is used instead of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2516 @code{buffer-file-format} for writing auto-save files. This variable is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2517 always buffer-local in all buffers. |
7088
5a93e6fb43a4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6555
diff
changeset
|
2518 @end defvar |