diff options
| author | Chong Yidong | 2011-01-08 17:01:13 -0500 |
|---|---|---|
| committer | Chong Yidong | 2011-01-08 17:01:13 -0500 |
| commit | c40b51e0ff77adfbe27150de0e154bd0015a4ec5 (patch) | |
| tree | eaaa84b12661dda5343a39e4bb7b72cf02edc4d7 /doc/lispref | |
| parent | ad2d9b0e33e4eef277b67f58ec8b024d0dd1e0e7 (diff) | |
| download | emacs-c40b51e0ff77adfbe27150de0e154bd0015a4ec5.tar.gz emacs-c40b51e0ff77adfbe27150de0e154bd0015a4ec5.zip | |
Move directory-abbrev-alist doc from Lispref to Emacs manual.
* doc/emacs/files.texi (File Aliases): Move directory-abbrev-alist doc from Lisp
manual. Explain why directory-abbrev-alist elements should be anchored
(Bug#7777).
* doc/lispref/files.texi (Directory Names): Move directory-abbrev-alist doc to
Emacs manual.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 55 |
2 files changed, 13 insertions, 46 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 1c4e6b9074f..e1180124c05 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | 2011-01-08 Chong Yidong <cyd@stupidchicken.com> | 1 | 2011-01-08 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 2 | ||
| 3 | * files.texi (Directory Names): Explain why directory-abbrev-alist | 3 | * files.texi (Directory Names): Move directory-abbrev-alist doc to |
| 4 | elements should be anchored (Bug#7777). | 4 | Emacs manual. |
| 5 | 5 | ||
| 6 | 2011-01-07 Eli Zaretskii <eliz@gnu.org> | 6 | 2011-01-07 Eli Zaretskii <eliz@gnu.org> |
| 7 | 7 | ||
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index c2a14b5025e..1f66da98347 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -1920,55 +1920,22 @@ Don't try concatenating a slash by hand, as in | |||
| 1920 | because this is not portable. Always use | 1920 | because this is not portable. Always use |
| 1921 | @code{file-name-as-directory}. | 1921 | @code{file-name-as-directory}. |
| 1922 | 1922 | ||
| 1923 | @cindex directory name abbreviation | ||
| 1924 | Directory name abbreviations are useful for directories that are | ||
| 1925 | normally accessed through symbolic links. Sometimes the users recognize | ||
| 1926 | primarily the link's name as ``the name'' of the directory, and find it | ||
| 1927 | annoying to see the directory's ``real'' name. If you define the link | ||
| 1928 | name as an abbreviation for the ``real'' name, Emacs shows users the | ||
| 1929 | abbreviation instead. | ||
| 1930 | |||
| 1931 | @defopt directory-abbrev-alist | ||
| 1932 | The variable @code{directory-abbrev-alist} contains an alist of | ||
| 1933 | abbreviations to use for file directories. Each element has the form | ||
| 1934 | @code{(@var{from} . @var{to})}, and says to replace @var{from} with | ||
| 1935 | @var{to} when it appears in a directory name. | ||
| 1936 | |||
| 1937 | The @var{from} string is actually a regular expression. It ought to | ||
| 1938 | always start with @samp{\`}, to avoid incorrectly matching to a | ||
| 1939 | relative portion of the supplied directory name. | ||
| 1940 | |||
| 1941 | The @var{to} string should be an ordinary absolute directory name. | ||
| 1942 | Do not use @samp{~} to stand for a home directory in that string; the | ||
| 1943 | function @code{abbreviate-file-name} performs these substitutions. | ||
| 1944 | |||
| 1945 | You can set this variable in @file{site-init.el} to describe the | ||
| 1946 | abbreviations appropriate for your site. | ||
| 1947 | |||
| 1948 | Here's an example, from a system on which file system @file{/home/fsf} | ||
| 1949 | and so on are normally accessed through symbolic links named @file{/fsf} | ||
| 1950 | and so on. | ||
| 1951 | |||
| 1952 | @example | ||
| 1953 | (("\\`/home/fsf" . "/fsf") | ||
| 1954 | ("\\`/home/gp" . "/gp") | ||
| 1955 | ("\\`/home/gd" . "/gd")) | ||
| 1956 | @end example | ||
| 1957 | @end defopt | ||
| 1958 | |||
| 1959 | To convert a directory name to its abbreviation, use this | 1923 | To convert a directory name to its abbreviation, use this |
| 1960 | function: | 1924 | function: |
| 1961 | 1925 | ||
| 1962 | @defun abbreviate-file-name filename | 1926 | @defun abbreviate-file-name filename |
| 1963 | @anchor{Definition of abbreviate-file-name} | 1927 | @anchor{Definition of abbreviate-file-name} |
| 1964 | This function applies abbreviations from @code{directory-abbrev-alist} | 1928 | This function returns an abbreviated form of @var{filename}. It |
| 1965 | to its argument, and also substitutes @samp{~} for the user's home | 1929 | applies the abbreviations specified in @code{directory-abbrev-alist} |
| 1966 | directory if the argument names a file in the home directory or one of | 1930 | (@pxref{File Aliases,,File Aliases, emacs, The GNU Emacs Manual}), |
| 1967 | its subdirectories. (If the home directory is a root directory, it is | 1931 | then substitutes @samp{~} for the user's home directory if the |
| 1968 | not replaced with @samp{~}, because this does not make the result | 1932 | argument names a file in the home directory or one of its |
| 1969 | shorter on many systems.) You can use it for directory names and for | 1933 | subdirectories. If the home directory is a root directory, it is not |
| 1970 | file names, because it recognizes abbreviations even as part of the | 1934 | replaced with @samp{~}, because this does not make the result shorter |
| 1971 | name. | 1935 | on many systems. |
| 1936 | |||
| 1937 | You can use this function for directory names and for file names, | ||
| 1938 | because it recognizes abbreviations even as part of the name. | ||
| 1972 | @end defun | 1939 | @end defun |
| 1973 | 1940 | ||
| 1974 | @node File Name Expansion | 1941 | @node File Name Expansion |