aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/ChangeLog11
-rw-r--r--doc/emacs/files.texi26
-rw-r--r--doc/emacs/msdog.texi32
-rw-r--r--doc/lispref/ChangeLog10
-rw-r--r--doc/lispref/files.texi51
5 files changed, 75 insertions, 55 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index a374272135f..4825f08979f 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,14 @@
12011-01-08 Chong Yidong <cyd@stupidchicken.com>
2
3 * files.texi (File Aliases): Move directory-abbrev-alist doc from Lisp
4 manual. Explain why directory-abbrev-alist elements should be anchored
5 (Bug#7777).
6
72011-01-07 Eli Zaretskii <eliz@gnu.org>
8
9 * msdog.texi (Windows Startup): Correct inaccurate description of
10 differences between emacsclient.exe and emacsclientw.exe.
11
12010-12-30 Chong Yidong <cyd@stupidchicken.com> 122010-12-30 Chong Yidong <cyd@stupidchicken.com>
2 13
3 * rmail.texi (Rmail Display): Edit for grammar and conciseness. 14 * rmail.texi (Rmail Display): Edit for grammar and conciseness.
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index 4df81caa8f2..530c2bb94f7 100644
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -1158,7 +1158,6 @@ links point to directories.
1158 1158
1159@vindex find-file-existing-other-name 1159@vindex find-file-existing-other-name
1160@vindex find-file-suppress-same-file-warnings 1160@vindex find-file-suppress-same-file-warnings
1161
1162 Normally, if you visit a file which Emacs is already visiting under 1161 Normally, if you visit a file which Emacs is already visiting under
1163a different name, Emacs displays a message in the echo area and uses 1162a different name, Emacs displays a message in the echo area and uses
1164the existing buffer visiting that file. This can happen on systems 1163the existing buffer visiting that file. This can happen on systems
@@ -1180,6 +1179,31 @@ then the file name recorded for a buffer is the file's @dfn{truename}
1180than the name you specify. Setting @code{find-file-visit-truename} also 1179than the name you specify. Setting @code{find-file-visit-truename} also
1181implies the effect of @code{find-file-existing-other-name}. 1180implies the effect of @code{find-file-existing-other-name}.
1182 1181
1182@cindex directory name abbreviation
1183@vindex directory-abbrev-alist
1184 Sometimes, a directory is ordinarily accessed through a symbolic
1185link, and you may want Emacs to preferentially display its ``linked''
1186name instead of its truename. To do this, customize the variable
1187@code{directory-abbrev-alist}. Each element in this list should have
1188the form @code{(@var{from} . @var{to})}, which says to replace
1189@var{from} with @var{to} when it appears in a directory name. For
1190this feature to work properly, @var{from} and @var{to} should point to
1191the same file. The @var{from} string is actually a regular expression
1192(@pxref{Regexps}); it should always start with @samp{\`}, to avoid
1193matching to an incorrect part of the original directory name. The
1194@var{to} string should be an ordinary absolute directory name. Do not
1195use @samp{~} to stand for a home directory in the @var{to} string;
1196Emacs performs these substitutions separately.
1197
1198 Here's an example, from a system on which file system
1199@file{/home/fsf} and so on are normally accessed through symbolic
1200links named @file{/fsf} and so on.
1201
1202@example
1203(("\\`/home/fsf" . "/fsf")
1204 ("\\`/home/gd" . "/gd"))
1205@end example
1206
1183@node Directories 1207@node Directories
1184@section File Directories 1208@section File Directories
1185 1209
diff --git a/doc/emacs/msdog.texi b/doc/emacs/msdog.texi
index 514ef956dc3..caa1bbccd19 100644
--- a/doc/emacs/msdog.texi
+++ b/doc/emacs/msdog.texi
@@ -90,20 +90,24 @@ Via the Emacs client program, @file{emacsclient.exe} or
90programs, and to reuse a running Emacs process for serving editing 90programs, and to reuse a running Emacs process for serving editing
91jobs required by other programs. @xref{Emacs Server}. The difference 91jobs required by other programs. @xref{Emacs Server}. The difference
92between @file{emacsclient.exe} and @file{emacsclientw.exe} is that the 92between @file{emacsclient.exe} and @file{emacsclientw.exe} is that the
93former waits for Emacs to signal that the editing job is finished, 93former is a console program, while the latter is a Windows GUI
94while the latter does not wait. Which one of them to use in each case 94program. Both programs wait for Emacs to signal that the editing job
95depends on the expectations of the program that needs editing 95is finished, before they exit and return control to the program that
96services. If the program will use the edited files, it needs to wait 96invoked them. Which one of them to use in each case depends on the
97for Emacs, so you should use @file{emacsclient.exe}. By contrast, if 97expectations of the program that needs editing services. If that
98the results of editing are not needed by the invoking program, you 98program is itself a console (text-mode) program, you should use
99will be better off using @file{emacsclientw.exe}. A notable situation 99@file{emacsclient.exe}, so that any of its messages and prompts appear
100where you would want @file{emacsclientw.exe} is when you right-click 100in the same command window as those of the invoking program. By
101on a file in the Windows Explorer and select ``Open With'' from the 101contrast, if the invoking program is a GUI program, you will be better
102pop-up menu. Use the @samp{--alternate-editor=} or @samp{-a} options 102off using @file{emacsclientw.exe}, because @file{emacsclient.exe} will
103if Emacs might not be running (or not running as a server) when 103pop up a command window if it is invoked from a GUI program. A
104@command{emacsclient} is invoked---that will always give you an 104notable situation where you would want @file{emacsclientw.exe} is when
105editor. When invoked via @command{emacsclient}, Emacs will start in 105you right-click on a file in the Windows Explorer and select ``Open
106the current directory of the program that invoked 106With'' from the pop-up menu. Use the @samp{--alternate-editor=} or
107@samp{-a} options if Emacs might not be running (or not running as a
108server) when @command{emacsclient} is invoked---that will always give
109you an editor. When invoked via @command{emacsclient}, Emacs will
110start in the current directory of the program that invoked
107@command{emacsclient}. 111@command{emacsclient}.
108@end enumerate 112@end enumerate
109 113
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 1cff2853a27..e1180124c05 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,13 @@
12011-01-08 Chong Yidong <cyd@stupidchicken.com>
2
3 * files.texi (Directory Names): Move directory-abbrev-alist doc to
4 Emacs manual.
5
62011-01-07 Eli Zaretskii <eliz@gnu.org>
7
8 * files.texi (Directory Names): Explain why FROM in
9 directory-abbrev-alist should begin with \`. (Bug#7777)
10
12010-12-25 Eli Zaretskii <eliz@gnu.org> 112010-12-25 Eli Zaretskii <eliz@gnu.org>
2 12
3 * modes.texi (Emulating Mode Line): Fix last change. 13 * modes.texi (Emulating Mode Line): Fix last change.
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index c2e057783c5..1f66da98347 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1920,51 +1920,22 @@ Don't try concatenating a slash by hand, as in
1920because this is not portable. Always use 1920because 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
1925normally accessed through symbolic links. Sometimes the users recognize
1926primarily the link's name as ``the name'' of the directory, and find it
1927annoying to see the directory's ``real'' name. If you define the link
1928name as an abbreviation for the ``real'' name, Emacs shows users the
1929abbreviation instead.
1930
1931@defopt directory-abbrev-alist
1932The variable @code{directory-abbrev-alist} contains an alist of
1933abbreviations 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. The @var{from} string is
1936actually a regular expression; it should always start with @samp{\`}.
1937The @var{to} string should be an ordinary absolute directory name. Do
1938not use @samp{~} to stand for a home directory in that string. The
1939function @code{abbreviate-file-name} performs these substitutions.
1940
1941You can set this variable in @file{site-init.el} to describe the
1942abbreviations appropriate for your site.
1943
1944Here's an example, from a system on which file system @file{/home/fsf}
1945and so on are normally accessed through symbolic links named @file{/fsf}
1946and so on.
1947
1948@example
1949(("\\`/home/fsf" . "/fsf")
1950 ("\\`/home/gp" . "/gp")
1951 ("\\`/home/gd" . "/gd"))
1952@end example
1953@end defopt
1954
1955 To convert a directory name to its abbreviation, use this 1923 To convert a directory name to its abbreviation, use this
1956function: 1924function:
1957 1925
1958@defun abbreviate-file-name filename 1926@defun abbreviate-file-name filename
1959@anchor{Definition of abbreviate-file-name} 1927@anchor{Definition of abbreviate-file-name}
1960This function applies abbreviations from @code{directory-abbrev-alist} 1928This function returns an abbreviated form of @var{filename}. It
1961to its argument, and also substitutes @samp{~} for the user's home 1929applies the abbreviations specified in @code{directory-abbrev-alist}
1962directory if the argument names a file in the home directory or one of 1930(@pxref{File Aliases,,File Aliases, emacs, The GNU Emacs Manual}),
1963its subdirectories. (If the home directory is a root directory, it is 1931then substitutes @samp{~} for the user's home directory if the
1964not replaced with @samp{~}, because this does not make the result 1932argument names a file in the home directory or one of its
1965shorter on many systems.) You can use it for directory names and for 1933subdirectories. If the home directory is a root directory, it is not
1966file names, because it recognizes abbreviations even as part of the 1934replaced with @samp{~}, because this does not make the result shorter
1967name. 1935on many systems.
1936
1937You can use this function for directory names and for file names,
1938because it recognizes abbreviations even as part of the name.
1968@end defun 1939@end defun
1969 1940
1970@node File Name Expansion 1941@node File Name Expansion