diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/usage/common-options.rst.inc | 2 | ||||
| -rw-r--r-- | docs/usage/compact.rst.inc | 2 | ||||
| -rw-r--r-- | docs/usage/create.rst.inc | 3 | ||||
| -rw-r--r-- | docs/usage/delete.rst.inc | 5 | ||||
| -rw-r--r-- | docs/usage/help.rst.inc | 2 | ||||
| -rw-r--r-- | docs/usage/prune.rst.inc | 6 |
6 files changed, 16 insertions, 4 deletions
diff --git a/docs/usage/common-options.rst.inc b/docs/usage/common-options.rst.inc index 10966b69e..e6e723ff0 100644 --- a/docs/usage/common-options.rst.inc +++ b/docs/usage/common-options.rst.inc @@ -14,7 +14,7 @@ --umask M set umask to M (local only, default: 0077) --remote-path PATH use PATH as borg executable on the remote (default: "borg") --remote-ratelimit RATE set remote network upload rate limit in kiByte/s (default: 0=unlimited) ---remote-buffer UPLOAD_BUFFER set upload buffer size in MiB. (default: 0=no buffer) +--remote-buffer UPLOAD_BUFFER set upload buffer size in MiB. (default: 0=no buffer) --consider-part-files treat part files like normal files (e.g. to list/extract them) --debug-profile FILE Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof". --rsh RSH Use this command to connect to the 'borg serve' process (default: 'ssh') diff --git a/docs/usage/compact.rst.inc b/docs/usage/compact.rst.inc index 01ae8e0fd..3d67fe5d3 100644 --- a/docs/usage/compact.rst.inc +++ b/docs/usage/compact.rst.inc @@ -66,7 +66,7 @@ Depending on the amount of segments that need compaction, it may take a while, so consider using the ``--progress`` option. A segment is compacted if the amount of saved space is above the percentage value -given by the ``--threshold`` option. If ommitted, a threshold of 10% is used. +given by the ``--threshold`` option. If omitted, a threshold of 10% is used. When using ``--verbose``, borg will output an estimate of the freed space. After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits`` diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index f2b01b59a..eeead2f7c 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -89,6 +89,8 @@ borg create +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--noflags`` | do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--sparse`` | detect sparse holes in input (supported only by fixed chunker) | + +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--files-cache MODE`` | operate files cache in MODE. default: ctime,size,inode | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--read-special`` | open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files. | @@ -162,6 +164,7 @@ borg create --nobirthtime do not store birthtime (creation date) into archive --nobsdflags deprecated, use ``--noflags`` instead --noflags do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive + --sparse detect sparse holes in input (supported only by fixed chunker) --files-cache MODE operate files cache in MODE. default: ctime,size,inode --read-special open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files. diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 060f5e76d..e058804f1 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -23,6 +23,8 @@ borg delete +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--list`` | output verbose list of archives | + +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-s``, ``--stats`` | print statistics for the deleted archive | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--cache-only`` | delete only the local cache for the given repository | @@ -68,6 +70,7 @@ borg delete optional arguments -n, --dry-run do not change repository + --list output verbose list of archives -s, --stats print statistics for the deleted archive --cache-only delete only the local cache for the given repository --force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. @@ -99,6 +102,8 @@ When you delete a complete repository, the security info and local cache for it with the ``--cache-only`` option, or keep the security info with the ``--keep-security-info`` option. +When in doubt, use ``--dry-run --list`` to see what would be deleted. + When using ``--stats``, you will get some statistics about how much data was deleted - the "Deleted data" deduplicated size there is most interesting as that is how much your repository will shrink. diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index 6f8ffea49..71fd24700 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -156,7 +156,7 @@ Examples:: Via ``--pattern`` or ``--patterns-from`` you can define BOTH inclusion and exclusion of files using pattern prefixes ``+`` and ``-``. With ``--exclude`` and - ``--exlude-from`` ONLY excludes are defined. + ``--exclude-from`` ONLY excludes are defined. Inclusion patterns are useful to include paths that are contained in an excluded path. The first matching pattern is used so if an include pattern matches before diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index ffe48429c..808577327 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -134,7 +134,11 @@ The rules are applied from secondly to yearly, and backups selected by previous rules do not count towards those of later rules. The time that each backup starts is used for pruning purposes. Dates and times are interpreted in the local timezone, and weeks go from Monday to Sunday. Specifying a -negative number of archives to keep means that there is no limit. +negative number of archives to keep means that there is no limit. As of borg +1.2.0, borg will retain the oldest archive if any of the secondly, minutely, +hourly, daily, weekly, monthly, or yearly rules was not otherwise able to meet +its retention target. This enables the first chronological archive to continue +aging until it is replaced by a newer archive that meets the retention criteria. The ``--keep-last N`` option is doing the same as ``--keep-secondly N`` (and it will keep the last N archives under the assumption that you do not create more than one |