caretaker-setup(7): Document ../$etc/foo cases in the links file

1 files changed, 14 insertions, 0 deletions

diff --git a/man/7/caretaker-setup.pod b/man/7/caretaker-setup.pod
index 105528b..98affeb 100644
--- a/man/7/caretaker-setup.pod
+++ b/man/7/caretaker-setup.pod
@@ -55,3 +55,17 @@ Now you can install the vim package the normal way
   created   .vimrc          -> packages/vim/etc/vimrc
 
 And that's it. You can safely rm -rf /tmp/vim now.
+
+=head2 THE LINKS FILE
+
+Note that the '$etc' used in this example is a B<relative> symlink.
+So if you want to symlink something which is in a subdirectory of your home,
+you will have to set the target to C<< ../$etc/something >> (or similar).
+
+Example:
+
+  soft .ssh/config ../$etc/config
+
+=head1 SEE ALSO
+
+checklinks(1), ct(1), caretaker(7)