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