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