summaryrefslogtreecommitdiff
path: root/man/7
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2010-03-27 19:43:25 +0100
committerDaniel Friesel <derf@derf.homelinux.org>2010-03-27 19:43:25 +0100
commit06e95a7635c559a631515683a9dbfaeee8cda0c7 (patch)
tree7f2e6490d382e59e1b72202629a3150438542491 /man/7
parent5eab75f69c3a816489e0ee3bbd60e0b53d833bb3 (diff)
Treat etc/ special: automatically "install" the dotfiles in it
Diffstat (limited to 'man/7')
-rw-r--r--man/7/caretaker-setup.pod1
-rw-r--r--man/7/caretaker.pod14
2 files changed, 10 insertions, 5 deletions
diff --git a/man/7/caretaker-setup.pod b/man/7/caretaker-setup.pod
index 4e64b4b..75554cd 100644
--- a/man/7/caretaker-setup.pod
+++ b/man/7/caretaker-setup.pod
@@ -31,7 +31,6 @@ this in the package root itself, since it's recommended to have bare git repos t
Initialized empty Git repository in /tmp/vim/.git/
client /tmp/vim > mkdir etc
client /tmp/vim > cp $your_fancy_vimrc etc/vimrc
- client /tmp/vim > echo 'soft .vimrc $etc/vimrc' > links
client /tmp/vim > git add .
client /tmp/vim > git commit -m 'initial commit. Now with extra cake'
[master (root-commit) 4359548] initial commit. Now with extra cake
diff --git a/man/7/caretaker.pod b/man/7/caretaker.pod
index 488a870..95b03ab 100644
--- a/man/7/caretaker.pod
+++ b/man/7/caretaker.pod
@@ -105,7 +105,13 @@ a manual will be generated out of it (see L</"COLLECTED PACKAGE FILES">)
=item etc/
-Configuration files, not treated specially though
+Configuration files. Unless your package contains a links file, all files in
+this directory (or, if it contains dotfiles, only the dotfiles) will
+automatically symlinked as dotfiles from your home using checklinks(1).
+So, for example F<etc/vimrc> will be installed as F<~/.vimrc>.
+
+If you do not want this behaviour, create an empty links file.
+To disable it for all packages, set MAGIC_ETC=0.
=item hooks/
@@ -117,11 +123,11 @@ Manual files, separated by section (like man/7/caretaker.pod).
Files with valid POD will be processed with pod2man, all other files which do
not have a .pod suffix are assumed to be *roff source and directly put into
the manual directory (with a symlink).
-See also L</"COLLECTED PACKAGE FILES">.
+See also L</"COLLECTED PACKAGE FILES">
=item provides/
-Files for inclusion into other packages. See L</"PROVIDES">
+Files for inclusion into other packages. See L</"PROVIDES">
=item description
@@ -129,7 +135,7 @@ Package description for B<ct info>
=item links
-Sym- and hardlink descriptions. See checklinks(1)
+Manual sym- and hardlink definitions. See checklinks(1)
=item Makefile