From 9f61747dae65d96f7eeaabd5c2a0b8ad40b40b13 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 27 Aug 2017 22:17:55 +0200 Subject: [PATCH] python setup.py build_usage --- docs/usage/create.rst.inc | 3 +++ docs/usage/info.rst.inc | 9 +++++++-- docs/usage/list.rst.inc | 4 ++-- docs/usage/with-lock.rst.inc | 5 +++-- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index c70e2a8f1..3fc59dff4 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -193,6 +193,9 @@ only include the objects specified by ``--exclude-if-present`` in your backup, and not include any other contents of the containing folder, this can be enabled through using the ``--keep-exclude-tags`` option. +Borg respects the nodump flag. Files flagged nodump will be marked as excluded (x) +in ``--list`` output. + Item flags ++++++++++ diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index ec5d15098..5ba601f4f 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -77,6 +77,11 @@ up to the deduplicated size of the repository ("all archives"), because the two are meaning different things: This archive / deduplicated size = amount of data stored ONLY for this archive - = unique chunks of this archive. += unique chunks of this archive. All archives / deduplicated size = amount of data stored in the repo - = all chunks in the repository. \ No newline at end of file += all chunks in the repository. + +Borg archives can only contain a limited amount of file metadata. +The size of an archive relative to this limit depends on a number of factors, +mainly the number of files, the lengths of paths and other metadata stored for files. +This is shown as *utilization of maximum supported archive size*. \ No newline at end of file diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index 3358a74bf..e6b898884 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -23,7 +23,7 @@ borg list +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--short`` | only print file/directory names, nothing else | +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | ``--format FORMAT``, ``--list-format FORMAT`` | specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}") | + | | ``--format FORMAT``, ``--list-format FORMAT`` | specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {mtime} {path}{extra}{NL}") | +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--json`` | Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available. | +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -80,7 +80,7 @@ borg list optional arguments --short only print file/directory names, nothing else - --format FORMAT, --list-format FORMAT specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}") + --format FORMAT, --list-format FORMAT specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {mtime} {path}{extra}{NL}") --json Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available. --json-lines Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available. diff --git a/docs/usage/with-lock.rst.inc b/docs/usage/with-lock.rst.inc index fc4541164..6f4fc741a 100644 --- a/docs/usage/with-lock.rst.inc +++ b/docs/usage/with-lock.rst.inc @@ -60,5 +60,6 @@ code as borg's return code. .. note:: If you copy a repository with the lock held, the lock will be present in - the copy, obviously. Thus, before using borg on the copy, you need to - use "borg break-lock" on it. \ No newline at end of file + the copy. Thus, before using borg on the copy from a different host, + you need to use "borg break-lock" on the copied repository, because + Borg is cautious and does not automatically remove stale locks made by a different host. \ No newline at end of file