Merge pull request #2712 from enkore/docs/compact-opt

docs: use tables for options, with even widths.

docs/borg_theme/css/borg.css

@@ -119,17 +119,35 @@ table.docutils:not(.footnote) tr:last-child td {
 }
 
 table.docutils:not(.footnote) tr td:first-child,
-table.docutils:not(.footnote) tr th:first-child,
-table.docutils.option-list tr td {
+table.docutils:not(.footnote) tr th:first-child {
     border-left: 0;
 }
 
 table.docutils:not(.footnote) tr td:last-child,
 table.docutils:not(.footnote) tr th:last-child,
-table.docutils.option-list tr td {
+table.docutils.borg-options-table tr td {
     border-right: 0;
 }
 
+table.docutils.option-list tr td,
+table.docutils.borg-options-table tr td {
+    border-left: 0;
+    border-right: 0;
+}
+
+table.docutils.borg-options-table tr td:first-child:not([colspan="3"]) {
+    border-top: 0;
+    border-bottom: 0;
+}
+
+.borg-options-table td[colspan="3"] p {
+    margin: 0;
+}
+
+.borg-options-table {
+    width: 100%;
+}
+
 kbd, /* used in usage pages for options */
 code,
 .rst-content tt.literal,
@@ -153,12 +171,12 @@ kbd {
     font-family: Consolas, monospace;
 }
 
-kbd .option {
+.borg-options-table tr td:nth-child(2) .pre {
     white-space: nowrap;
 }
 
-table.docutils.option-list td.option-group {
-    min-width: 10em;
+.borg-options-table tr td:first-child {
+    width: 2em;
 }
 
 cite {

docs/usage/benchmark_crud.rst.inc

@@ -8,16 +8,40 @@ borg benchmark crud
 
     borg [common options] benchmark crud [options] REPO PATH
 
-REPO
-    repo to use for benchmark (must exist)
-PATH
-    path were to create benchmark input data
+.. only:: html
 
+    .. class:: borg-options-table
 
-.. class:: borg-common-opt-ref
+    +-------------------------------------------------------+----------+------------------------------------------+
+    | **positional arguments**                                                                                    |
+    +-------------------------------------------------------+----------+------------------------------------------+
+    |                                                       | ``REPO`` | repo to use for benchmark (must exist)   |
+    +-------------------------------------------------------+----------+------------------------------------------+
+    |                                                       | ``PATH`` | path were to create benchmark input data |
+    +-------------------------------------------------------+----------+------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                              |
+    |                                                                                                             |
+    | :ref:`common_options`                                                                                       |
+    +-------------------------------------------------------+----------+------------------------------------------+
 
-:ref:`common_options`
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPO
+        repo to use for benchmark (must exist)
+    PATH
+        path were to create benchmark input data
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/break-lock.rst.inc

@@ -8,14 +8,36 @@ borg break-lock
 
     borg [common options] break-lock [options] REPOSITORY
 
-REPOSITORY
-    repository for which to break the locks
+.. only:: html
 
+    .. class:: borg-options-table
 
-.. class:: borg-common-opt-ref
+    +-------------------------------------------------------+----------------+-----------------------------------------+
+    | **positional arguments**                                                                                         |
+    +-------------------------------------------------------+----------------+-----------------------------------------+
+    |                                                       | ``REPOSITORY`` | repository for which to break the locks |
+    +-------------------------------------------------------+----------------+-----------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                   |
+    |                                                                                                                  |
+    | :ref:`common_options`                                                                                            |
+    +-------------------------------------------------------+----------------+-----------------------------------------+
 
-:ref:`common_options`
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY
+        repository for which to break the locks
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/change-passphrase.rst.inc

@@ -8,14 +8,36 @@ borg change-passphrase
 
     borg [common options] change-passphrase [options] REPOSITORY
 
-REPOSITORY
+.. only:: html
 
+    .. class:: borg-options-table
 
+    +-------------------------------------------------------+----------------+--+
+    | **positional arguments**                                                  |
+    +-------------------------------------------------------+----------------+--+
+    |                                                       | ``REPOSITORY`` |  |
+    +-------------------------------------------------------+----------------+--+
+    | .. class:: borg-common-opt-ref                                            |
+    |                                                                           |
+    | :ref:`common_options`                                                     |
+    +-------------------------------------------------------+----------------+--+
 
-.. class:: borg-common-opt-ref
+    .. raw:: html
 
-:ref:`common_options`
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
+.. only:: latex
+
+    REPOSITORY
+
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/check.rst.inc

@@ -8,29 +8,75 @@ borg check
 
     borg [common options] check [options] REPOSITORY_OR_ARCHIVE
 
-REPOSITORY_OR_ARCHIVE
-    repository or archive to check consistency of
-
-
-optional arguments
-    --repository-only    only perform repository checks
-    --archives-only    only perform archives checks
-    --verify-data     perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
-    --repair          attempt to repair any inconsistencies found
-    --save-space      work slower, but using less space
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-    --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-    --first N               consider first N archives after other filters were applied
-    --last N                consider last N archives after other filters were applied
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``   | repository or archive to check consistency of                                                                                                          |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--repository-only``       | only perform repository checks                                                                                                                         |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--archives-only``         | only perform archives checks                                                                                                                           |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--verify-data``           | perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--repair``                | attempt to repair any inconsistencies found                                                                                                            |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--save-space``            | work slower, but using less space                                                                                                                      |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                               |
+    |                                                                                                                                                                                                                                              |
+    | :ref:`common_options`                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                  |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``        | only consider archive names starting with this prefix.                                                                                                 |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort-by``               | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--first N``               | consider first N archives after other filters were applied                                                                                             |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--last N``                | consider last N archives after other filters were applied                                                                                              |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY_OR_ARCHIVE
+        repository or archive to check consistency of
+
+
+    optional arguments
+        --repository-only    only perform repository checks
+        --archives-only    only perform archives checks
+        --verify-data     perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
+        --repair          attempt to repair any inconsistencies found
+        --save-space      work slower, but using less space
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N               consider first N archives after other filters were applied
+        --last N                consider last N archives after other filters were applied
 
 
 Description

docs/usage/create.rst.inc

@@ -8,51 +8,131 @@ borg create
 
     borg [common options] create [options] ARCHIVE PATH
 
-ARCHIVE
-    name of archive to create (must be also a valid directory name)
-PATH
-    paths to archive
-
-
-optional arguments
-    -n, --dry-run    do not create a backup archive
-    -s, --stats     print statistics for the created archive
-    --list          output verbose list of items (files, dirs, ...)
-    --filter STATUSCHARS    only display items with the given status characters
-    --json          output stats as JSON (implies --stats)
-    --no-cache-sync    experimental: do not synchronize the cache. Implies --no-files-cache.
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-Exclusion options
-    -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
-    --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
-    --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
-    --keep-exclude-tags, --keep-tag-files    if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
-    --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
-
-
-Filesystem options
-    -x, --one-file-system     stay in the same file system and do not store mount points of other file systems
-    --numeric-owner           only store numeric user and group identifiers
-    --noatime                 do not store atime into archive
-    --noctime                 do not store ctime into archive
-    --ignore-inode            ignore inode data in the file metadata cache used to detect unchanged files.
-    --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.
-
-
-Archive options
-    --comment COMMENT                             add a comment text to the archive
-    --timestamp TIMESTAMP                         manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
-    -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
-    --chunker-params PARAMS                       specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: 19,23,21,4095
-    -C COMPRESSION, --compression COMPRESSION     select compression algorithm, see the output of the "borg help compression" command for details.
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``ARCHIVE``                                       | name of archive to create (must be also a valid directory name)                                                                                   |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                                          | paths to archive                                                                                                                                  |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run``                             | do not create a backup archive                                                                                                                    |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-s``, ``--stats``                               | print statistics for the created archive                                                                                                          |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``                                        | output verbose list of items (files, dirs, ...)                                                                                                   |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--filter STATUSCHARS``                          | only display items with the given status characters                                                                                               |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--json``                                        | output stats as JSON. Implies ``--stats``.                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--no-cache-sync``                               | experimental: do not synchronize the cache. Implies ``--no-files-cache``.                                                                         |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                |
+    |                                                                                                                                                                                                                                                               |
+    | :ref:`common_options`                                                                                                                                                                                                                                         |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                                                         |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN``             | exclude paths matching PATTERN                                                                                                                    |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``                    | read exclude patterns from EXCLUDEFILE, one per line                                                                                              |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-caches``                              | exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)                                              |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-if-present NAME``                     | exclude directories that are tagged by containing a filesystem object with the given NAME                                                         |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-exclude-tags``, ``--keep-tag-files``     | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                         |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                             | experimental: include/exclude paths matching PATTERN                                                                                              |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``                   | experimental: read include/exclude patterns from PATTERNFILE, one per line                                                                        |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Filesystem options**                                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-x``, ``--one-file-system``                     | stay in the same file system and do not store mount points of other file systems                                                                  |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--numeric-owner``                               | only store numeric user and group identifiers                                                                                                     |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noatime``                                     | do not store atime into archive                                                                                                                   |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--noctime``                                     | do not store ctime into archive                                                                                                                   |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--ignore-inode``                                | ignore inode data in the file metadata cache used to detect unchanged files.                                                                      |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--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. |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Archive options**                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--comment COMMENT``                             | add a comment text to the archive                                                                                                                 |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--timestamp TIMESTAMP``                         | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.                |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800)                                                                                            |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--chunker-params PARAMS``                       | specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: 19,23,21,4095                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details.                                                  |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    ARCHIVE
+        name of archive to create (must be also a valid directory name)
+    PATH
+        paths to archive
+
+
+    optional arguments
+        -n, --dry-run    do not create a backup archive
+        -s, --stats     print statistics for the created archive
+        --list          output verbose list of items (files, dirs, ...)
+        --filter STATUSCHARS    only display items with the given status characters
+        --json          output stats as JSON. Implies ``--stats``.
+        --no-cache-sync    experimental: do not synchronize the cache. Implies ``--no-files-cache``.
+
+
+    :ref:`common_options`
+        |
+
+    Exclusion options
+        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
+        --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
+        --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
+        --keep-exclude-tags, --keep-tag-files    if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
+        --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
+
+
+    Filesystem options
+        -x, --one-file-system     stay in the same file system and do not store mount points of other file systems
+        --numeric-owner           only store numeric user and group identifiers
+        --noatime                 do not store atime into archive
+        --noctime                 do not store ctime into archive
+        --ignore-inode            ignore inode data in the file metadata cache used to detect unchanged files.
+        --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.
+
+
+    Archive options
+        --comment COMMENT                             add a comment text to the archive
+        --timestamp TIMESTAMP                         manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
+        -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
+        --chunker-params PARAMS                       specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: 19,23,21,4095
+        -C COMPRESSION, --compression COMPRESSION     select compression algorithm, see the output of the "borg help compression" command for details.
 
 
 Description

docs/usage/delete.rst.inc

@@ -8,28 +8,72 @@ borg delete
 
     borg [common options] delete [options] TARGET
 
-TARGET
-    archive or repository to delete
+.. only:: html
 
+    .. class:: borg-options-table
 
-optional arguments
-    -s, --stats     print statistics for the deleted archive
-    -c, --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.
-    --save-space    work slower, but using less space
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``TARGET``                  | archive or repository to delete                                                                                                                        |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-s``, ``--stats``         | print statistics for the deleted archive                                                                                                               |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-c``, ``--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.                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--save-space``            | work slower, but using less space                                                                                                                      |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                               |
+    |                                                                                                                                                                                                                                              |
+    | :ref:`common_options`                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                  |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``        | only consider archive names starting with this prefix.                                                                                                 |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort-by``               | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--first N``               | consider first N archives after other filters were applied                                                                                             |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--last N``                | consider last N archives after other filters were applied                                                                                              |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
 
+    .. raw:: html
 
-.. class:: borg-common-opt-ref
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
-:ref:`common_options`
+.. only:: latex
 
+    TARGET
+        archive or repository to delete
 
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-    --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-    --first N               consider first N archives after other filters were applied
-    --last N                consider last N archives after other filters were applied
+
+    optional arguments
+        -s, --stats     print statistics for the deleted archive
+        -c, --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.
+        --save-space    work slower, but using less space
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N               consider first N archives after other filters were applied
+        --last N                consider last N archives after other filters were applied
 
 
 Description

docs/usage/diff.rst.inc

@@ -8,33 +8,83 @@ borg diff
 
     borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 PATH
 
-REPO_ARCHIVE1
-    repository location and ARCHIVE1 name
-ARCHIVE2
-    ARCHIVE2 name (no repository location allowed)
-PATH
-    paths of items inside the archives to compare; patterns are supported
-
-
-optional arguments
-    --numeric-owner    only consider numeric user and group identifiers
-    --same-chunker-params    Override check of chunker parameters.
-    --sort     Sort the output lines by file path.
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-Exclusion options
-    -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
-    --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
-    --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
-    --keep-exclude-tags, --keep-tag-files    if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
-    --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                          |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPO_ARCHIVE1``                             | repository location and ARCHIVE1 name                                                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``ARCHIVE2``                                  | ARCHIVE2 name (no repository location allowed)                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                                      | paths of items inside the archives to compare; patterns are supported                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--numeric-owner``                           | only consider numeric user and group identifiers                                                                          |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--same-chunker-params``                     | Override check of chunker parameters.                                                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort``                                    | Sort the output lines by file path.                                                                                       |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                    |
+    |                                                                                                                                                                                                                                   |
+    | :ref:`common_options`                                                                                                                                                                                                             |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                             |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN``         | exclude paths matching PATTERN                                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``                | read exclude patterns from EXCLUDEFILE, one per line                                                                      |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-caches``                          | exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)                      |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-if-present NAME``                 | exclude directories that are tagged by containing a filesystem object with the given NAME                                 |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-exclude-tags``, ``--keep-tag-files`` | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                         | experimental: include/exclude paths matching PATTERN                                                                      |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``               | experimental: read include/exclude patterns from PATTERNFILE, one per line                                                |
+    +-------------------------------------------------------+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPO_ARCHIVE1
+        repository location and ARCHIVE1 name
+    ARCHIVE2
+        ARCHIVE2 name (no repository location allowed)
+    PATH
+        paths of items inside the archives to compare; patterns are supported
+
+
+    optional arguments
+        --numeric-owner    only consider numeric user and group identifiers
+        --same-chunker-params    Override check of chunker parameters.
+        --sort     Sort the output lines by file path.
+
+
+    :ref:`common_options`
+        |
+
+    Exclusion options
+        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
+        --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
+        --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
+        --keep-exclude-tags, --keep-tag-files    if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
+        --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
 
 
 Description

docs/usage/export-tar.rst.inc

@@ -8,28 +8,70 @@ borg export-tar
 
     borg [common options] export-tar [options] ARCHIVE FILE PATH
 
-ARCHIVE
-    archive to export
-FILE
-    output tar file. "-" to write to stdout instead.
-PATH
-    paths to extract; patterns are supported
-
-
-optional arguments
-    --tar-filter                      filter program to pipe data through
-    --list                            output verbose list of items (files, dirs, ...)
-    -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
-    --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
-    --strip-components NUMBER         Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                      |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``ARCHIVE``                           | archive to export                                                                                             |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``FILE``                              | output tar file. "-" to write to stdout instead.                                                              |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                              | paths to extract; patterns are supported                                                                      |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--tar-filter``                      | filter program to pipe data through                                                                           |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``                            | output verbose list of items (files, dirs, ...)                                                               |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN                                                                                |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``        | read exclude patterns from EXCLUDEFILE, one per line                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                 | experimental: include/exclude paths matching PATTERN                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``       | experimental: read include/exclude patterns from PATTERNFILE, one per line                                    |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--strip-components NUMBER``         | Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                |
+    |                                                                                                                                                                                                               |
+    | :ref:`common_options`                                                                                                                                                                                         |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    ARCHIVE
+        archive to export
+    FILE
+        output tar file. "-" to write to stdout instead.
+    PATH
+        paths to extract; patterns are supported
+
+
+    optional arguments
+        --tar-filter                      filter program to pipe data through
+        --list                            output verbose list of items (files, dirs, ...)
+        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
+        --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
+        --strip-components NUMBER         Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/extract.rst.inc

@@ -8,29 +8,75 @@ borg extract
 
     borg [common options] extract [options] ARCHIVE PATH
 
-ARCHIVE
-    archive to extract
-PATH
-    paths to extract; patterns are supported
+.. only:: html
 
+    .. class:: borg-options-table
 
-optional arguments
-    --list            output verbose list of items (files, dirs, ...)
-    -n, --dry-run     do not actually change any files
-    -e PATTERN, --exclude PATTERN    exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE    read exclude patterns from EXCLUDEFILE, one per line
-    --pattern PATTERN    experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE    experimental: read include/exclude patterns from PATTERNFILE, one per line
-    --numeric-owner    only obey numeric user and group identifiers
-    --strip-components NUMBER    Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
-    --stdout          write all extracted data to stdout
-    --sparse          create holes in output sparse file from all-zero chunks
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                      |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``ARCHIVE``                           | archive to extract                                                                                            |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                              | paths to extract; patterns are supported                                                                      |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``                            | output verbose list of items (files, dirs, ...)                                                               |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run``                 | do not actually change any files                                                                              |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN                                                                                |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``        | read exclude patterns from EXCLUDEFILE, one per line                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                 | experimental: include/exclude paths matching PATTERN                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``       | experimental: read include/exclude patterns from PATTERNFILE, one per line                                    |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--numeric-owner``                   | only obey numeric user and group identifiers                                                                  |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--strip-components NUMBER``         | Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--stdout``                          | write all extracted data to stdout                                                                            |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sparse``                          | create holes in output sparse file from all-zero chunks                                                       |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                |
+    |                                                                                                                                                                                                               |
+    | :ref:`common_options`                                                                                                                                                                                         |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------+
 
+    .. raw:: html
 
-.. class:: borg-common-opt-ref
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
-:ref:`common_options`
+.. only:: latex
 
+    ARCHIVE
+        archive to extract
+    PATH
+        paths to extract; patterns are supported
+
+
+    optional arguments
+        --list            output verbose list of items (files, dirs, ...)
+        -n, --dry-run     do not actually change any files
+        -e PATTERN, --exclude PATTERN    exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE    read exclude patterns from EXCLUDEFILE, one per line
+        --pattern PATTERN    experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE    experimental: read include/exclude patterns from PATTERNFILE, one per line
+        --numeric-owner    only obey numeric user and group identifiers
+        --strip-components NUMBER    Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
+        --stdout          write all extracted data to stdout
+        --sparse          create holes in output sparse file from all-zero chunks
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/help.rst.inc

@@ -32,7 +32,7 @@ two alphanumeric characters followed by a colon (i.e. `aa:something/*`).
     separator, a '\*' is appended before matching is attempted.
 
 Shell-style patterns, selector `sh:`
-    This is the default style for --pattern and --patterns-from.
+    This is the default style for ``--pattern`` and ``--patterns-from``.
     Like fnmatch patterns these are similar to shell patterns. The difference
     is that the pattern may include `**/` for matching zero or more directory
     levels, `*` for matching zero or more arbitrary characters with the

docs/usage/info.rst.inc

@@ -8,25 +8,63 @@ borg info
 
     borg [common options] info [options] REPOSITORY_OR_ARCHIVE
 
-REPOSITORY_OR_ARCHIVE
-    archive or repository to display information about
-
-
-optional arguments
-    --json     format output as JSON
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-    --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-    --first N               consider first N archives after other filters were applied
-    --last N                consider last N archives after other filters were applied
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``   | archive or repository to display information about                                                                                                     |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--json``                  | format output as JSON                                                                                                                                  |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                               |
+    |                                                                                                                                                                                                                                              |
+    | :ref:`common_options`                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                  |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``        | only consider archive names starting with this prefix.                                                                                                 |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort-by``               | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--first N``               | consider first N archives after other filters were applied                                                                                             |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--last N``                | consider last N archives after other filters were applied                                                                                              |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY_OR_ARCHIVE
+        archive or repository to display information about
+
+
+    optional arguments
+        --json     format output as JSON
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N               consider first N archives after other filters were applied
+        --last N                consider last N archives after other filters were applied
 
 
 Description

docs/usage/init.rst.inc

@@ -8,20 +8,50 @@ borg init
 
     borg [common options] init [options] REPOSITORY
 
-REPOSITORY
-    repository to create
-
-
-optional arguments
-    -e, --encryption     select encryption key mode **(required)**
-    --append-only        create an append-only mode repository
-    --storage-quota      Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                       |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY``           | repository to create                                                        |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                         |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    |                                                       | ``-e``, ``--encryption`` | select encryption key mode **(required)**                                   |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    |                                                       | ``--append-only``        | create an append-only mode repository                                       |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    |                                                       | ``--storage-quota``      | Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                 |
+    |                                                                                                                                                                |
+    | :ref:`common_options`                                                                                                                                          |
+    +-------------------------------------------------------+--------------------------+-----------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY
+        repository to create
+
+
+    optional arguments
+        -e, --encryption     select encryption key mode **(required)**
+        --append-only        create an append-only mode repository
+        --storage-quota      Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/key_change-passphrase.rst.inc

@@ -8,14 +8,36 @@ borg key change-passphrase
 
     borg [common options] key change-passphrase [options] REPOSITORY
 
-REPOSITORY
+.. only:: html
 
+    .. class:: borg-options-table
 
+    +-------------------------------------------------------+----------------+--+
+    | **positional arguments**                                                  |
+    +-------------------------------------------------------+----------------+--+
+    |                                                       | ``REPOSITORY`` |  |
+    +-------------------------------------------------------+----------------+--+
+    | .. class:: borg-common-opt-ref                                            |
+    |                                                                           |
+    | :ref:`common_options`                                                     |
+    +-------------------------------------------------------+----------------+--+
 
-.. class:: borg-common-opt-ref
+    .. raw:: html
 
-:ref:`common_options`
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
+.. only:: latex
+
+    REPOSITORY
+
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/key_export.rst.inc

@@ -8,21 +8,51 @@ borg key export
 
     borg [common options] key export [options] REPOSITORY PATH
 
-REPOSITORY
+.. only:: html
 
-PATH
-    where to store the backup
+    .. class:: borg-options-table
 
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                        |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY`` |                                                                        |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    |                                                       | ``PATH``       | where to store the backup                                              |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                          |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    |                                                       | ``--paper``    | Create an export suitable for printing and later type-in               |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    |                                                       | ``--qr-html``  | Create an html file suitable for printing and later type-in or qr scan |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                  |
+    |                                                                                                                                                 |
+    | :ref:`common_options`                                                                                                                           |
+    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
 
-optional arguments
-    --paper       Create an export suitable for printing and later type-in
-    --qr-html     Create an html file suitable for printing and later type-in or qr scan
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
-.. class:: borg-common-opt-ref
+.. only:: latex
 
-:ref:`common_options`
+    REPOSITORY
 
+    PATH
+        where to store the backup
+
+
+    optional arguments
+        --paper       Create an export suitable for printing and later type-in
+        --qr-html     Create an html file suitable for printing and later type-in or qr scan
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/key_import.rst.inc

@@ -8,20 +8,48 @@ borg key import
 
     borg [common options] key import [options] REPOSITORY PATH
 
-REPOSITORY
+.. only:: html
 
-PATH
-    path to the backup
+    .. class:: borg-options-table
 
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    | **positional arguments**                                                                                                          |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    |                                                       | ``REPOSITORY`` |                                                          |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    |                                                       | ``PATH``       | path to the backup                                       |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    | **optional arguments**                                                                                                            |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    |                                                       | ``--paper``    | interactively import from a backup done with ``--paper`` |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                    |
+    |                                                                                                                                   |
+    | :ref:`common_options`                                                                                                             |
+    +-------------------------------------------------------+----------------+----------------------------------------------------------+
 
-optional arguments
-    --paper     interactively import from a backup done with ``--paper``
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
-.. class:: borg-common-opt-ref
+.. only:: latex
 
-:ref:`common_options`
+    REPOSITORY
 
+    PATH
+        path to the backup
+
+
+    optional arguments
+        --paper     interactively import from a backup done with ``--paper``
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/key_migrate-to-repokey.rst.inc

@@ -8,14 +8,36 @@ borg key migrate-to-repokey
 
     borg [common options] key migrate-to-repokey [options] REPOSITORY
 
-REPOSITORY
+.. only:: html
 
+    .. class:: borg-options-table
 
+    +-------------------------------------------------------+----------------+--+
+    | **positional arguments**                                                  |
+    +-------------------------------------------------------+----------------+--+
+    |                                                       | ``REPOSITORY`` |  |
+    +-------------------------------------------------------+----------------+--+
+    | .. class:: borg-common-opt-ref                                            |
+    |                                                                           |
+    | :ref:`common_options`                                                     |
+    +-------------------------------------------------------+----------------+--+
 
-.. class:: borg-common-opt-ref
+    .. raw:: html
 
-:ref:`common_options`
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
+.. only:: latex
+
+    REPOSITORY
+
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/list.rst.inc

@@ -8,41 +8,102 @@ borg list
 
     borg [common options] list [options] REPOSITORY_OR_ARCHIVE PATH
 
-REPOSITORY_OR_ARCHIVE
-    repository/archive to list contents of
-PATH
-    paths to list; patterns are supported
-
-
-optional arguments
-    --short     only print file/directory names, nothing else
-    --format, --list-format    specify format for file listing
-                                    (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {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.
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-    --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-    --first N               consider first N archives after other filters were applied
-    --last N                consider last N archives after other filters were applied
-
-
-Exclusion options
-    -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
-    --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
-    --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
-    --keep-exclude-tags, --keep-tag-files    if tag objects are specified with --exclude-if-present, don't omit the tag objects themselves from the backup archive
-    --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                                                                                                                                                         |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``                     | repository/archive to list contents of                                                                                                                                                                                                                                   |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                                      | paths to list; patterns are supported                                                                                                                                                                                                                                    |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--short``                                   | only print file/directory names, nothing else                                                                                                                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--format``, ``--list-format``               | specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {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. |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                   |
+    |                                                                                                                                                                                                                                                                                                                                                                                  |
+    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``                          | only consider archive names starting with this prefix.                                                                                                                                                                                                                   |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives``                   | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.                                                                                                                   |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort-by``                                 | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                                                                                                                                         |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--first N``                                 | consider first N archives after other filters were applied                                                                                                                                                                                                               |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--last N``                                  | consider last N archives after other filters were applied                                                                                                                                                                                                                |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN``         | exclude paths matching PATTERN                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``                | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-caches``                          | exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-if-present NAME``                 | exclude directories that are tagged by containing a filesystem object with the given NAME                                                                                                                                                                                |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-exclude-tags``, ``--keep-tag-files`` | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                                                                                                                                                |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                         | experimental: include/exclude paths matching PATTERN                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``               | experimental: read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                               |
+    +-------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY_OR_ARCHIVE
+        repository/archive to list contents of
+    PATH
+        paths to list; patterns are supported
+
+
+    optional arguments
+        --short     only print file/directory names, nothing else
+        --format, --list-format    specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {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.
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N               consider first N archives after other filters were applied
+        --last N                consider last N archives after other filters were applied
+
+
+    Exclusion options
+        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
+        --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
+        --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
+        --keep-exclude-tags, --keep-tag-files    if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
+        --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
 
 
 Description

docs/usage/mount.rst.inc

@@ -8,28 +8,70 @@ borg mount
 
     borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT
 
-REPOSITORY_OR_ARCHIVE
-    repository/archive to mount
-MOUNTPOINT
-    where to mount filesystem
-
-
-optional arguments
-    -f, --foreground    stay in foreground, do not daemonize
-    -o     Extra mount options
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-    --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-    --first N               consider first N archives after other filters were applied
-    --last N                consider last N archives after other filters were applied
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``   | repository/archive to mount                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``MOUNTPOINT``              | where to mount filesystem                                                                                                                              |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-f``, ``--foreground``    | stay in foreground, do not daemonize                                                                                                                   |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-o``                      | Extra mount options                                                                                                                                    |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                               |
+    |                                                                                                                                                                                                                                              |
+    | :ref:`common_options`                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                  |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``        | only consider archive names starting with this prefix.                                                                                                 |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--sort-by``               | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                       |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--first N``               | consider first N archives after other filters were applied                                                                                             |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--last N``                | consider last N archives after other filters were applied                                                                                              |
+    +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY_OR_ARCHIVE
+        repository/archive to mount
+    MOUNTPOINT
+        where to mount filesystem
+
+
+    optional arguments
+        -f, --foreground    stay in foreground, do not daemonize
+        -o     Extra mount options
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by               Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N               consider first N archives after other filters were applied
+        --last N                consider last N archives after other filters were applied
 
 
 Description

docs/usage/prune.rst.inc

@@ -8,34 +8,90 @@ borg prune
 
     borg [common options] prune [options] REPOSITORY
 
-REPOSITORY
-    repository to prune
-
-
-optional arguments
-    -n, --dry-run         do not change repository
-    --force               force pruning of corrupted archives
-    -s, --stats           print statistics for the deleted archive
-    --list                output verbose list of archives it keeps/prunes
-    --keep-within WITHIN    keep all archives within this time interval
-    --keep-last, --keep-secondly    number of secondly archives to keep
-    --keep-minutely       number of minutely archives to keep
-    -H, --keep-hourly     number of hourly archives to keep
-    -d, --keep-daily      number of daily archives to keep
-    -w, --keep-weekly     number of weekly archives to keep
-    -m, --keep-monthly    number of monthly archives to keep
-    -y, --keep-yearly     number of yearly archives to keep
-    --save-space          work slower, but using less space
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-filters
-    -P, --prefix            only consider archive names starting with this prefix.
-    -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                              |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY``                       | repository to prune                                                                                                                                    |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run``                | do not change repository                                                                                                                               |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--force``                          | force pruning of corrupted archives                                                                                                                    |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-s``, ``--stats``                  | print statistics for the deleted archive                                                                                                               |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``                           | output verbose list of archives it keeps/prunes                                                                                                        |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-within WITHIN``             | keep all archives within this time interval                                                                                                            |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-last``, ``--keep-secondly`` | number of secondly archives to keep                                                                                                                    |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-minutely``                  | number of minutely archives to keep                                                                                                                    |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-H``, ``--keep-hourly``            | number of hourly archives to keep                                                                                                                      |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-d``, ``--keep-daily``             | number of daily archives to keep                                                                                                                       |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-w``, ``--keep-weekly``            | number of weekly archives to keep                                                                                                                      |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-m``, ``--keep-monthly``           | number of monthly archives to keep                                                                                                                     |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-y``, ``--keep-yearly``            | number of yearly archives to keep                                                                                                                      |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--save-space``                     | work slower, but using less space                                                                                                                      |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                        |
+    |                                                                                                                                                                                                                                                       |
+    | :ref:`common_options`                                                                                                                                                                                                                                 |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **filters**                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-P``, ``--prefix``                 | only consider archive names starting with this prefix.                                                                                                 |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-a``, ``--glob-archives``          | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
+    +-------------------------------------------------------+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY
+        repository to prune
+
+
+    optional arguments
+        -n, --dry-run         do not change repository
+        --force               force pruning of corrupted archives
+        -s, --stats           print statistics for the deleted archive
+        --list                output verbose list of archives it keeps/prunes
+        --keep-within WITHIN    keep all archives within this time interval
+        --keep-last, --keep-secondly    number of secondly archives to keep
+        --keep-minutely       number of minutely archives to keep
+        -H, --keep-hourly     number of hourly archives to keep
+        -d, --keep-daily      number of daily archives to keep
+        -w, --keep-weekly     number of weekly archives to keep
+        -m, --keep-monthly    number of monthly archives to keep
+        -y, --keep-yearly     number of yearly archives to keep
+        --save-space          work slower, but using less space
+
+
+    :ref:`common_options`
+        |
+
+    filters
+        -P, --prefix            only consider archive names starting with this prefix.
+        -a, --glob-archives     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
 
 
 Description

docs/usage/recreate.rst.inc

@@ -8,42 +8,108 @@ borg recreate
 
     borg [common options] recreate [options] REPOSITORY_OR_ARCHIVE PATH
 
-REPOSITORY_OR_ARCHIVE
-    repository/archive to recreate
-PATH
-    paths to recreate; patterns are supported
-
-
-optional arguments
-    --list          output verbose list of items (files, dirs, ...)
-    --filter STATUSCHARS    only display items with the given status characters
-    -n, --dry-run    do not change anything
-    -s, --stats     print statistics at end
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
-
-Exclusion options
-    -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
-    --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
-    --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
-    --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
-    --keep-exclude-tags, --keep-tag-files    if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
-    --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
-    --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
-
-
-Archive options
-    --target TARGET                               create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
-    -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
-    --comment COMMENT                             add a comment text to the archive
-    --timestamp TIMESTAMP                         manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
-    -C COMPRESSION, --compression COMPRESSION     select compression algorithm, see the output of the "borg help compression" command for details.
-    --recompress                                  recompress data chunks according to ``--compression`` if `if-different`. When `always`, chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for `if-different`, not the compression level (if any).
-    --chunker-params PARAMS                       specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: 19,23,21,4095
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``                         | repository/archive to recreate                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                                          | paths to recreate; patterns are supported                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                                                                                                                                          |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``                                        | output verbose list of items (files, dirs, ...)                                                                                                                                                                                                                     |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--filter STATUSCHARS``                          | only display items with the given status characters                                                                                                                                                                                                                 |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run``                             | do not change anything                                                                                                                                                                                                                                              |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-s``, ``--stats``                               | print statistics at end                                                                                                                                                                                                                                             |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                  |
+    |                                                                                                                                                                                                                                                                                                                                                                                 |
+    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN``             | exclude paths matching PATTERN                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``                    | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-caches``                              | exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)                                                                                                                                                                |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-if-present NAME``                     | exclude directories that are tagged by containing a filesystem object with the given NAME                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-exclude-tags``, ``--keep-tag-files``     | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                             | experimental: include/exclude paths matching PATTERN                                                                                                                                                                                                                |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``                   | experimental: read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                          |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Archive options**                                                                                                                                                                                                                                                                                                                                                             |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--target TARGET``                               | create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)                                                                                                                                                     |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800)                                                                                                                                                                                                              |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--comment COMMENT``                             | add a comment text to the archive                                                                                                                                                                                                                                   |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--timestamp TIMESTAMP``                         | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.                                                                                                                                  |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details.                                                                                                                                                                    |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--recompress``                                  | recompress data chunks according to ``--compression`` if `if-different`. When `always`, chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for `if-different`, not the compression level (if any). |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--chunker-params PARAMS``                       | specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: 19,23,21,4095                                                                                                    |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY_OR_ARCHIVE
+        repository/archive to recreate
+    PATH
+        paths to recreate; patterns are supported
+
+
+    optional arguments
+        --list          output verbose list of items (files, dirs, ...)
+        --filter STATUSCHARS    only display items with the given status characters
+        -n, --dry-run    do not change anything
+        -s, --stats     print statistics at end
+
+
+    :ref:`common_options`
+        |
+
+    Exclusion options
+        -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
+        --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
+        --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.brynosaurus.com/cachedir/spec.html)
+        --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
+        --keep-exclude-tags, --keep-tag-files    if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
+        --pattern PATTERN                 experimental: include/exclude paths matching PATTERN
+        --patterns-from PATTERNFILE       experimental: read include/exclude patterns from PATTERNFILE, one per line
+
+
+    Archive options
+        --target TARGET                               create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
+        -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
+        --comment COMMENT                             add a comment text to the archive
+        --timestamp TIMESTAMP                         manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
+        -C COMPRESSION, --compression COMPRESSION     select compression algorithm, see the output of the "borg help compression" command for details.
+        --recompress                                  recompress data chunks according to ``--compression`` if `if-different`. When `always`, chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for `if-different`, not the compression level (if any).
+        --chunker-params PARAMS                       specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: 19,23,21,4095
 
 
 Description

docs/usage/rename.rst.inc

@@ -8,16 +8,40 @@ borg rename
 
     borg [common options] rename [options] ARCHIVE NEWNAME
 
-ARCHIVE
-    archive to rename
-NEWNAME
-    the new archive name to use
+.. only:: html
 
+    .. class:: borg-options-table
 
-.. class:: borg-common-opt-ref
+    +-------------------------------------------------------+-------------+-----------------------------+
+    | **positional arguments**                                                                          |
+    +-------------------------------------------------------+-------------+-----------------------------+
+    |                                                       | ``ARCHIVE`` | archive to rename           |
+    +-------------------------------------------------------+-------------+-----------------------------+
+    |                                                       | ``NEWNAME`` | the new archive name to use |
+    +-------------------------------------------------------+-------------+-----------------------------+
+    | .. class:: borg-common-opt-ref                                                                    |
+    |                                                                                                   |
+    | :ref:`common_options`                                                                             |
+    +-------------------------------------------------------+-------------+-----------------------------+
 
-:ref:`common_options`
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    ARCHIVE
+        archive to rename
+    NEWNAME
+        the new archive name to use
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/serve.rst.inc

@@ -8,20 +8,48 @@ borg serve
 
     borg [common options] serve [options]
 
+.. only:: html
 
+    .. class:: borg-options-table
 
-optional arguments
-    --restrict-to-path PATH    restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
-    --restrict-to-repository PATH    restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
-    --append-only       only allow appending to repository segment files
-    --storage-quota     Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--restrict-to-path PATH``       | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--restrict-to-repository PATH`` | restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path`` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--append-only``                 | only allow appending to repository segment files                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--storage-quota``               | Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.                                                                                                                                                                                                                                                                                              |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+    +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
+    .. raw:: html
 
-.. class:: borg-common-opt-ref
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
 
-:ref:`common_options`
+.. only:: latex
 
 
+
+    optional arguments
+        --restrict-to-path PATH    restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
+        --restrict-to-repository PATH    restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path`` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
+        --append-only       only allow appending to repository segment files
+        --storage-quota     Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
+
+
+    :ref:`common_options`
+        |
+
 Description
 ~~~~~~~~~~~
 

docs/usage/umount.rst.inc

@@ -8,14 +8,36 @@ borg umount
 
     borg [common options] umount [options] MOUNTPOINT
 
-MOUNTPOINT
-    mountpoint of the filesystem to umount
+.. only:: html
 
+    .. class:: borg-options-table
 
-.. class:: borg-common-opt-ref
+    +-------------------------------------------------------+----------------+----------------------------------------+
+    | **positional arguments**                                                                                        |
+    +-------------------------------------------------------+----------------+----------------------------------------+
+    |                                                       | ``MOUNTPOINT`` | mountpoint of the filesystem to umount |
+    +-------------------------------------------------------+----------------+----------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                  |
+    |                                                                                                                 |
+    | :ref:`common_options`                                                                                           |
+    +-------------------------------------------------------+----------------+----------------------------------------+
 
-:ref:`common_options`
+    .. raw:: html
 
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    MOUNTPOINT
+        mountpoint of the filesystem to umount
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/upgrade.rst.inc

@@ -8,23 +8,58 @@ borg upgrade
 
     borg [common options] upgrade [options] REPOSITORY
 
-REPOSITORY
-    path to the repository to be upgraded
-
-
-optional arguments
-    -n, --dry-run     do not change repository
-    --inplace         rewrite repository in place, with no chance of going back to older
-                                   versions of the repository.
-    --force           Force upgrade
-    --tam             Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)
-    --disable-tam     Disable manifest authentication (in key and cache)
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                      |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``REPOSITORY``        | path to the repository to be upgraded                                                                                         |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                        |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run`` | do not change repository                                                                                                      |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--inplace``         | rewrite repository in place, with no chance of going back to older                                                            |
+    |                                                       |                       |                                versions of the repository.                                                                    |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--force``           | Force upgrade                                                                                                                 |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--tam``             | Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)                                                      |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--disable-tam``     | Disable manifest authentication (in key and cache)                                                                            |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                |
+    |                                                                                                                                                                                                               |
+    | :ref:`common_options`                                                                                                                                                                                         |
+    +-------------------------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY
+        path to the repository to be upgraded
+
+
+    optional arguments
+        -n, --dry-run     do not change repository
+        --inplace         rewrite repository in place, with no chance of going back to older
+                                       versions of the repository.
+        --force           Force upgrade
+        --tam             Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)
+        --disable-tam     Disable manifest authentication (in key and cache)
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

