diff options
| -rw-r--r-- | README.rst | 16 |
1 files changed, 13 insertions, 3 deletions
@@ -149,9 +149,9 @@ glob file patterns. Packages -------- -Most recent programs store their configuration in ``~/.config``. It's quite -cluttered and you probably don't want to keep all its content in your -repository. For this situation you can use the ``packages`` setting:: +Many programs store their configuration in ``~/.config``. It's quite cluttered +and you probably don't want to keep all its content in your repository. For this +situation you can use the ``packages`` setting:: [dotfiles] packages = ['config'] @@ -161,6 +161,16 @@ your repository must be symlinked to ``~/.config``. If for example you have a directory ``config/awesome`` in your repository, it will be symlinked to ``~/.config/awesome``. +This feature allows one additional level of nesting, but further subdirectories +are not eligible for being a package. For example, ``config`` is valid, but +``config/transmission`` is not valid. Arbitrary nesting is a feature under +current consideration. + +At the moment, packages can not be added or removed through the command line +interface. They must be constructed and configured manually. Once this is +done, ``sync``, ``list``, ``check``, and ``move`` will do the right thing. +Support for ``add`` and ``remove`` is a current TODO item. + Contribute ---------- |