aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2018-01-27 13:17:24 +0200
committerEli Zaretskii2018-01-27 13:17:24 +0200
commit372fda682a2a80f4cf946dfa6d57853a68b6982e (patch)
tree4a0706b13a67bdef287df2deebc1dd005c887765
parent9afc86d1face8dfe738b1792a752124b1168b277 (diff)
downloademacs-372fda682a2a80f4cf946dfa6d57853a68b6982e.tar.gz
emacs-372fda682a2a80f4cf946dfa6d57853a68b6982e.zip
Improve the "Files" chapter of the Emacs manual
* doc/emacs/files.texi (File Shadowing): Rearrange text to explain the notion of shadowing before describing the commands. Suggested by Will Korteland <emacs-devel@korte.land> in emacs-manual-bugs@gnu.org.
-rw-r--r--doc/emacs/files.texi46
1 files changed, 24 insertions, 22 deletions
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index 586086dda28..f6813a4aee9 100644
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -824,6 +824,25 @@ diff-buffer-with-file} command. @xref{Comparing Files}.
824@cindex file shadows 824@cindex file shadows
825@findex shadow-initialize 825@findex shadow-initialize
826 826
827 You can arrange to keep identical @dfn{shadow} copies of certain
828files in more than one place---possibly on different machines. To do
829this, first you must set up a @dfn{shadow file group}, which is a set
830of identically-named files shared between a list of sites. The file
831group is permanent and applies to further Emacs sessions as well as
832the current one. Once the group is set up, every time you exit Emacs,
833it will copy the file you edited to the other files in its group. You
834can also do the copying without exiting Emacs, by typing @w{@kbd{M-x
835shadow-copy-files}}.
836
837@cindex shadow cluster
838A @dfn{shadow cluster} is a group of hosts that share directories, so
839that copying to or from one of them is sufficient to update the file
840on all of them. Each shadow cluster has a name, and specifies the
841network address of a primary host (the one we copy files to), and a
842regular expression that matches the host names of all the other hosts
843in the cluster. You can define a shadow cluster with @w{@kbd{M-x
844shadow-define-cluster}}.
845
827@table @kbd 846@table @kbd
828@item M-x shadow-initialize 847@item M-x shadow-initialize
829Set up file shadowing. 848Set up file shadowing.
@@ -839,32 +858,15 @@ Copy all pending shadow files.
839Cancel the instruction to shadow some files. 858Cancel the instruction to shadow some files.
840@end table 859@end table
841 860
842You can arrange to keep identical @dfn{shadow} copies of certain files 861To set up a shadow file group, use @w{@kbd{M-x
843in more than one place---possibly on different machines. To do this, 862shadow-define-literal-group}} or @w{@kbd{M-x
844first you must set up a @dfn{shadow file group}, which is a set of 863shadow-define-regexp-group}}. See their documentation strings for
845identically-named files shared between a list of sites. The file 864further information.
846group is permanent and applies to further Emacs sessions as well as
847the current one. Once the group is set up, every time you exit Emacs,
848it will copy the file you edited to the other files in its group. You
849can also do the copying without exiting Emacs, by typing @kbd{M-x
850shadow-copy-files}.
851
852To set up a shadow file group, use @kbd{M-x
853shadow-define-literal-group} or @kbd{M-x shadow-define-regexp-group}.
854See their documentation strings for further information.
855 865
856Before copying a file to its shadows, Emacs asks for confirmation. 866Before copying a file to its shadows, Emacs asks for confirmation.
857You can answer ``no'' to bypass copying of this file, this time. If 867You can answer ``no'' to bypass copying of this file, this time. If
858you want to cancel the shadowing permanently for a certain file, use 868you want to cancel the shadowing permanently for a certain file, use
859@kbd{M-x shadow-cancel} to eliminate or change the shadow file group. 869@w{@kbd{M-x shadow-cancel}} to eliminate or change the shadow file group.
860
861A @dfn{shadow cluster} is a group of hosts that share directories, so
862that copying to or from one of them is sufficient to update the file
863on all of them. Each shadow cluster has a name, and specifies the
864network address of a primary host (the one we copy files to), and a
865regular expression that matches the host names of all the other hosts
866in the cluster. You can define a shadow cluster with @kbd{M-x
867shadow-define-cluster}.
868 870
869@node Time Stamps 871@node Time Stamps
870@subsection Updating Time Stamps Automatically 872@subsection Updating Time Stamps Automatically