docs/usage/with-lock.rst.inc

@@ -8,18 +8,44 @@ borg with-lock
 
     borg [common options] with-lock [options] REPOSITORY COMMAND ARGS
 
-REPOSITORY
-    repository to lock
-COMMAND
-    command to run
-ARGS
-    command arguments
-
-
-.. class:: borg-common-opt-ref
-
-:ref:`common_options`
-
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+----------------+--------------------+
+    | **positional arguments**                                                                    |
+    +-------------------------------------------------------+----------------+--------------------+
+    |                                                       | ``REPOSITORY`` | repository to lock |
+    +-------------------------------------------------------+----------------+--------------------+
+    |                                                       | ``COMMAND``    | command to run     |
+    +-------------------------------------------------------+----------------+--------------------+
+    |                                                       | ``ARGS``       | command arguments  |
+    +-------------------------------------------------------+----------------+--------------------+
+    | .. class:: borg-common-opt-ref                                                              |
+    |                                                                                             |
+    | :ref:`common_options`                                                                       |
+    +-------------------------------------------------------+----------------+--------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(window).load(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+    REPOSITORY
+        repository to lock
+    COMMAND
+        command to run
+    ARGS
+        command arguments
+
+
+    :ref:`common_options`
+        |
 
 Description
 ~~~~~~~~~~~

setup.py

@@ -288,11 +288,110 @@ class build_usage(Command):
         fp.write('\n\n')
 
     def write_options(self, parser, fp):
+        def is_positional_group(group):
+            return any(not o.option_strings for o in group._group_actions)
+
+        # HTML output:
+        # A table using some column-spans
+
+        def html_write(s):
+            for line in s.splitlines():
+                fp.write('    ' + line + '\n')
+
+        rows = []
         for group in parser._action_groups:
             if group.title == 'Common options':
-                fp.write('\n\n.. class:: borg-common-opt-ref\n\n:ref:`common_options`\n')
+                # (no of columns used, columns, ...)
+                rows.append((1, '.. class:: borg-common-opt-ref\n\n:ref:`common_options`'))
             else:
-                self.write_options_group(group, fp)
+                if not group._group_actions:
+                    continue
+                rows.append((1, '**%s**' % group.title))
+                if is_positional_group(group):
+                    for option in group._group_actions:
+                        rows.append((3, '', '``%s``' % option.metavar, option.help or ''))
+                else:
+                    for option in group._group_actions:
+                        if option.metavar:
+                            option_fmt = '``%s ' + option.metavar + '``'
+                        else:
+                            option_fmt = '``%s``'
+                        option_str = ', '.join(option_fmt % s for s in option.option_strings)
+                        option_desc = textwrap.dedent((option.help or '') % option.__dict__)
+                        rows.append((3, '', option_str, option_desc))
+
+        fp.write('.. only:: html\n\n')
+        table = io.StringIO()
+        table.write('.. class:: borg-options-table\n\n')
+        self.rows_to_table(rows, table.write)
+        fp.write(textwrap.indent(table.getvalue(), ' ' * 4))
+
+        # LaTeX output:
+        # Regular rST option lists (irregular column widths)
+        latex_options = io.StringIO()
+        for group in parser._action_groups:
+            if group.title == 'Common options':
+                latex_options.write('\n\n:ref:`common_options`\n')
+                latex_options.write('    |')
+            else:
+                self.write_options_group(group, latex_options)
+        fp.write('\n.. only:: latex\n\n')
+        fp.write(textwrap.indent(latex_options.getvalue(), ' ' * 4))
+
+    def rows_to_table(self, rows, write):
+        def write_row_separator():
+            write('+')
+            for column_width in column_widths:
+                write('-' * (column_width + 1))
+                write('+')
+            write('\n')
+
+        # Find column count and width
+        column_count = max(columns for columns, *_ in rows)
+        column_widths = [0] * column_count
+        for columns, *cells in rows:
+            for i in range(columns):
+                # "+ 1" because we want a space between the cell contents and the delimiting "|" in the output
+                column_widths[i] = max(column_widths[i], len(cells[i]) + 1)
+
+        for columns, *cells in rows:
+            write_row_separator()
+            # If a cell contains newlines, then the row must be split up in individual rows
+            # where each cell contains no newline.
+            rowspanning_cells = []
+            original_cells = list(cells)
+            while any('\n' in cell for cell in original_cells):
+                cell_bloc = []
+                for i, cell in enumerate(original_cells):
+                    pre, _, original_cells[i] = cell.partition('\n')
+                    cell_bloc.append(pre)
+                rowspanning_cells.append(cell_bloc)
+            rowspanning_cells.append(original_cells)
+            for cells in rowspanning_cells:
+                for i, column_width in enumerate(column_widths):
+                    if i < columns:
+                        write('| ')
+                        write(cells[i].ljust(column_width))
+                    else:
+                        write('  ')
+                        write(''.ljust(column_width))
+                write('|\n')
+
+        write_row_separator()
+        # This bit of JavaScript kills the <colgroup> that is invariably inserted by docutils,
+        # but does absolutely no good here. It sets bogus column widths which cannot be overridden
+        # with CSS alone.
+        # Since this is HTML-only output, it would be possible to just generate a <table> directly,
+        # but then we'd lose rST formatting.
+        write(textwrap.dedent("""
+        .. raw:: html
+
+            <script type='text/javascript'>
+            $(window).load(function () {
+                $('.borg-options-table colgroup').remove();
+            })
+            </script>
+        """))
 
     def write_options_group(self, group, fp, with_title=True, base_indent=4):
         def is_positional_group(group):

src/borg/archiver.py

@@ -1881,7 +1881,7 @@ class Archiver:
             separator, a '\*' is appended before matching is attempted.
 
         Shell-style patterns, selector `sh:`
-            This is the default style for --pattern and --patterns-from.
+            This is the default style for ``--pattern`` and ``--patterns-from``.
             Like fnmatch patterns these are similar to shell patterns. The difference
             is that the pattern may include `**/` for matching zero or more directory
             levels, `*` for matching zero or more arbitrary characters with the
@@ -2368,7 +2368,7 @@ class Archiver:
                                metavar='PATH', help='restrict repository access. Only the repository located at PATH (no sub-directories are considered) '
                                                     'is accessible. '
                                                     'Can be specified multiple times to allow the client access to several repositories. '
-                                                    'Unlike --restrict-to-path sub-directories are not accessible; '
+                                                    'Unlike ``--restrict-to-path`` sub-directories are not accessible; '
                                                     'PATH needs to directly point at a repository location. '
                                                     'PATH may be an empty directory or the last element of PATH may not exist, in which case '
                                                     'the client may initialize a repository there.')
