From be2bc78d693f8522caa1e828fd147e0b91b1cc76 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 10 Feb 2019 21:20:32 +0100 Subject: [PATCH] build_usage --- docs/usage/common-options.rst.inc | 1 + docs/usage/help.rst.inc | 4 ++-- docs/usage/init.rst.inc | 37 +++++++++++++++++-------------- docs/usage/mount.rst.inc | 8 +++++-- 4 files changed, 29 insertions(+), 21 deletions(-) diff --git a/docs/usage/common-options.rst.inc b/docs/usage/common-options.rst.inc index f6e191b0b..07ce07a5b 100644 --- a/docs/usage/common-options.rst.inc +++ b/docs/usage/common-options.rst.inc @@ -15,3 +15,4 @@ --remote-ratelimit RATE set remote network upload rate limit in kiByte/s (default: 0=unlimited) --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/help.rst.inc b/docs/usage/help.rst.inc index bef625f54..92ad68cd7 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -31,7 +31,7 @@ two alphanumeric characters followed by a colon (i.e. `aa:something/*`). any number of characters, '?' matching any single character, '[...]' matching any single character specified, including ranges, and '[!...]' matching any character not specified. For the purpose of these patterns, - the path separator ('\' for Windows and '/' on other systems) is not + the path separator (backslash for Windows and '/' on other systems) is not treated specially. Wrap meta-characters in brackets for a literal match (i.e. `[?]` to match the literal character `?`). For a path to match a pattern, the full path must match, or it must match @@ -52,7 +52,7 @@ Regular expressions, selector `re:` shell patterns regular expressions are not required to match the full path and any substring match is sufficient. It is strongly recommended to anchor patterns to the start ('^'), to the end ('$') or both. Path - separators ('\' for Windows and '/' on other systems) in paths are + separators (backslash for Windows and '/' on other systems) in paths are always normalized to a forward slash ('/') before applying a pattern. The regular expression syntax is described in the `Python documentation for the re module `_. diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 68437e57f..a3144e7b2 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -12,23 +12,25 @@ borg init .. class:: borg-options-table - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | **positional arguments** | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | | ``REPOSITORY`` | repository to create | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | **optional arguments** | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | | ``-e MODE``, ``--encryption MODE`` | select encryption key mode **(required)** | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | | ``--append-only`` | create an append-only mode repository | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | | ``--storage-quota QUOTA`` | Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ - | .. class:: borg-common-opt-ref | - | | - | :ref:`common_options` | - +-------------------------------------------------------+------------------------------------+-----------------------------------------------------------------------------+ + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | **positional arguments** | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | | ``REPOSITORY`` | repository to create | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | **optional arguments** | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | | ``-e MODE``, ``--encryption MODE`` | select encryption key mode **(required)** | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | | ``--append-only`` | create an append-only mode repository | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | | ``--storage-quota QUOTA`` | Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | | ``--make-parent-dirs`` | create the parent directories of the repository directory, if they are missing. | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ + | .. class:: borg-common-opt-ref | + | | + | :ref:`common_options` | + +-------------------------------------------------------+------------------------------------+---------------------------------------------------------------------------------+ .. raw:: html @@ -48,6 +50,7 @@ borg init -e MODE, --encryption MODE select encryption key mode **(required)** --append-only create an append-only mode repository --storage-quota QUOTA Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. + --make-parent-dirs create the parent directories of the repository directory, if they are missing. :ref:`common_options` diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index ee7b80a07..2520f1ff2 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -113,14 +113,18 @@ used in fstab entries: To allow a regular user to use fstab entries, add the ``user`` option: ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0`` -For mount options, see the fuse(8) manual page. Additional mount options -supported by borg: +For FUSE configuration and mount options, see the mount.fuse(8) manual page. + +Additional mount options supported by borg: - versions: when used with a repository mount, this gives a merged, versioned view of the files in the archives. EXPERIMENTAL, layout may change in future. - allow_damaged_files: by default damaged files (where missing chunks were replaced with runs of zeros by borg check ``--repair``) are not readable and return EIO (I/O error). Set this option to read such files. +- ignore_permissions: for security reasons the "default_permissions" mount + option is internally enforced by borg. "ignore_permissions" can be given to + not enforce "default_permissions". The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users to tweak the performance. It sets the number of cached data chunks; additional