diff options
| author | Eli Zaretskii | 2018-01-27 13:17:24 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2018-01-27 13:17:24 +0200 |
| commit | 372fda682a2a80f4cf946dfa6d57853a68b6982e (patch) | |
| tree | 4a0706b13a67bdef287df2deebc1dd005c887765 | |
| parent | 9afc86d1face8dfe738b1792a752124b1168b277 (diff) | |
| download | emacs-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.texi | 46 |
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 | ||
| 828 | files in more than one place---possibly on different machines. To do | ||
| 829 | this, first you must set up a @dfn{shadow file group}, which is a set | ||
| 830 | of identically-named files shared between a list of sites. The file | ||
| 831 | group is permanent and applies to further Emacs sessions as well as | ||
| 832 | the current one. Once the group is set up, every time you exit Emacs, | ||
| 833 | it will copy the file you edited to the other files in its group. You | ||
| 834 | can also do the copying without exiting Emacs, by typing @w{@kbd{M-x | ||
| 835 | shadow-copy-files}}. | ||
| 836 | |||
| 837 | @cindex shadow cluster | ||
| 838 | A @dfn{shadow cluster} is a group of hosts that share directories, so | ||
| 839 | that copying to or from one of them is sufficient to update the file | ||
| 840 | on all of them. Each shadow cluster has a name, and specifies the | ||
| 841 | network address of a primary host (the one we copy files to), and a | ||
| 842 | regular expression that matches the host names of all the other hosts | ||
| 843 | in the cluster. You can define a shadow cluster with @w{@kbd{M-x | ||
| 844 | shadow-define-cluster}}. | ||
| 845 | |||
| 827 | @table @kbd | 846 | @table @kbd |
| 828 | @item M-x shadow-initialize | 847 | @item M-x shadow-initialize |
| 829 | Set up file shadowing. | 848 | Set up file shadowing. |
| @@ -839,32 +858,15 @@ Copy all pending shadow files. | |||
| 839 | Cancel the instruction to shadow some files. | 858 | Cancel the instruction to shadow some files. |
| 840 | @end table | 859 | @end table |
| 841 | 860 | ||
| 842 | You can arrange to keep identical @dfn{shadow} copies of certain files | 861 | To set up a shadow file group, use @w{@kbd{M-x |
| 843 | in more than one place---possibly on different machines. To do this, | 862 | shadow-define-literal-group}} or @w{@kbd{M-x |
| 844 | first you must set up a @dfn{shadow file group}, which is a set of | 863 | shadow-define-regexp-group}}. See their documentation strings for |
| 845 | identically-named files shared between a list of sites. The file | 864 | further information. |
| 846 | group is permanent and applies to further Emacs sessions as well as | ||
| 847 | the current one. Once the group is set up, every time you exit Emacs, | ||
| 848 | it will copy the file you edited to the other files in its group. You | ||
| 849 | can also do the copying without exiting Emacs, by typing @kbd{M-x | ||
| 850 | shadow-copy-files}. | ||
| 851 | |||
| 852 | To set up a shadow file group, use @kbd{M-x | ||
| 853 | shadow-define-literal-group} or @kbd{M-x shadow-define-regexp-group}. | ||
| 854 | See their documentation strings for further information. | ||
| 855 | 865 | ||
| 856 | Before copying a file to its shadows, Emacs asks for confirmation. | 866 | Before copying a file to its shadows, Emacs asks for confirmation. |
| 857 | You can answer ``no'' to bypass copying of this file, this time. If | 867 | You can answer ``no'' to bypass copying of this file, this time. If |
| 858 | you want to cancel the shadowing permanently for a certain file, use | 868 | you 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 | |||
| 861 | A @dfn{shadow cluster} is a group of hosts that share directories, so | ||
| 862 | that copying to or from one of them is sufficient to update the file | ||
| 863 | on all of them. Each shadow cluster has a name, and specifies the | ||
| 864 | network address of a primary host (the one we copy files to), and a | ||
| 865 | regular expression that matches the host names of all the other hosts | ||
| 866 | in the cluster. You can define a shadow cluster with @kbd{M-x | ||
| 867 | shadow-define-cluster}. | ||
| 868 | 870 | ||
| 869 | @node Time Stamps | 871 | @node Time Stamps |
| 870 | @subsection Updating Time Stamps Automatically | 872 | @subsection Updating Time Stamps Automatically |