@@ -2803,9 +2803,9 @@ class Archiver:
         subparser.add_argument('--filter', dest='output_filter', metavar='STATUSCHARS',
                                help='only display items with the given status characters')
         subparser.add_argument('--json', action='store_true',
-                               help='output stats as JSON (implies --stats)')
+                               help='output stats as JSON. Implies ``--stats``.')
         subparser.add_argument('--no-cache-sync', dest='no_cache_sync', action='store_true',
-                               help='experimental: do not synchronize the cache. Implies --no-files-cache.')
+                               help='experimental: do not synchronize the cache. Implies ``--no-files-cache``.')
 
         exclude_group = subparser.add_argument_group('Exclusion options')
         exclude_group.add_argument('-e', '--exclude', dest='patterns',
@@ -2823,8 +2823,8 @@ class Archiver:
                                         'the given NAME')
         exclude_group.add_argument('--keep-exclude-tags', '--keep-tag-files', dest='keep_exclude_tags',
                                    action='store_true', default=False,
-                                   help='if tag objects are specified with --exclude-if-present, don\'t omit the tag '
-                                        'objects themselves from the backup archive')
+                                   help='if tag objects are specified with ``--exclude-if-present``, '
+                                        'don\'t omit the tag objects themselves from the backup archive')
         exclude_group.add_argument('--pattern',
                                    action=ArgparsePatternAction,
                                    metavar="PATTERN", help='experimental: include/exclude paths matching PATTERN')
