From 74e0eab0c5ad04a0c8f218c11da421724465bc79 Mon Sep 17 00:00:00 2001 From: Christian Egli Date: Wed, 27 May 2020 17:51:37 +0200 Subject: [PATCH] Mention the dotfiles option in the manual This should have been part of 182acbbb64425bf95008cb6d42d266f6185032c9 when the option was first added. This commit basically just copies the help text from stow.in into the texinfo manual. --- doc/stow.texi | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/stow.texi b/doc/stow.texi index febc11c..0b00860 100644 --- a/doc/stow.texi +++ b/doc/stow.texi @@ -358,6 +358,24 @@ pages that are owned by stow and would otherwise cause a conflict. The regular expression is anchored to the beginning of the path relative to the target directory, because this is what you will want to do most of the time. +@cindex dotfiles +@item --dotfiles + +Enable special handling for @emph{dotfiles} (files or folders whose +name begins with a period) in the package directory. If this option is +enabled, Stow will add a preprocessing step for each file or folder +whose name begins with @samp{dot-}, and replace the @samp{dot-} prefix +in the name by a period @samp{.}. This is useful when Stow is used to +manage collections of dotfiles, to avoid having a package directory +full of hidden files. + +For example, suppose we have a package containing two files, +@file{stow/dot-bashrc} and @file{stow/dot-emacs.d/init.el}. With this +option, Stow will create symlinks from @file{.bashrc} to +@file{stow/dot-bashrc} and from @file{.emacs.d/init.el} to +@file{stow/dot-emacs.d/init.el}. Any other files, whose name does not +begin with @samp{dot-}, will be processed as usual. + @item --no-folding This disables any further tree folding (@pxref{tree folding}) or