@c -*-texinfo-*-@c This is part of the GNU Emacs Lisp Reference Manual.@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999@c Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions.@setfilename ../info/files@node Files, Backups and Auto-Saving, Documentation, Top@comment node-name, next, previous, up@chapter Files In Emacs, you can find, create, view, save, and otherwise work withfiles and file directories. This chapter describes most of thefile-related functions of Emacs Lisp, but a few others are described in@ref{Buffers}, and those related to backups and auto-saving aredescribed in @ref{Backups and Auto-Saving}. Many of the file functions take one or more arguments that are filenames. A file name is actually a string. Most of these functionsexpand file name arguments by calling @code{expand-file-name}, so that@file{~} is handled correctly, as are relative file names (including@samp{../}). These functions don't recognize environment variablesubstitutions such as @samp{$HOME}. @xref{File Name Expansion}. When file I/O functions signal Lisp errors, they usually use thecondition @code{file-error} (@pxref{Handling Errors}). The errormessage is in most cases obtained from the operating system, accordingto locale @code{system-message-locale}, and decoded using coding system@code{locale-coding-system} (@pxref{Locales}).@menu* Visiting Files:: Reading files into Emacs buffers for editing.* Saving Buffers:: Writing changed buffers back into files.* Reading from Files:: Reading files into buffers without visiting.* Writing to Files:: Writing new files from parts of buffers.* File Locks:: Locking and unlocking files, to prevent simultaneous editing by two people.* Information about Files:: Testing existence, accessibility, size of files.* Changing Files:: Renaming files, changing protection, etc.* File Names:: Decomposing and expanding file names.* Contents of Directories:: Getting a list of the files in a directory.* Create/Delete Dirs:: Creating and Deleting Directories.* Magic File Names:: Defining "magic" special handling for certain file names.* Format Conversion:: Conversion to and from various file formats.@end menu@node Visiting Files@section Visiting Files@cindex finding files@cindex visiting files Visiting a file means reading a file into a buffer. Once this isdone, we say that the buffer is @dfn{visiting} that file, and call thefile ``the visited file'' of the buffer. A file and a buffer are two different things. A file is informationrecorded permanently in the computer (unless you delete it). A buffer,on the other hand, is information inside of Emacs that will vanish atthe end of the editing session (or when you kill the buffer). Usually,a buffer contains information that you have copied from a file; then wesay the buffer is visiting that file. The copy in the buffer is whatyou modify with editing commands. Such changes to the buffer do notchange the file; therefore, to make the changes permanent, you must@dfn{save} the buffer, which means copying the altered buffer contentsback into the file. In spite of the distinction between files and buffers, people oftenrefer to a file when they mean a buffer and vice-versa. Indeed, we say,``I am editing a file,'' rather than, ``I am editing a buffer that Iwill soon save as a file of the same name.'' Humans do not usually needto make the distinction explicit. When dealing with a computer program,however, it is good to keep the distinction in mind.@menu* Visiting Functions:: The usual interface functions for visiting.* Subroutines of Visiting:: Lower-level subroutines that they use.@end menu@node Visiting Functions@subsection Functions for Visiting Files This section describes the functions normally used to visit files.For historical reasons, these functions have names starting with@samp{find-} rather than @samp{visit-}. @xref{Buffer File Name}, forfunctions and variables that access the visited file name of a buffer orthat find an existing buffer by its visited file name. In a Lisp program, if you want to look at the contents of a file butnot alter it, the fastest way is to use @code{insert-file-contents} in atemporary buffer. Visiting the file is not necessary and takes longer.@xref{Reading from Files}.@deffn Command find-file filename &optional wildcardsThis command selects a buffer visiting the file @var{filename},using an existing buffer if there is one, and otherwise creating a new buffer and reading the file into it. It also returns that buffer.The body of the @code{find-file} function is very simple and lookslike this:@example(switch-to-buffer (find-file-noselect filename))@end example@noindent(See @code{switch-to-buffer} in @ref{Displaying Buffers}.)If @var{wildcards} is non-@code{nil}, which is always true in aninteractive call, then @code{find-file} expands wildcard characters in@var{filename} and visits all the matching files.When @code{find-file} is called interactively, it prompts for@var{filename} in the minibuffer.@end deffn@defun find-file-noselect filename &optional nowarn rawfile wildcardsThis function is the guts of all the file-visiting functions. It findsor creates a buffer visiting the file @var{filename}, and returns it.It uses an existing buffer if there is one, and otherwise creates a newbuffer and reads the file into it. You may make the buffer current ordisplay it in a window if you wish, but this function does not do so.If @var{wildcards} is non-@code{nil},then @code{find-file-noselect} expands wildcardcharacters in @var{filename} and visits all the matching files.When @code{find-file-noselect} uses an existing buffer, it firstverifies that the file has not changed since it was last visited orsaved in that buffer. If the file has changed, then this function asksthe user whether to reread the changed file. If the user says@samp{yes}, any changes previously made in the buffer are lost.This function displays warning or advisory messages in various peculiarcases, unless the optional argument @var{nowarn} is non-@code{nil}. Forexample, if it needs to create a buffer, and there is no file named@var{filename}, it displays the message @samp{(New file)} in the echoarea, and leaves the buffer empty.The @code{find-file-noselect} function normally calls@code{after-find-file} after reading the file (@pxref{Subroutines ofVisiting}). That function sets the buffer major mode, parses localvariables, warns the user if there exists an auto-save file more recentthan the file just visited, and finishes by running the functions in@code{find-file-hooks}.If the optional argument @var{rawfile} is non-@code{nil}, then@code{after-find-file} is not called, and the@code{find-file-not-found-hooks} are not run in case of failure. What'smore, a non-@code{nil} @var{rawfile} value suppresses coding systemconversion (@pxref{Coding Systems}) and format conversion (@pxref{FormatConversion}).The @code{find-file-noselect} function usually returns the buffer thatis visiting the file @var{filename}. But, if wildcards are actuallyused and expanded, it returns a list of buffers that are visiting thevarious files.@example@group(find-file-noselect "/etc/fstab") @result{} #<buffer fstab>@end group@end example@end defun@deffn Command find-file-other-window filename &optional wildcardsThis command selects a buffer visiting the file @var{filename}, butdoes so in a window other than the selected window. It may use anotherexisting window or split a window; see @ref{Displaying Buffers}.When this command is called interactively, it prompts for@var{filename}.@end deffn@deffn Command find-file-read-only filename &optional wildcardsThis command selects a buffer visiting the file @var{filename}, like@code{find-file}, but it marks the buffer as read-only. @xref{Read OnlyBuffers}, for related functions and variables.When this command is called interactively, it prompts for@var{filename}.@end deffn@deffn Command view-file filenameThis command visits @var{filename} using View mode, returning to theprevious buffer when you exit View mode. View mode is a minor mode thatprovides commands to skim rapidly through the file, but does not let youmodify the text. Entering View mode runs the normal hook@code{view-mode-hook}. @xref{Hooks}.When @code{view-file} is called interactively, it prompts for@var{filename}.@end deffn@tindex find-file-wildcards@defvar find-file-wildcardsIf this variable is non-@code{nil}, then the various @code{find-file}commands check for wildcard characters and visit all the files thatmatch them. If this is @code{nil}, then wildcard characters arenot treated specially.@end defvar@defvar find-file-hooksThe value of this variable is a list of functions to be called after afile is visited. The file's local-variables specification (if any) willhave been processed before the hooks are run. The buffer visiting thefile is current when the hook functions are run.This variable works just like a normal hook, but we think that renamingit would not be advisable. @xref{Hooks}.@end defvar@defvar find-file-not-found-hooksThe value of this variable is a list of functions to be called when@code{find-file} or @code{find-file-noselect} is passed a nonexistentfile name. @code{find-file-noselect} calls these functions as soon asit detects a nonexistent file. It calls them in the order of the list,until one of them returns non-@code{nil}. @code{buffer-file-name} isalready set up.This is not a normal hook because the values of the functions areused, and in many cases only some of the functions are called.@end defvar@node Subroutines of Visiting@comment node-name, next, previous, up@subsection Subroutines of Visiting The @code{find-file-noselect} function uses two important subroutineswhich are sometimes useful in user Lisp code: @code{create-file-buffer}and @code{after-find-file}. This section explains how to use them.@defun create-file-buffer filenameThis function creates a suitably named buffer for visiting@var{filename}, and returns it. It uses @var{filename} (sans directory)as the name if that name is free; otherwise, it appends a string such as@samp{<2>} to get an unused name. See also @ref{Creating Buffers}.@strong{Please note:} @code{create-file-buffer} does @emph{not}associate the new buffer with a file and does not select the buffer.It also does not use the default major mode.@example@group(create-file-buffer "foo") @result{} #<buffer foo>@end group@group(create-file-buffer "foo") @result{} #<buffer foo<2>>@end group@group(create-file-buffer "foo") @result{} #<buffer foo<3>>@end group@end exampleThis function is used by @code{find-file-noselect}.It uses @code{generate-new-buffer} (@pxref{Creating Buffers}).@end defun@defun after-find-file &optional error warn noauto after-find-file-from-revert-buffer nomodesThis function sets the buffer major mode, and parses local variables(@pxref{Auto Major Mode}). It is called by @code{find-file-noselect}and by the default revert function (@pxref{Reverting}).@cindex new file message@cindex file open errorIf reading the file got an error because the file does not exist, butits directory does exist, the caller should pass a non-@code{nil} valuefor @var{error}. In that case, @code{after-find-file} issues a warning:@samp{(New file)}. For more serious errors, the caller should usually notcall @code{after-find-file}.If @var{warn} is non-@code{nil}, then this function issues a warningif an auto-save file exists and is more recent than the visited file.If @var{noauto} is non-@code{nil}, that says not to enable or disableAuto-Save mode. The mode remains enabled if it was enabled before.If @var{after-find-file-from-revert-buffer} is non-@code{nil}, thatmeans this call was from @code{revert-buffer}. This has no directeffect, but some mode functions and hook functions check the valueof this variable.If @var{nomodes} is non-@code{nil}, that means don't alter the buffer'smajor mode, don't process local variables specifications in the file,and don't run @code{find-file-hooks}. This feature is used by@code{revert-buffer} in some cases.The last thing @code{after-find-file} does is call all the functionsin the list @code{find-file-hooks}.@end defun@node Saving Buffers@section Saving Buffers When you edit a file in Emacs, you are actually working on a bufferthat is visiting that file---that is, the contents of the file arecopied into the buffer and the copy is what you edit. Changes to thebuffer do not change the file until you @dfn{save} the buffer, whichmeans copying the contents of the buffer into the file.@deffn Command save-buffer &optional backup-optionThis function saves the contents of the current buffer in its visitedfile if the buffer has been modified since it was last visited or saved.Otherwise it does nothing.@code{save-buffer} is responsible for making backup files. Normally,@var{backup-option} is @code{nil}, and @code{save-buffer} makes a backupfile only if this is the first save since visiting the file. Othervalues for @var{backup-option} request the making of backup files inother circumstances:@itemize @bullet@itemWith an argument of 4 or 64, reflecting 1 or 3 @kbd{C-u}'s, the@code{save-buffer} function marks this version of the file to bebacked up when the buffer is next saved.@itemWith an argument of 16 or 64, reflecting 2 or 3 @kbd{C-u}'s, the@code{save-buffer} function unconditionally backs up the previousversion of the file before saving it.@end itemize@end deffn@deffn Command save-some-buffers &optional save-silently-p predThis command saves some modified file-visiting buffers. Normally itasks the user about each buffer. But if @var{save-silently-p} isnon-@code{nil}, it saves all the file-visiting buffers without queryingthe user.The optional @var{pred} argument controls which buffers to ask about.If it is @code{nil}, that means to ask only about file-visiting buffers.If it is @code{t}, that means also offer to save certain other non-filebuffers---those that have a non-@code{nil} buffer-local value of@code{buffer-offer-save}. (A user who says @samp{yes} to saving anon-file buffer is asked to specify the file name to use.) The@code{save-buffers-kill-emacs} function passes the value @code{t} for@var{pred}.If @var{pred} is neither @code{t} nor @code{nil}, then it should bea function of no arguments. It will be called in each buffer to decidewhether to offer to save that buffer. If it returns a non-@code{nil}value in a certain buffer, that means do offer to save that buffer.@end deffn@deffn Command write-file filename &optional confirmThis function writes the current buffer into file @var{filename}, makesthe buffer visit that file, and marks it not modified. Then it renamesthe buffer based on @var{filename}, appending a string like @samp{<2>}if necessary to make a unique buffer name. It does most of this work bycalling @code{set-visited-file-name} (@pxref{Buffer File Name}) and@code{save-buffer}.If @var{confirm} is non-@code{nil}, that means to ask for confirmationbefore overwriting an existing file.@end deffn Saving a buffer runs several hooks. It also performs formatconversion (@pxref{Format Conversion}), and may save text properties in``annotations'' (@pxref{Saving Properties}).@defvar write-file-hooksThe value of this variable is a list of functions to be called beforewriting out a buffer to its visited file. If one of them returnsnon-@code{nil}, the file is considered already written and the rest ofthe functions are not called, nor is the usual code for writing the fileexecuted.If a function in @code{write-file-hooks} returns non-@code{nil}, itis responsible for making a backup file (if that is appropriate).To do so, execute the following code:@example(or buffer-backed-up (backup-buffer))@end exampleYou might wish to save the file modes value returned by@code{backup-buffer} and use that to set the mode bits of the file thatyou write. This is what @code{save-buffer} normally does.The hook functions in @code{write-file-hooks} are also responsible forencoding the data (if desired): they must choose a suitable codingsystem (@pxref{Lisp and Coding Systems}), perform the encoding(@pxref{Explicit Encoding}), and set @code{last-coding-system-used} tothe coding system that was used (@pxref{Encoding and I/O}).Do not make this variable buffer-local. To set up buffer-specific hookfunctions, use @code{write-contents-hooks} instead.Even though this is not a normal hook, you can use @code{add-hook} and@code{remove-hook} to manipulate the list. @xref{Hooks}.@end defvar@c Emacs 19 feature@defvar local-write-file-hooksThis works just like @code{write-file-hooks}, but it is intended to bemade buffer-local in particular buffers, and used for hooks that pertainto the file name or the way the buffer contents were obtained.The variable is marked as a permanent local, so that changing the majormode does not alter a buffer-local value. This is convenient forpackages that read ``file'' contents in special ways, and set up hooksto save the data in a corresponding way.@end defvar@c Emacs 19 feature@defvar write-contents-hooksThis works just like @code{write-file-hooks}, but it is intended forhooks that pertain to the contents of the file, as opposed to hooks thatpertain to where the file came from. Such hooks are usually set up bymajor modes, as buffer-local bindings for this variable.This variable automatically becomes buffer-local whenever it is set;switching to a new major mode always resets this variable. When you use@code{add-hooks} to add an element to this hook, you should @emph{not}specify a non-@code{nil} @var{local} argument, since this variable isused @emph{only} buffer-locally.@end defvar@c Emacs 19 feature@defvar after-save-hookThis normal hook runs after a buffer has been saved in its visited file.One use of this hook is in Fast Lock mode; it uses this hook to save thehighlighting information in a cache file.@end defvar@defvar file-precious-flagIf this variable is non-@code{nil}, then @code{save-buffer} protectsagainst I/O errors while saving by writing the new file to a temporaryname instead of the name it is supposed to have, and then renaming it tothe intended name after it is clear there are no errors. This procedureprevents problems such as a lack of disk space from resulting in aninvalid file.As a side effect, backups are necessarily made by copying. @xref{Renameor Copy}. Yet, at the same time, saving a precious file always breaksall hard links between the file you save and other file names.Some modes give this variable a non-@code{nil} buffer-local valuein particular buffers.@end defvar@defopt require-final-newlineThis variable determines whether files may be written out that do@emph{not} end with a newline. If the value of the variable is@code{t}, then @code{save-buffer} silently adds a newline at the end ofthe file whenever the buffer being saved does not already end in one.If the value of the variable is non-@code{nil}, but not @code{t}, then@code{save-buffer} asks the user whether to add a newline each time thecase arises.If the value of the variable is @code{nil}, then @code{save-buffer}doesn't add newlines at all. @code{nil} is the default value, but a fewmajor modes set it to @code{t} in particular buffers.@end defopt See also the function @code{set-visited-file-name} (@pxref{Buffer FileName}).@node Reading from Files@comment node-name, next, previous, up@section Reading from Files You can copy a file from the disk and insert it into a bufferusing the @code{insert-file-contents} function. Don't use the user-levelcommand @code{insert-file} in a Lisp program, as that sets the mark.@defun insert-file-contents filename &optional visit beg end replaceThis function inserts the contents of file @var{filename} into thecurrent buffer after point. It returns a list of the absolute file nameand the length of the data inserted. An error is signaled if@var{filename} is not the name of a file that can be read.The function @code{insert-file-contents} checks the file contentsagainst the defined file formats, and converts the file contents ifappropriate. @xref{Format Conversion}. It also calls the functions inthe list @code{after-insert-file-functions}; see @ref{SavingProperties}. Normally, one of the functions in the@code{after-insert-file-functions} list determines the coding system(@pxref{Coding Systems}) used for decoding the file's contents.If @var{visit} is non-@code{nil}, this function additionally marks thebuffer as unmodified and sets up various fields in the buffer so that itis visiting the file @var{filename}: these include the buffer's visitedfile name and its last save file modtime. This feature is used by@code{find-file-noselect} and you probably should not use it yourself.If @var{beg} and @var{end} are non-@code{nil}, they should be integersspecifying the portion of the file to insert. In this case, @var{visit}must be @code{nil}. For example,@example(insert-file-contents filename nil 0 500)@end example@noindentinserts the first 500 characters of a file.If the argument @var{replace} is non-@code{nil}, it means to replace thecontents of the buffer (actually, just the accessible portion) with thecontents of the file. This is better than simply deleting the buffercontents and inserting the whole file, because (1) it preserves somemarker positions and (2) it puts less data in the undo list.It is possible to read a special file (such as a FIFO or an I/O device)with @code{insert-file-contents}, as long as @var{replace} and@var{visit} are @code{nil}.@end defun@defun insert-file-contents-literally filename &optional visit beg end replaceThis function works like @code{insert-file-contents} except that it doesnot do format decoding (@pxref{Format Conversion}), does not docharacter code conversion (@pxref{Coding Systems}), does not run@code{find-file-hooks}, does not perform automatic uncompression, and soon.@end defunIf you want to pass a file name to another process so that anotherprogram can read the file, use the function @code{file-local-copy}; see@ref{Magic File Names}.@node Writing to Files@comment node-name, next, previous, up@section Writing to Files You can write the contents of a buffer, or part of a buffer, directlyto a file on disk using the @code{append-to-file} and@code{write-region} functions. Don't use these functions to write tofiles that are being visited; that could cause confusion in themechanisms for visiting.@deffn Command append-to-file start end filenameThis function appends the contents of the region delimited by@var{start} and @var{end} in the current buffer to the end of file@var{filename}. If that file does not exist, it is created. Thisfunction returns @code{nil}.An error is signaled if @var{filename} specifies a nonwritable file,or a nonexistent file in a directory where files cannot be created.@end deffn@deffn Command write-region start end filename &optional append visit lockname mustbenewThis function writes the region delimited by @var{start} and @var{end}in the current buffer into the file specified by @var{filename}.@c Emacs 19 featureIf @var{start} is a string, then @code{write-region} writes or appendsthat string, rather than text from the buffer. @var{end} is ignored inthis case.If @var{append} is non-@code{nil}, then the specified text is appendedto the existing file contents (if any). Starting in Emacs 21, if@var{append} is an integer, then @code{write-region} seeks to that byteoffset from the start of the file and writes the data from there.If @var{mustbenew} is non-@code{nil}, then @code{write-region} asksfor confirmation if @var{filename} names an existing file.Starting in Emacs 21, if @var{mustbenew} is the symbol @code{excl}, then @code{write-region} does not ask for confirmation, but insteadit signals an error @code{file-already-exists} if the file alreadyexists.The test for an existing file, when @var{mustbenew} is @code{excl}, usesa special system feature. At least for files on a local disk, there isno chance that some other program could create a file of the same namebefore Emacs does, without Emacs's noticing.If @var{visit} is @code{t}, then Emacs establishes an associationbetween the buffer and the file: the buffer is then visiting that file.It also sets the last file modification time for the current buffer to@var{filename}'s modtime, and marks the buffer as not modified. Thisfeature is used by @code{save-buffer}, but you probably should not useit yourself.@c Emacs 19 featureIf @var{visit} is a string, it specifies the file name to visit. Thisway, you can write the data to one file (@var{filename}) while recordingthe buffer as visiting another file (@var{visit}). The argument@var{visit} is used in the echo area message and also for file locking;@var{visit} is stored in @code{buffer-file-name}. This feature is usedto implement @code{file-precious-flag}; don't use it yourself unless youreally know what you're doing.The optional argument @var{lockname}, if non-@code{nil}, specifies thefile name to use for purposes of locking and unlocking, overriding@var{filename} and @var{visit} for that purpose.The function @code{write-region} converts the data which it writes tothe appropriate file formats specified by @code{buffer-file-format}.@xref{Format Conversion}. It also calls the functions in the list@code{write-region-annotate-functions}; see @ref{Saving Properties}.Normally, @code{write-region} displays the message @samp{Wrote@var{filename}} in the echo area. If @var{visit} is neither @code{t}nor @code{nil} nor a string, then this message is inhibited. Thisfeature is useful for programs that use files for internal purposes,files that the user does not need to know about.@end deffn@defmac with-temp-file file body...The @code{with-temp-file} macro evaluates the @var{body} forms with atemporary buffer as the current buffer; then, at the end, it writes thebuffer contents into file @var{file}. It kills the temporary bufferwhen finished, restoring the buffer that was current before the@code{with-temp-file} form. Then it returns the value of the last formin @var{body}.The current buffer is restored even in case of an abnormal exit via@code{throw} or error (@pxref{Nonlocal Exits}).See also @code{with-temp-buffer} in @ref{Current Buffer}.@end defmac@node File Locks@section File Locks@cindex file locks When two users edit the same file at the same time, they are likely tointerfere with each other. Emacs tries to prevent this situation fromarising by recording a @dfn{file lock} when a file is being modified.Emacs can then detect the first attempt to modify a buffer visiting afile that is locked by another Emacs job, and ask the user what to do.The file lock is really a file, a symbolic link with a special name,stored in the same directory as the file you are editing. When you access files using NFS, there may be a small probability thatyou and another user will both lock the same file ``simultaneously''.If this happens, it is possible for the two users to make changessimultaneously, but Emacs will still warn the user who saves second.Also, the detection of modification of a buffer visiting a file changedon disk catches some cases of simultaneous editing; see@ref{Modification Time}.@defun file-locked-p filenameThis function returns @code{nil} if the file @var{filename} is notlocked. It returns @code{t} if it is locked by this Emacs process, andit returns the name of the user who has locked it if it is locked bysome other job.@example@group(file-locked-p "foo") @result{} nil@end group@end example@end defun@defun lock-buffer &optional filenameThis function locks the file @var{filename}, if the current buffer ismodified. The argument @var{filename} defaults to the current buffer'svisited file. Nothing is done if the current buffer is not visiting afile, or is not modified.@end defun@defun unlock-bufferThis function unlocks the file being visited in the current buffer,if the buffer is modified. If the buffer is not modified, thenthe file should not be locked, so this function does nothing. It alsodoes nothing if the current buffer is not visiting a file.@end defun File locking is not supported on some systems. On systems that do notsupport it, the functions @code{lock-buffer}, @code{unlock-buffer} and@code{file-locked-p} do nothing and return @code{nil}.@defun ask-user-about-lock file other-userThis function is called when the user tries to modify @var{file}, but itis locked by another user named @var{other-user}. The defaultdefinition of this function asks the user to say what to do. The valuethis function returns determines what Emacs does next:@itemize @bullet@itemA value of @code{t} says to grab the lock on the file. Thenthis user may edit the file and @var{other-user} loses the lock.@itemA value of @code{nil} says to ignore the lock and let thisuser edit the file anyway.@item@kindex file-lockedThis function may instead signal a @code{file-locked} error, in whichcase the change that the user was about to make does not take place.The error message for this error looks like this:@example@error{} File is locked: @var{file} @var{other-user}@end example@noindentwhere @code{file} is the name of the file and @var{other-user} is thename of the user who has locked the file.@end itemizeIf you wish, you can replace the @code{ask-user-about-lock} functionwith your own version that makes the decision in another way. The codefor its usual definition is in @file{userlock.el}.@end defun@node Information about Files@section Information about Files The functions described in this section all operate on strings thatdesignate file names. All the functions have names that begin with theword @samp{file}. These functions all return information about actualfiles or directories, so their arguments must all exist as actual filesor directories unless otherwise noted.@menu* Testing Accessibility:: Is a given file readable? Writable?* Kinds of Files:: Is it a directory? A symbolic link?* Truenames:: Eliminating symbolic links from a file name.* File Attributes:: How large is it? Any other names? Etc.@end menu@node Testing Accessibility@comment node-name, next, previous, up@subsection Testing Accessibility@cindex accessibility of a file@cindex file accessibility These functions test for permission to access a file in specific ways.@defun file-exists-p filenameThis function returns @code{t} if a file named @var{filename} appears toexist. This does not mean you can necessarily read the file, only thatyou can find out its attributes. (On Unix and GNU/Linux, this is trueif the file exists and you have execute permission on the containingdirectories, regardless of the protection of the file itself.)If the file does not exist, or if fascist access control policiesprevent you from finding the attributes of the file, this functionreturns @code{nil}.@end defun@defun file-readable-p filenameThis function returns @code{t} if a file named @var{filename} existsand you can read it. It returns @code{nil} otherwise.@example@group(file-readable-p "files.texi") @result{} t@end group@group(file-exists-p "/usr/spool/mqueue") @result{} t@end group@group(file-readable-p "/usr/spool/mqueue") @result{} nil@end group@end example@end defun@c Emacs 19 feature@defun file-executable-p filenameThis function returns @code{t} if a file named @var{filename} exists andyou can execute it. It returns @code{nil} otherwise. On Unix andGNU/Linux, if the file is a directory, execute permission means you cancheck the existence and attributes of files inside the directory, andopen those files if their modes permit.@end defun@defun file-writable-p filenameThis function returns @code{t} if the file @var{filename} can be writtenor created by you, and @code{nil} otherwise. A file is writable if thefile exists and you can write it. It is creatable if it does not exist,but the specified directory does exist and you can write in thatdirectory.In the third example below, @file{foo} is not writable because theparent directory does not exist, even though the user could create sucha directory.@example@group(file-writable-p "~/foo") @result{} t@end group@group(file-writable-p "/foo") @result{} nil@end group@group(file-writable-p "~/no-such-dir/foo") @result{} nil@end group@end example@end defun@c Emacs 19 feature@defun file-accessible-directory-p dirnameThis function returns @code{t} if you have permission to open existingfiles in the directory whose name as a file is @var{dirname}; otherwise(or if there is no such directory), it returns @code{nil}. The valueof @var{dirname} may be either a directory name or the file name of afile which is a directory.Example: after the following,@example(file-accessible-directory-p "/foo") @result{} nil@end example@noindentwe can deduce that any attempt to read a file in @file{/foo/} willgive an error.@end defun@defun access-file filename stringThis function opens file @var{filename} for reading, then closes it andreturns @code{nil}. However, if the open fails, it signals an errorusing @var{string} as the error message text.@end defun@defun file-ownership-preserved-p filenameThis function returns @code{t} if deleting the file @var{filename} andthen creating it anew would keep the file's owner unchanged.@end defun@defun file-newer-than-file-p filename1 filename2@cindex file age@cindex file modification timeThis function returns @code{t} if the file @var{filename1} isnewer than file @var{filename2}. If @var{filename1} does notexist, it returns @code{nil}. If @var{filename2} does not exist,it returns @code{t}.In the following example, assume that the file @file{aug-19} was writtenon the 19th, @file{aug-20} was written on the 20th, and the file@file{no-file} doesn't exist at all.@example@group(file-newer-than-file-p "aug-19" "aug-20") @result{} nil@end group@group(file-newer-than-file-p "aug-20" "aug-19") @result{} t@end group@group(file-newer-than-file-p "aug-19" "no-file") @result{} t@end group@group(file-newer-than-file-p "no-file" "aug-19") @result{} nil@end group@end exampleYou can use @code{file-attributes} to get a file's last modificationtime as a list of two numbers. @xref{File Attributes}.@end defun@node Kinds of Files@comment node-name, next, previous, up@subsection Distinguishing Kinds of Files This section describes how to distinguish various kinds of files, suchas directories, symbolic links, and ordinary files.@defun file-symlink-p filename@cindex file symbolic linksIf the file @var{filename} is a symbolic link, the @code{file-symlink-p}function returns the file name to which it is linked. This may be thename of a text file, a directory, or even another symbolic link, or itmay be a nonexistent file name.If the file @var{filename} is not a symbolic link (or there is no such file),@code{file-symlink-p} returns @code{nil}. @example@group(file-symlink-p "foo") @result{} nil@end group@group(file-symlink-p "sym-link") @result{} "foo"@end group@group(file-symlink-p "sym-link2") @result{} "sym-link"@end group@group(file-symlink-p "/bin") @result{} "/pub/bin"@end group@end example@c !!! file-symlink-p: should show output of ls -l for comparison@end defun@defun file-directory-p filenameThis function returns @code{t} if @var{filename} is the name of anexisting directory, @code{nil} otherwise.@example@group(file-directory-p "~rms") @result{} t@end group@group(file-directory-p "~rms/lewis/files.texi") @result{} nil@end group@group(file-directory-p "~rms/lewis/no-such-file") @result{} nil@end group@group(file-directory-p "$HOME") @result{} nil@end group@group(file-directory-p (substitute-in-file-name "$HOME")) @result{} t@end group@end example@end defun@defun file-regular-p filenameThis function returns @code{t} if the file @var{filename} exists and isa regular file (not a directory, named pipe, terminal, orother I/O device).@end defun@node Truenames@subsection Truenames@cindex truename (of file)@c Emacs 19 features The @dfn{truename} of a file is the name that you get by followingsymbolic links at all levels until none remain, then simplifying away@samp{.}@: and @samp{..}@: appearing as name components. This resultsin a sort of canonical name for the file. A file does not always have aunique truename; the number of distinct truenames a file has is equal tothe number of hard links to the file. However, truenames are usefulbecause they eliminate symbolic links as a cause of name variation.@defun file-truename filenameThe function @code{file-truename} returns the truename of the file@var{filename}. The argument must be an absolute file name.@end defun@defun file-chase-links filenameThis function follows symbolic links, starting with @var{filename},until it finds a file name which is not the name of a symbolic link.Then it returns that file name.@end defun To illustrate the difference between @code{file-chase-links} and@code{file-truename}, suppose that @file{/usr/foo} is a symbolic link tothe directory @file{/home/foo}, and @file{/home/foo/hello} is anordinary file (or at least, not a symbolic link) or nonexistent. Thenwe would have:@example(file-chase-links "/usr/foo/hello") ;; @r{This does not follow the links in the parent directories.} @result{} "/usr/foo/hello"(file-truename "/usr/foo/hello") ;; @r{Assuming that @file{/home} is not a symbolic link.} @result{} "/home/foo/hello"@end example @xref{Buffer File Name}, for related information.@node File Attributes@comment node-name, next, previous, up@subsection Other Information about Files This section describes the functions for getting detailed informationabout a file, other than its contents. This information includes themode bits that control access permission, the owner and group numbers,the number of names, the inode number, the size, and the times of accessand modification.@defun file-modes filename@cindex permission@cindex file attributesThis function returns the mode bits of @var{filename}, as an integer.The mode bits are also called the file permissions, and they specifyaccess control in the usual Unix fashion. If the low-order bit is 1,then the file is executable by all users, if the second-lowest-order bitis 1, then the file is writable by all users, etc.The highest value returnable is 4095 (7777 octal), meaning thateveryone has read, write, and execute permission, that the @sc{suid} bitis set for both others and group, and that the sticky bit is set.@example@group(file-modes "~/junk/diffs") @result{} 492 ; @r{Decimal integer.}@end group@group(format "%o" 492) @result{} "754" ; @r{Convert to octal.}@end group@group(set-file-modes "~/junk/diffs" 438) @result{} nil@end group@group(format "%o" 438) @result{} "666" ; @r{Convert to octal.}@end group@group% ls -l diffs -rw-rw-rw- 1 lewis 0 3063 Oct 30 16:00 diffs@end group@end example@end defun@defun file-nlinks filenameThis functions returns the number of names (i.e., hard links) thatfile @var{filename} has. If the file does not exist, then this functionreturns @code{nil}. Note that symbolic links have no effect on thisfunction, because they are not considered to be names of the files theylink to.@example@group% ls -l foo*-rw-rw-rw- 2 rms 4 Aug 19 01:27 foo-rw-rw-rw- 2 rms 4 Aug 19 01:27 foo1@end group@group(file-nlinks "foo") @result{} 2@end group@group(file-nlinks "doesnt-exist") @result{} nil@end group@end example@end defun@defun file-attributes filenameThis function returns a list of attributes of file @var{filename}. Ifthe specified file cannot be opened, it returns @code{nil}.The elements of the list, in order, are:@enumerate 0@item@code{t} for a directory, a string for a symbolic link (the namelinked to), or @code{nil} for a text file.@c Wordy so as to prevent an overfull hbox. --rjc 15mar92@itemThe number of names the file has. Alternate names, also known as hardlinks, can be created by using the @code{add-name-to-file} function(@pxref{Changing Files}).@itemThe file's @sc{uid}.@itemThe file's @sc{gid}.@itemThe time of last access, as a list of two integers.The first integer has the high-order 16 bits of time,the second has the low 16 bits. (This is similar to thevalue of @code{current-time}; see @ref{Time of Day}.)@itemThe time of last modification as a list of two integers (as above).@itemThe time of last status change as a list of two integers (as above).@itemThe size of the file in bytes. If the size is too large to fit in aLisp integer, this is a floating point number.@itemThe file's modes, as a string of ten letters or dashes,as in @samp{ls -l}.@item@code{t} if the file's @sc{gid} would change if file weredeleted and recreated; @code{nil} otherwise.@itemThe file's inode number. If possible, this is an integer. If the inodenumber is too large to be represented as an integer in Emacs Lisp, thenthe value has the form @code{(@var{high} . @var{low})}, where @var{low}holds the low 16 bits.@itemThe file system number of the file system that the file is in.Depending on the magnitude of the value, this can be either an integeror a cons cell, in the same manner as the inode number. This elementand the file's inode number together give enough information todistinguish any two files on the system---no two files can have the samevalues for both of these numbers.@end enumerateFor example, here are the file attributes for @file{files.texi}:@example@group(file-attributes "files.texi") @result{} (nil 1 2235 75 (8489 20284) (8489 20284) (8489 20285) 14906 "-rw-rw-rw-" nil 129500 -32252)@end group@end example@noindentand here is how the result is interpreted:@table @code@item nilis neither a directory nor a symbolic link.@item 1has only one name (the name @file{files.texi} in the current defaultdirectory).@item 2235is owned by the user with @sc{uid} 2235.@item 75is in the group with @sc{gid} 75.@item (8489 20284)was last accessed on Aug 19 00:09.@item (8489 20284)was last modified on Aug 19 00:09.@item (8489 20285)last had its inode changed on Aug 19 00:09.@item 14906is 14906 bytes long. (It may not contain 14906 characters, though,if some of the bytes belong to multibyte sequences.)@item "-rw-rw-rw-"has a mode of read and write access for the owner, group, and world.@item nilwould retain the same @sc{gid} if it were recreated.@item 129500has an inode number of 129500.@item -32252is on file system number -32252.@end table@end defun@node Changing Files@section Changing File Names and Attributes@cindex renaming files@cindex copying files@cindex deleting files@cindex linking files@cindex setting modes of files The functions in this section rename, copy, delete, link, and set themodes of files. In the functions that have an argument @var{newname}, if a file by thename of @var{newname} already exists, the actions taken depend on thevalue of the argument @var{ok-if-already-exists}:@itemize @bullet@itemSignal a @code{file-already-exists} error if@var{ok-if-already-exists} is @code{nil}.@itemRequest confirmation if @var{ok-if-already-exists} is a number.@itemReplace the old file without confirmation if @var{ok-if-already-exists}is any other value.@end itemize@defun add-name-to-file oldname newname &optional ok-if-already-exists@cindex file with multiple names@cindex file hard linkThis function gives the file named @var{oldname} the additional name@var{newname}. This means that @var{newname} becomes a new ``hardlink'' to @var{oldname}.In the first part of the following example, we list two files,@file{foo} and @file{foo3}.@example@group% ls -li fo*81908 -rw-rw-rw- 1 rms 29 Aug 18 20:32 foo84302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3@end group@end exampleNow we create a hard link, by calling @code{add-name-to-file}, then listthe files again. This shows two names for one file, @file{foo} and@file{foo2}.@example@group(add-name-to-file "foo" "foo2") @result{} nil@end group@group% ls -li fo*81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo81908 -rw-rw-rw- 2 rms 29 Aug 18 20:32 foo284302 -rw-rw-rw- 1 rms 24 Aug 18 20:31 foo3@end group@end exampleFinally, we evaluate the following:@example(add-name-to-file "foo" "foo3" t)@end example@noindentand list the files again. Now there are three namesfor one file: @file{foo}, @file{foo2}, and @file{foo3}. The oldcontents of @file{foo3} are lost.@example@group(add-name-to-file "foo1" "foo3") @result{} nil@end group@group% ls -li fo*81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo81908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo281908 -rw-rw-rw- 3 rms 29 Aug 18 20:32 foo3@end group@end exampleThis function is meaningless on operating systems where multiple namesfor one file are not allowed. Some systems implement multiple namesby copying the file instead.See also @code{file-nlinks} in @ref{File Attributes}.@end defun@deffn Command rename-file filename newname &optional ok-if-already-existsThis command renames the file @var{filename} as @var{newname}.If @var{filename} has additional names aside from @var{filename}, itcontinues to have those names. In fact, adding the name @var{newname}with @code{add-name-to-file} and then deleting @var{filename} has thesame effect as renaming, aside from momentary intermediate states.In an interactive call, this function prompts for @var{filename} and@var{newname} in the minibuffer; also, it requests confirmation if@var{newname} already exists.@end deffn@deffn Command copy-file oldname newname &optional ok-if-exists timeThis command copies the file @var{oldname} to @var{newname}. Anerror is signaled if @var{oldname} does not exist.If @var{time} is non-@code{nil}, then this function gives the new filethe same last-modified time that the old one has. (This works on onlysome operating systems.) If setting the time gets an error,@code{copy-file} signals a @code{file-date-error} error.In an interactive call, this function prompts for @var{filename} and@var{newname} in the minibuffer; also, it requests confirmation if@var{newname} already exists.@end deffn@deffn Command delete-file filename@pindex rmThis command deletes the file @var{filename}, like the shell command@samp{rm @var{filename}}. If the file has multiple names, it continuesto exist under the other names.A suitable kind of @code{file-error} error is signaled if the file doesnot exist, or is not deletable. (On Unix and GNU/Linux, a file isdeletable if its directory is writable.)See also @code{delete-directory} in @ref{Create/Delete Dirs}.@end deffn@deffn Command make-symbolic-link filename newname &optional ok-if-exists@pindex ln@kindex file-already-existsThis command makes a symbolic link to @var{filename}, named@var{newname}. This is like the shell command @samp{ln -s@var{filename} @var{newname}}.In an interactive call, this function prompts for @var{filename} and@var{newname} in the minibuffer; also, it requests confirmation if@var{newname} already exists.This function is not available on systems that don't support symboliclinks.@end deffn@defun define-logical-name varname stringThis function defines the logical name @var{name} to have the value@var{string}. It is available only on VMS.@end defun@defun set-file-modes filename modeThis function sets mode bits of @var{filename} to @var{mode} (which mustbe an integer). Only the low 12 bits of @var{mode} are used.@end defun@c Emacs 19 feature@defun set-default-file-modes modeThis function sets the default file protection for new files created byEmacs and its subprocesses. Every file created with Emacs initially hasthis protection, or a subset of it (@code{write-region} will not give afile execute permission even if the default file protection allowsexecute permission). On Unix and GNU/Linux, the default protection isthe bitwise complement of the ``umask'' value.The argument @var{mode} must be an integer. On most systems, only thelow 9 bits of @var{mode} are meaningful. You can use the Lisp constructfor octal character codes to enter @var{mode}; for example,@example(set-default-file-modes ?\644)@end exampleSaving a modified version of an existing file does not count as creatingthe file; it preserves the existing file's mode, whatever that is. Sothe default file protection has no effect.@end defun@defun default-file-modesThis function returns the current default protection value.@end defun@cindex MS-DOS and file modes@cindex file modes and MS-DOS On MS-DOS, there is no such thing as an ``executable'' file mode bit.So Emacs considers a file executable if its name ends in one of thestandard executable extensions, such as @file{.com}, @file{.bat},@file{.exe}, and some others. Files that begin with the Unix-standard@samp{#!} signature, such as shell and Perl scripts, are also consideredas executable files. This is reflected in the values returned by@code{file-modes} and @code{file-attributes}. Directories are alsoreported with executable bit set, for compatibility with Unix.@node File Names@section File Names@cindex file names Files are generally referred to by their names, in Emacs as elsewhere.File names in Emacs are represented as strings. The functions thatoperate on a file all expect a file name argument. In addition to operating on files themselves, Emacs Lisp programsoften need to operate on file names; i.e., to take them apart and to usepart of a name to construct related file names. This section describeshow to manipulate file names. The functions in this section do not actually access files, so theycan operate on file names that do not refer to an existing file ordirectory. On MS-DOS and MS-Windows, these functions (like the function thatactually operate on files) accept MS-DOS or MS-Windows file-name syntax,where backslashes separate the components, as well as Unix syntax; butthey always return Unix syntax. On VMS, these functions (and the onesthat operate on files) understand both VMS file-name syntax and Unixsyntax. This enables Lisp programs to specify file names in Unix syntaxand work properly on all systems without change.@menu* File Name Components:: The directory part of a file name, and the rest.* Directory Names:: A directory's name as a directory is different from its name as a file.* Relative File Names:: Some file names are relative to a current directory.* File Name Expansion:: Converting relative file names to absolute ones.* Unique File Names:: Generating names for temporary files.* File Name Completion:: Finding the completions for a given file name.* Standard File Names:: If your package uses a fixed file name, how to handle various operating systems simply.@end menu@node File Name Components@subsection File Name Components@cindex directory part (of file name)@cindex nondirectory part (of file name)@cindex version number (in file name) The operating system groups files into directories. To specify afile, you must specify the directory and the file's name within thatdirectory. Therefore, Emacs considers a file name as having two mainparts: the @dfn{directory name} part, and the @dfn{nondirectory} part(or @dfn{file name within the directory}). Either part may be empty.Concatenating these two parts reproduces the original file name. On most systems, the directory part is everything up to and includingthe last slash (backslash is also allowed in input on MS-DOS orMS-Windows); the nondirectory part is the rest. The rules in VMS syntaxare complicated. For some purposes, the nondirectory part is further subdivided intothe name proper and the @dfn{version number}. On most systems, onlybackup files have version numbers in their names. On VMS, every filehas a version number, but most of the time the file name actually usedin Emacs omits the version number, so that version numbers in Emacs arefound mostly in directory lists.@defun file-name-directory filenameThis function returns the directory part of @var{filename} (or@code{nil} if @var{filename} does not include a directory part). Onmost systems, the function returns a string ending in a slash. On VMS,it returns a string ending in one of the three characters @samp{:},@samp{]}, or @samp{>}.@example@group(file-name-directory "lewis/foo") ; @r{Unix example} @result{} "lewis/"@end group@group(file-name-directory "foo") ; @r{Unix example} @result{} nil@end group@group(file-name-directory "[X]FOO.TMP") ; @r{VMS example} @result{} "[X]"@end group@end example@end defun@defun file-name-nondirectory filenameThis function returns the nondirectory part of @var{filename}.@example@group(file-name-nondirectory "lewis/foo") @result{} "foo"@end group@group(file-name-nondirectory "foo") @result{} "foo"@end group@group;; @r{The following example is accurate only on VMS.}(file-name-nondirectory "[X]FOO.TMP") @result{} "FOO.TMP"@end group@end example@end defun@defun file-name-sans-versions filename &optional keep-backup-versionThis function returns @var{filename} with any file version numbers,backup version numbers, or trailing tildes discarded.If @var{keep-backup-version} is non-@code{nil}, then true file versionnumbers understood as such by the file system are discarded from thereturn value, but backup version numbers are kept.@example@group(file-name-sans-versions "~rms/foo.~1~") @result{} "~rms/foo"@end group@group(file-name-sans-versions "~rms/foo~") @result{} "~rms/foo"@end group@group(file-name-sans-versions "~rms/foo") @result{} "~rms/foo"@end group@group;; @r{The following example applies to VMS only.}(file-name-sans-versions "foo;23") @result{} "foo"@end group@end example@end defun@defun file-name-sans-extension filenameThis function returns @var{filename} minus its ``extension,'' if any.The extension, in a file name, is the part that starts with the last@samp{.} in the last name component, except if that @samp{.} is thefirst character of the file name's last component. For example,@example(file-name-sans-extension "foo.lose.c") @result{} "foo.lose"(file-name-sans-extension "big.hack/foo") @result{} "big.hack/foo"(file-name-sans-extension "/my/home/.emacs") @result{} "/my/home.emacs"(file-name-sans-extension "/my/home/.emacs.el") @result{} "/my/home/.emacs"@end example@end defun@ignoreAndrew Innes says that this @c @defvar directory-sep-char@c @tindex directory-sep-charThis variable holds the character that Emacs normally uses to separatefile name components. The default value is @code{?/}, but on MS-Windowsyou can set it to @code{?\\}; then the functions that transform file namesuse backslashes in their output.File names using backslashes work as input to Lisp primitives even onMS-DOS and MS-Windows, even if @code{directory-sep-char} has its defaultvalue of @code{?/}.@end defvar@end ignore@defun file-name-extension filename &optional periodThis function returns @var{filename}'s final ``extension,'' if any,after applying @code{file-name-sans-versions} to remove anyversion/backup part. It returns @code{nil} for extensionless filenames such as @file{foo}. If @var{period} is non-nil, then thereturned value includes the period that delimits the extension, and if@var{filename} has no extension, the value is @code{""}. If the lastcomponent of a file name begins with a @samp{.}, that @samp{.} doesn'tcount as the beginning of an extension, so, for example,@file{.emacs}'s ``extension'' is @code{nil}, not @samp{.emacs}.@end defun@node Directory Names@comment node-name, next, previous, up@subsection Directory Names@cindex directory name@cindex file name of directory A @dfn{directory name} is the name of a directory. A directory is akind of file, and it has a file name, which is related to the directoryname but not identical to it. (This is not quite the same as the usualUnix terminology.) These two different names for the same entity arerelated by a syntactic transformation. On most systems, this is simple:a directory name ends in a slash (or backslash), whereas the directory'sname as a file lacks that slash. On VMS, the relationship is morecomplicated. The difference between a directory name and its name as a file issubtle but crucial. When an Emacs variable or function argument isdescribed as being a directory name, a file name of a directory is notacceptable. The following two functions convert between directory names and filenames. They do nothing special with environment variable substitutionssuch as @samp{$HOME}, and the constructs @samp{~}, and @samp{..}.@defun file-name-as-directory filenameThis function returns a string representing @var{filename} in a formthat the operating system will interpret as the name of a directory. Onmost systems, this means appending a slash to the string (if it does notalready end in one). On VMS, the function converts a string of the form@file{[X]Y.DIR.1} to the form @file{[X.Y]}.@example@group(file-name-as-directory "~rms/lewis") @result{} "~rms/lewis/"@end group@end example@end defun@defun directory-file-name dirnameThis function returns a string representing @var{dirname} in a form thatthe operating system will interpret as the name of a file. On mostsystems, this means removing the final slash (or backslash) from thestring. On VMS, the function converts a string of the form @file{[X.Y]}to @file{[X]Y.DIR.1}.@example@group(directory-file-name "~lewis/") @result{} "~lewis"@end group@end example@end defun@cindex directory name abbreviation Directory name abbreviations are useful for directories that arenormally accessed through symbolic links. Sometimes the users recognizeprimarily the link's name as ``the name'' of the directory, and find itannoying to see the directory's ``real'' name. If you define the linkname as an abbreviation for the ``real'' name, Emacs shows users theabbreviation instead.@defvar directory-abbrev-alistThe variable @code{directory-abbrev-alist} contains an alist ofabbreviations to use for file directories. Each element has the form@code{(@var{from} . @var{to})}, and says to replace @var{from} with@var{to} when it appears in a directory name. The @var{from} string isactually a regular expression; it should always start with @samp{^}.The function @code{abbreviate-file-name} performs these substitutions.You can set this variable in @file{site-init.el} to describe theabbreviations appropriate for your site.Here's an example, from a system on which file system @file{/home/fsf}and so on are normally accessed through symbolic links named @file{/fsf}and so on.@example(("^/home/fsf" . "/fsf") ("^/home/gp" . "/gp") ("^/home/gd" . "/gd"))@end example@end defvar To convert a directory name to its abbreviation, use thisfunction:@defun abbreviate-file-name dirnameThis function applies abbreviations from @code{directory-abbrev-alist}to its argument, and substitutes @samp{~} for the user's homedirectory.@end defun@node Relative File Names@subsection Absolute and Relative File Names@cindex absolute file name@cindex relative file name All the directories in the file system form a tree starting at theroot directory. A file name can specify all the directory namesstarting from the root of the tree; then it is called an @dfn{absolute}file name. Or it can specify the position of the file in the treerelative to a default directory; then it is called a @dfn{relative} filename. On Unix and GNU/Linux, an absolute file name starts with a slashor a tilde (@samp{~}), and a relative one does not. On MS-DOS andMS-Windows, an absolute file name starts with a slash or a backslash, orwith a drive specification @samp{@var{x}:/}, where @var{x} is the@dfn{drive letter}. The rules on VMS are complicated.@defun file-name-absolute-p filenameThis function returns @code{t} if file @var{filename} is an absolutefile name, @code{nil} otherwise. On VMS, this function understands bothUnix syntax and VMS syntax.@example@group(file-name-absolute-p "~rms/foo") @result{} t@end group@group(file-name-absolute-p "rms/foo") @result{} nil@end group@group(file-name-absolute-p "/user/rms/foo") @result{} t@end group@end example@end defun@node File Name Expansion@subsection Functions that Expand Filenames@cindex expansion of file names @dfn{Expansion} of a file name means converting a relative file nameto an absolute one. Since this is done relative to a default directory,you must specify the default directory name as well as the file name tobe expanded. Expansion also simplifies file names by eliminatingredundancies such as @file{./} and @file{@var{name}/../}.@defun expand-file-name filename &optional directoryThis function converts @var{filename} to an absolute file name. If@var{directory} is supplied, it is the default directory to start withif @var{filename} is relative. (The value of @var{directory} shoulditself be an absolute directory name; it may start with @samp{~}.)Otherwise, the current buffer's value of @code{default-directory} isused. For example:@example@group(expand-file-name "foo") @result{} "/xcssun/users/rms/lewis/foo"@end group@group(expand-file-name "../foo") @result{} "/xcssun/users/rms/foo"@end group@group(expand-file-name "foo" "/usr/spool/") @result{} "/usr/spool/foo"@end group@group(expand-file-name "$HOME/foo") @result{} "/xcssun/users/rms/lewis/$HOME/foo"@end group@end exampleFilenames containing @samp{.} or @samp{..} are simplified to theircanonical form:@example@group(expand-file-name "bar/../foo") @result{} "/xcssun/users/rms/lewis/foo"@end group@end exampleNote that @code{expand-file-name} does @emph{not} expand environmentvariables; only @code{substitute-in-file-name} does that.@end defun@c Emacs 19 feature@defun file-relative-name filename &optional directoryThis function does the inverse of expansion---it tries to return arelative name that is equivalent to @var{filename} when interpretedrelative to @var{directory}. If @var{directory} is omitted or@code{nil}, it defaults to the current buffer's default directory.On some operating systems, an absolute file name begins with a devicename. On such systems, @var{filename} has no relative equivalent basedon @var{directory} if they start with two different device names. Inthis case, @code{file-relative-name} returns @var{filename} in absoluteform.@example(file-relative-name "/foo/bar" "/foo/") @result{} "bar"(file-relative-name "/foo/bar" "/hack/") @result{} "../foo/bar"@end example@end defun@defvar default-directoryThe value of this buffer-local variable is the default directory for thecurrent buffer. It should be an absolute directory name; it may startwith @samp{~}. This variable is buffer-local in every buffer.@code{expand-file-name} uses the default directory when its secondargument is @code{nil}.Aside from VMS, the value is always a string ending with a slash.@example@groupdefault-directory @result{} "/user/lewis/manual/"@end group@end example@end defvar@defun substitute-in-file-name filenameThis function replaces environment variables references in@var{filename} with the environment variable values. Following standardUnix shell syntax, @samp{$} is the prefix to substitute an environmentvariable value.The environment variable name is the series of alphanumeric characters(including underscores) that follow the @samp{$}. If the character followingthe @samp{$} is a @samp{@{}, then the variable name is everything up to thematching @samp{@}}.@c Wordy to avoid overfull hbox. --rjc 15mar92Here we assume that the environment variable @code{HOME}, which holdsthe user's home directory name, has value @samp{/xcssun/users/rms}.@example@group(substitute-in-file-name "$HOME/foo") @result{} "/xcssun/users/rms/foo"@end group@end exampleAfter substitution, if a @samp{~} or a @samp{/} appears following a@samp{/}, everything before the following @samp{/} is discarded:@example@group(substitute-in-file-name "bar/~/foo") @result{} "~/foo"@end group@group(substitute-in-file-name "/usr/local/$HOME/foo") @result{} "/xcssun/users/rms/foo" ;; @r{@file{/usr/local/} has been discarded.}@end group@end exampleOn VMS, @samp{$} substitution is not done, so this function does nothingon VMS except discard superfluous initial components as shown above.@end defun@node Unique File Names@subsection Generating Unique File Names Some programs need to write temporary files. Here is the usual way toconstruct a name for such a file, starting in Emacs 21:@example(make-temp-file @var{name-of-application})@end example@noindentThe job of @code{make-temp-file} is to prevent two different users ortwo different jobs from trying to use the exact same file name.@defun make-temp-file prefix &optional dir-flag@tindex make-temp-fileThis function creates a temporary file and returns its name.The name starts with @var{prefix}; it also contains a number that isdifferent in each Emacs job. If @var{prefix} is a relative file name,it is expanded against @code{temporary-file-directory}.@example@group(make-temp-file "foo") @result{} "/tmp/foo232J6v"@end group@end exampleWhen @code{make-temp-file} returns, the file has been created and isempty. At that point, you should write the intended contents into thefile.If @var{dir-flag} is non-@code{nil}, @code{make-temp-file} createsan empty directory instead of an empty file.To prevent conflicts among different libraries running in the sameEmacs, each Lisp program that uses @code{make-temp-file} should have itsown @var{prefix}. The number added to the end of @var{prefix}distinguishes between the same application running in different Emacsjobs. Additional added characters permit a large number of distinctnames even in one Emacs job.@end defun The default directory for temporary files is controlled by thevariable @code{temporary-file-directory}. This variable gives the usera uniform way to specify the directory for all temporary files. Someprograms use @code{small-temporary-file-directory} instead, if that isnon-@code{nil}. To use it, you should expand the prefix againstthe proper directory before calling @code{make-temp-file}. In older Emacs versions where @code{make-temp-file} does not exist,you should use @code{make-temp-name} instead:@example(make-temp-name (expand-file-name @var{name-of-application} temporary-file-directory))@end example@defun make-temp-name stringThis function generates a string that can be used as a unique file name.The name starts with @var{string}, and contains a number that isdifferent in each Emacs job. It is like @code{make-temp-file} exceptthat it just constructs a name, and does not create a file. On MS-DOS,the @var{string} prefix can be truncated to fit into the 8+3 file-namelimits.@end defun@defvar temporary-file-directory@cindex @code{TMPDIR} environment variable@cindex @code{TMP} environment variable@cindex @code{TEMP} environment variableThis variable specifies the directory name for creating temporary files.Its value should be a directory name (@pxref{Directory Names}), but itis good for Lisp programs to cope if the value is a directory's filename instead. Using the value as the second argument to@code{expand-file-name} is a good way to achieve that.The default value is determined in a reasonable way for your operatingsystem; it is based on the @code{TMPDIR}, @code{TMP} and @code{TEMP}environment variables, with a fall-back to a system-dependent name ifnone of these variables is defined.Even if you do not use @code{make-temp-name} to choose the temporaryfile's name, you should still use this variable to decide whichdirectory to put the file in. However, if you expect the file to besmall, you should use @code{small-temporary-file-directory} first ifthat is non-@code{nil}.@end defvar@tindex small-temporary-file-directory@defvar small-temporary-file-directoryThis variable (new in Emacs 21) specifies the directory name forcreating certain temporary files, which are likely to be small.If you want to write a temporary file which is likely to be small, youshould compute the directory like this:@example(make-temp-file (expand-file-name @var{prefix} (or small-temporary-file-directory temporary-file-directory)))@end example@end defvar@node File Name Completion@subsection File Name Completion@cindex file name completion subroutines@cindex completion, file name This section describes low-level subroutines for completing a filename. For other completion functions, see @ref{Completion}.@defun file-name-all-completions partial-filename directoryThis function returns a list of all possible completions for a filewhose name starts with @var{partial-filename} in directory@var{directory}. The order of the completions is the order of the filesin the directory, which is unpredictable and conveys no usefulinformation.The argument @var{partial-filename} must be a file name containing nodirectory part and no slash (or backslash on some systems). The currentbuffer's default directory is prepended to @var{directory}, if@var{directory} is not absolute.In the following example, suppose that @file{~rms/lewis} is the currentdefault directory, and has five files whose names begin with @samp{f}:@file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and@file{file.c.~2~}.@refill@example@group(file-name-all-completions "f" "") @result{} ("foo" "file~" "file.c.~2~" "file.c.~1~" "file.c")@end group@group(file-name-all-completions "fo" "") @result{} ("foo")@end group@end example@end defun@defun file-name-completion filename directoryThis function completes the file name @var{filename} in directory@var{directory}. It returns the longest prefix common to all file namesin directory @var{directory} that start with @var{filename}.If only one match exists and @var{filename} matches it exactly, thefunction returns @code{t}. The function returns @code{nil} if directory@var{directory} contains no name starting with @var{filename}.In the following example, suppose that the current default directoryhas five files whose names begin with @samp{f}: @file{foo},@file{file~}, @file{file.c}, @file{file.c.~1~}, and@file{file.c.~2~}.@refill@example@group(file-name-completion "fi" "") @result{} "file"@end group@group(file-name-completion "file.c.~1" "") @result{} "file.c.~1~"@end group@group(file-name-completion "file.c.~1~" "") @result{} t@end group@group(file-name-completion "file.c.~3" "") @result{} nil@end group@end example@end defun@defopt completion-ignored-extensions@code{file-name-completion} usually ignores file names that end in anystring in this list. It does not ignore them when all the possiblecompletions end in one of these suffixes or when a buffer showing allpossible completions is displayed.@refillA typical value might look like this:@example@groupcompletion-ignored-extensions @result{} (".o" ".elc" "~" ".dvi")@end group@end exampleIf an element of @code{completion-ignored-extensions} ends in a slash@samp{/}, it signals a directory. The elements which do @emph{not} endin a slash will never match a directory; thus, the above value will notfilter out a directory named @file{foo.elc}.@end defopt@node Standard File Names@subsection Standard File Names Most of the file names used in Lisp programs are entered by the user.But occasionally a Lisp program needs to specify a standard file namefor a particular use---typically, to hold customization informationabout each user. For example, abbrev definitions are stored (bydefault) in the file @file{~/.abbrev_defs}; the @code{completion}package stores completions in the file @file{~/.completions}. These aretwo of the many standard file names used by parts of Emacs for certainpurposes. Various operating systems have their own conventions for valid filenames and for which file names to use for user profile data. A Lispprogram which reads a file using a standard file name ought to use, oneach type of system, a file name suitable for that system. The function@code{convert-standard-filename} makes this easy to do.@defun convert-standard-filename filenameThis function alters the file name @var{filename} to fit the conventionsof the operating system in use, and returns the result as a new string.@end defun The recommended way to specify a standard file name in a Lisp programis to choose a name which fits the conventions of GNU and Unix systems,usually with a nondirectory part that starts with a period, and pass itto @code{convert-standard-filename} instead of using it directly. Hereis an example from the @code{completion} package:@example(defvar save-completions-file-name (convert-standard-filename "~/.completions") "*The file name to save completions to.")@end example On GNU and Unix systems, and on some other systems as well,@code{convert-standard-filename} returns its argument unchanged. Onsome other systems, it alters the name to fit the system's conventions. For example, on MS-DOS the alterations made by this function includeconverting a leading @samp{.} to @samp{_}, converting a @samp{_} in themiddle of the name to @samp{.} if there is no other @samp{.}, insertinga @samp{.} after eight characters if there is none, and truncating tothree characters after the @samp{.}. (It makes other changes as well.)Thus, @file{.abbrev_defs} becomes @file{_abbrev.def}, and@file{.completions} becomes @file{_complet.ion}.@node Contents of Directories@section Contents of Directories@cindex directory-oriented functions@cindex file names in directory A directory is a kind of file that contains other files entered undervarious names. Directories are a feature of the file system. Emacs can list the names of the files in a directory as a Lisp list,or display the names in a buffer using the @code{ls} shell command. Inthe latter case, it can optionally display information about each file,depending on the options passed to the @code{ls} command.@defun directory-files directory &optional full-name match-regexp nosortThis function returns a list of the names of the files in the directory@var{directory}. By default, the list is in alphabetical order.If @var{full-name} is non-@code{nil}, the function returns the files'absolute file names. Otherwise, it returns the names relative tothe specified directory.If @var{match-regexp} is non-@code{nil}, this function returns onlythose file names that contain a match for that regular expression---theother file names are excluded from the list.@c Emacs 19 featureIf @var{nosort} is non-@code{nil}, @code{directory-files} does not sortthe list, so you get the file names in no particular order. Use this ifyou want the utmost possible speed and don't care what order the filesare processed in. If the order of processing is visible to the user,then the user will probably be happier if you do sort the names.@example@group(directory-files "~lewis") @result{} ("#foo#" "#foo.el#" "." ".." "dired-mods.el" "files.texi" "files.texi.~1~")@end group@end exampleAn error is signaled if @var{directory} is not the name of a directorythat can be read.@end defun@defun file-name-all-versions file dirnameThis function returns a list of all versions of the file named@var{file} in directory @var{dirname}.@end defun@tindex file-expand-wildcards@defun file-expand-wildcards pattern &optional fullThis function expands the wildcard pattern @var{pattern}, returninga list of file names that match it.If @var{pattern} is written as an absolute file name,the values are absolute also.If @var{pattern} is written as a relative file name, it is interpretedrelative to the current default directory. The file names returned arenormally also relative to the current default directory. However, if@var{full} is non-@code{nil}, they are absolute.@end defun@defun insert-directory file switches &optional wildcard full-directory-pThis function inserts (in the current buffer) a directory listing fordirectory @var{file}, formatted with @code{ls} according to@var{switches}. It leaves point after the inserted text.The argument @var{file} may be either a directory name or a filespecification including wildcard characters. If @var{wildcard} isnon-@code{nil}, that means treat @var{file} as a file specification withwildcards.If @var{full-directory-p} is non-@code{nil}, that means the directorylisting is expected to show the full contents of a directory. Youshould specify @code{t} when @var{file} is a directory and switches donot contain @samp{-d}. (The @samp{-d} option to @code{ls} says todescribe a directory itself as a file, rather than showing itscontents.)On most systems, this function works by running a directory listingprogram whose name is in the variable @code{insert-directory-program}.If @var{wildcard} is non-@code{nil}, it also runs the shell specified by@code{shell-file-name}, to expand the wildcards.MS-DOS and MS-Windows systems usually lack the standard Unix program@code{ls}, so this function emulates the standard Unix program @code{ls}with Lisp code.@end defun@defvar insert-directory-programThis variable's value is the program to run to generate a directory listingfor the function @code{insert-directory}. It is ignored on systemswhich generate the listing with Lisp code.@end defvar@node Create/Delete Dirs@section Creating and Deleting Directories@c Emacs 19 features Most Emacs Lisp file-manipulation functions get errors when used onfiles that are directories. For example, you cannot delete a directorywith @code{delete-file}. These special functions exist to create anddelete directories.@defun make-directory dirname &optional parentsThis function creates a directory named @var{dirname}.If @var{parents} is non-@code{nil}, that means to createthe parent directories first, if they don't already exist.@end defun@defun delete-directory dirnameThis function deletes the directory named @var{dirname}. The function@code{delete-file} does not work for files that are directories; youmust use @code{delete-directory} for them. If the directory containsany files, @code{delete-directory} signals an error.@end defun@node Magic File Names@section Making Certain File Names ``Magic''@cindex magic file names@c Emacs 19 feature You can implement special handling for certain file names. This iscalled making those names @dfn{magic}. The principal use for thisfeature is in implementing remote file names (@pxref{Remote Files,,Remote Files, emacs, The GNU Emacs Manual}). To define a kind of magic file name, you must supply a regularexpression to define the class of names (all those that match theregular expression), plus a handler that implements all the primitiveEmacs file operations for file names that do match. The variable @code{file-name-handler-alist} holds a list of handlers,together with regular expressions that determine when to apply eachhandler. Each element has this form:@example(@var{regexp} . @var{handler})@end example@noindentAll the Emacs primitives for file access and file name transformationcheck the given file name against @code{file-name-handler-alist}. Ifthe file name matches @var{regexp}, the primitives handle that file bycalling @var{handler}.The first argument given to @var{handler} is the name of the primitive;the remaining arguments are the arguments that were passed to thatprimitive. (The first of these arguments is most often the file nameitself.) For example, if you do this:@example(file-exists-p @var{filename})@end example@noindentand @var{filename} has handler @var{handler}, then @var{handler} iscalled like this:@example(funcall @var{handler} 'file-exists-p @var{filename})@end exampleWhen a function takes two or more arguments that must be file names,it checks each of those names for a handler. For example, if you dothis:@example(expand-file-name @var{filename} @var{dirname})@end example@noindentthen it checks for a handler for @var{filename} and then for a handlerfor @var{dirname}. In either case, the @var{handler} is called likethis:@example(funcall @var{handler} 'expand-file-name @var{filename} @var{dirname})@end example@noindentThe @var{handler} then needs to figure out whether to handle@var{filename} or @var{dirname}.Here are the operations that a magic file name handler gets to handle:@ifnottex@noindent@code{add-name-to-file}, @code{copy-file}, @code{delete-directory},@code{delete-file},@code{diff-latest-backup-file},@code{directory-file-name},@code{directory-files},@code{dired-call-process},@code{dired-compress-file}, @code{dired-uncache},@code{expand-file-name},@code{file-accessible-directory-p},@*@code{file-attributes},@code{file-directory-p},@code{file-executable-p}, @code{file-exists-p},@*@code{file-local-copy},@code{file-modes}, @code{file-name-all-completions},@*@code{file-name-as-directory},@code{file-name-completion},@code{file-name-directory},@code{file-name-nondirectory},@code{file-name-sans-versions}, @code{file-newer-than-file-p},@code{file-ownership-preserved-p},@code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p},@code{file-truename}, @code{file-writable-p},@code{find-backup-file-name},@code{get-file-buffer},@*@code{insert-directory},@code{insert-file-contents},@code{load}, @code{make-directory},@code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes},@code{set-visited-file-modtime}, @code{shell-command},@*@code{unhandled-file-name-directory},@code{vc-registered},@code{verify-visited-file-modtime},@*@code{write-region}.@end ifnottex@iftex@noindent@flushleft@code{add-name-to-file}, @code{copy-file}, @code{delete-directory},@code{delete-file},@code{diff-latest-backup-file},@code{directory-file-name},@code{directory-files},@code{dired-call-process},@code{dired-compress-file}, @code{dired-uncache},@code{expand-file-name},@code{file-accessible-direc@discretionary{}{}{}tory-p},@code{file-attributes},@code{file-direct@discretionary{}{}{}ory-p},@code{file-executable-p}, @code{file-exists-p},@code{file-local-copy},@code{file-modes}, @code{file-name-all-completions},@code{file-name-as-directory},@code{file-name-completion},@code{file-name-directory},@code{file-name-nondirec@discretionary{}{}{}tory},@code{file-name-sans-versions}, @code{file-newer-than-file-p},@code{file-ownership-pre@discretionary{}{}{}served-p},@code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p},@code{file-truename}, @code{file-writable-p},@code{find-backup-file-name},@code{get-file-buffer},@code{insert-directory},@code{insert-file-contents},@code{load}, @code{make-direc@discretionary{}{}{}tory},@code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes},@code{set-visited-file-modtime}, @code{shell-command},@code{unhandled-file-name-directory},@code{vc-regis@discretionary{}{}{}tered},@code{verify-visited-file-modtime},@code{write-region}.@end flushleft@end iftexHandlers for @code{insert-file-contents} typically need to clear thebuffer's modified flag, with @code{(set-buffer-modified-p nil)}, if the@var{visit} argument is non-@code{nil}. This also has the effect ofunlocking the buffer if it is locked.The handler function must handle all of the above operations, andpossibly others to be added in the future. It need not implement allthese operations itself---when it has nothing special to do for acertain operation, it can reinvoke the primitive, to handle theoperation ``in the usual way''. It should always reinvoke the primitivefor an operation it does not recognize. Here's one way to do this:@smallexample(defun my-file-handler (operation &rest args) ;; @r{First check for the specific operations} ;; @r{that we have special handling for.} (cond ((eq operation 'insert-file-contents) @dots{}) ((eq operation 'write-region) @dots{}) @dots{} ;; @r{Handle any operation we don't know about.} (t (let ((inhibit-file-name-handlers (cons 'my-file-handler (and (eq inhibit-file-name-operation operation) inhibit-file-name-handlers))) (inhibit-file-name-operation operation)) (apply operation args)))))@end smallexampleWhen a handler function decides to call the ordinary Emacs primitive forthe operation at hand, it needs to prevent the primitive from callingthe same handler once again, thus leading to an infinite recursion. Theexample above shows how to do this, with the variables@code{inhibit-file-name-handlers} and@code{inhibit-file-name-operation}. Be careful to use them exactly asshown above; the details are crucial for proper behavior in the case ofmultiple handlers, and for operations that have two file names that mayeach have handlers.@defvar inhibit-file-name-handlersThis variable holds a list of handlers whose use is presently inhibitedfor a certain operation.@end defvar@defvar inhibit-file-name-operationThe operation for which certain handlers are presently inhibited.@end defvar@defun find-file-name-handler file operationThis function returns the handler function for file name @var{file}, or@code{nil} if there is none. The argument @var{operation} should be theoperation to be performed on the file---the value you will pass to thehandler as its first argument when you call it. The operation is neededfor comparison with @code{inhibit-file-name-operation}.@end defun@defun file-local-copy filenameThis function copies file @var{filename} to an ordinary non-magic file,if it isn't one already.If @var{filename} specifies a magic file name, which programsoutside Emacs cannot directly read or write, this copies the contents toan ordinary file and returns that file's name.If @var{filename} is an ordinary file name, not magic, then this functiondoes nothing and returns @code{nil}.@end defun@defun unhandled-file-name-directory filenameThis function returns the name of a directory that is not magic. Ituses the directory part of @var{filename} if that is not magic. For amagic file name, it invokes the file name handler, which thereforedecides what value to return.This is useful for running a subprocess; every subprocess must have anon-magic directory to serve as its current directory, and this functionis a good way to come up with one.@end defun@node Format Conversion@section File Format Conversion@cindex file format conversion@cindex encoding file formats@cindex decoding file formats The variable @code{format-alist} defines a list of @dfn{file formats},which describe textual representations used in files for the data (text,text-properties, and possibly other information) in an Emacs buffer.Emacs performs format conversion if appropriate when reading and writingfiles.@defvar format-alistThis list contains one format definition for each defined file format.@end defvar@cindex format definitionEach format definition is a list of this form:@example(@var{name} @var{doc-string} @var{regexp} @var{from-fn} @var{to-fn} @var{modify} @var{mode-fn})@end exampleHere is what the elements in a format definition mean:@table @var@item nameThe name of this format.@item doc-stringA documentation string for the format.@item regexpA regular expression which is used to recognize files represented inthis format.@item from-fnA shell command or function to decode data in this format (to convertfile data into the usual Emacs data representation).A shell command is represented as a string; Emacs runs the command as afilter to perform the conversion.If @var{from-fn} is a function, it is called with two arguments, @var{begin}and @var{end}, which specify the part of the buffer it should convert.It should convert the text by editing it in place. Since this canchange the length of the text, @var{from-fn} should return the modifiedend position.One responsibility of @var{from-fn} is to make sure that the beginningof the file no longer matches @var{regexp}. Otherwise it is likely toget called again.@item to-fnA shell command or function to encode data in this format---that is, toconvert the usual Emacs data representation into this format.If @var{to-fn} is a string, it is a shell command; Emacs runs thecommand as a filter to perform the conversion.If @var{to-fn} is a function, it is called with two arguments, @var{begin}and @var{end}, which specify the part of the buffer it should convert.There are two ways it can do the conversion:@itemize @bullet@itemBy editing the buffer in place. In this case, @var{to-fn} shouldreturn the end-position of the range of text, as modified.@itemBy returning a list of annotations. This is a list of elements of theform @code{(@var{position} . @var{string})}, where @var{position} is aninteger specifying the relative position in the text to be written, and@var{string} is the annotation to add there. The list must be sorted inorder of position when @var{to-fn} returns it.When @code{write-region} actually writes the text from the buffer to thefile, it intermixes the specified annotations at the correspondingpositions. All this takes place without modifying the buffer.@end itemize@item modifyA flag, @code{t} if the encoding function modifies the buffer, and@code{nil} if it works by returning a list of annotations.@item mode-fnA minor-mode function to call after visiting a file converted from thisformat. The function is called with one argument, the integer 1;that tells a minor-mode function to enable the mode.@end tableThe function @code{insert-file-contents} automatically recognizes fileformats when it reads the specified file. It checks the text of thebeginning of the file against the regular expressions of the formatdefinitions, and if it finds a match, it calls the decoding function forthat format. Then it checks all the known formats over again.It keeps checking them until none of them is applicable.Visiting a file, with @code{find-file-noselect} or the commands that useit, performs conversion likewise (because it calls@code{insert-file-contents}); it also calls the mode function for eachformat that it decodes. It stores a list of the format names in thebuffer-local variable @code{buffer-file-format}.@defvar buffer-file-formatThis variable states the format of the visited file. More precisely,this is a list of the file format names that were decoded in the courseof visiting the current buffer's file. It is always buffer-local in allbuffers.@end defvarWhen @code{write-region} writes data into a file, it first calls theencoding functions for the formats listed in @code{buffer-file-format},in the order of appearance in the list.@deffn Command format-write-file file formatThis command writes the current buffer contents into the file @var{file}in format @var{format}, and makes that format the default for futuresaves of the buffer. The argument @var{format} is a list of formatnames.@end deffn@deffn Command format-find-file file formatThis command finds the file @var{file}, converting it according toformat @var{format}. It also makes @var{format} the default if thebuffer is saved later.The argument @var{format} is a list of format names. If @var{format} is@code{nil}, no conversion takes place. Interactively, typing just@key{RET} for @var{format} specifies @code{nil}.@end deffn@deffn Command format-insert-file file format &optional beg endThis command inserts the contents of file @var{file}, converting itaccording to format @var{format}. If @var{beg} and @var{end} arenon-@code{nil}, they specify which part of the file to read, as in@code{insert-file-contents} (@pxref{Reading from Files}).The return value is like what @code{insert-file-contents} returns: alist of the absolute file name and the length of the data inserted(after conversion).The argument @var{format} is a list of format names. If @var{format} is@code{nil}, no conversion takes place. Interactively, typing just@key{RET} for @var{format} specifies @code{nil}.@end deffn@defvar auto-save-file-formatThis variable specifies the format to use for auto-saving. Its value isa list of format names, just like the value of@code{buffer-file-format}; however, it is used instead of@code{buffer-file-format} for writing auto-save files. This variable isalways buffer-local in all buffers.@end defvar