@@ -3057,8 +3057,8 @@ class Archiver:
                                         'the given NAME')
         exclude_group.add_argument('--keep-exclude-tags', '--keep-tag-files', dest='keep_exclude_tags',
                                    action='store_true', default=False,
-                                   help='if tag objects are specified with --exclude-if-present, don\'t omit the tag '
-                                        'objects themselves from the backup archive')
+                                   help='if tag objects are specified with ``--exclude-if-present``, '
+                                        'don\'t omit the tag objects themselves from the backup archive')
         exclude_group.add_argument('--pattern',
                                    action=ArgparsePatternAction,
                                    metavar="PATTERN", help='experimental: include/exclude paths matching PATTERN')
@@ -3103,7 +3103,7 @@ class Archiver:
         subparser.add_argument('--force', dest='forced',
                                action='count', default=0,
                                help='force deletion of corrupted archives, '
-                                    'use --force --force in case --force does not work.')
+                                    'use ``--force --force`` in case ``--force`` does not work.')
         subparser.add_argument('--save-space', dest='save_space', action='store_true',
                                default=False,
                                help='work slower, but using less space')
@@ -3141,8 +3141,8 @@ class Archiver:
                                action='store_true', default=False,
                                help='only print file/directory names, nothing else')
         subparser.add_argument('--format', '--list-format', dest='format', type=str,
-                               help="""specify format for file listing
-                                (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")""")
+                               help='specify format for file listing '
+                                    '(default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")')
         subparser.add_argument('--json', action='store_true',
                                help='Only valid for listing repository contents. Format output as JSON. '
                                     'The form of ``--format`` is ignored, '
@@ -3178,7 +3178,7 @@ class Archiver:
                                         'the given NAME')
         exclude_group.add_argument('--keep-exclude-tags', '--keep-tag-files', dest='keep_exclude_tags',
                                    action='store_true', default=False,
-                                   help='if tag objects are specified with --exclude-if-present, don\'t omit the tag '
+                                   help='if tag objects are specified with ``--exclude-if-present``, don\'t omit the tag '
                                         'objects themselves from the backup archive')
         exclude_group.add_argument('--pattern',
                                    action=ArgparsePatternAction,