From 5abd133e26fca7173662c6adaa83dfdc61cfc8b0 Mon Sep 17 00:00:00 2001 From: rawtaz Date: Wed, 14 Feb 2018 02:03:04 +0100 Subject: [PATCH] Restructure and complement exclude options doc --- doc/040_backup.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/040_backup.rst b/doc/040_backup.rst index c5f6de0de..b03c21de2 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -75,8 +75,16 @@ Now is a good time to run ``restic check`` to verify that all data is properly stored in the repository. You should run this command regularly to make sure the internal structure of the repository is free of errors. -You can exclude folders and files by specifying exclude-patterns. Either -specify them with multiple ``--exclude``'s or one ``--exclude-file`` +You can exclude folders and files by specifying exclude patterns, currently +the exclude options are: + +- ``--exclude`` Specified one or more times to exclude one or more items +- ``--exclude-caches`` Specified once to exclude folders containing a special file +- ``--exclude-file`` Specified one time to exclude items listed in a given file +- ``--exclude-if-present`` Specified one or more times to exclude a folders content + if it contains a given file (optionally having a given header) + +Basic example: .. code-block:: console @@ -87,6 +95,8 @@ specify them with multiple ``--exclude``'s or one ``--exclude-file`` foo/**/bar $ restic -r /tmp/backup backup ~/work --exclude=*.c --exclude-file=exclude +Please see ``restic help backup`` for more specific information about each exclude option. + Patterns use `filepath.Glob `__ internally, see `filepath.Match `__ for syntax. Patterns are tested against the full path of a file/dir to be saved, not only