diff --git a/docs/borg_theme/css/borg.css b/docs/borg_theme/css/borg.css index abd7b7a1a..20b3b95c5 100644 --- a/docs/borg_theme/css/borg.css +++ b/docs/borg_theme/css/borg.css @@ -169,3 +169,7 @@ cite { font-style: normal; text-decoration: underline; } + +.borg-common-opt-ref { + font-weight: bold; +} diff --git a/docs/usage/benchmark_crud.rst.inc b/docs/usage/benchmark_crud.rst.inc index c0274dbe7..6eb48ef60 100644 --- a/docs/usage/benchmark_crud.rst.inc +++ b/docs/usage/benchmark_crud.rst.inc @@ -14,8 +14,10 @@ PATH path were to create benchmark input data +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc index 341fa8a03..130e573e4 100644 --- a/docs/usage/break-lock.rst.inc +++ b/docs/usage/break-lock.rst.inc @@ -12,8 +12,10 @@ REPOSITORY repository for which to break the locks +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/change-passphrase.rst.inc b/docs/usage/change-passphrase.rst.inc index c9cbee362..0df569a70 100644 --- a/docs/usage/change-passphrase.rst.inc +++ b/docs/usage/change-passphrase.rst.inc @@ -12,8 +12,10 @@ REPOSITORY +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index ad31b6a2c..ae185a583 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -20,8 +20,10 @@ optional arguments --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. diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index 0480befb2..515591576 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -23,8 +23,10 @@ optional arguments --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 diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 294900fed..9665be400 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -19,8 +19,10 @@ optional arguments --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. diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index 1c3d7fb1a..f70731cc9 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -22,8 +22,10 @@ optional arguments --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 diff --git a/docs/usage/export-tar.rst.inc b/docs/usage/export-tar.rst.inc index d28bf999f..f31d12556 100644 --- a/docs/usage/export-tar.rst.inc +++ b/docs/usage/export-tar.rst.inc @@ -26,8 +26,10 @@ optional arguments --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` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index e23eecd02..3ce7c0649 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -27,8 +27,10 @@ optional arguments --sparse create holes in output sparse file from all-zero chunks +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index d23664d6b..989d380dc 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -16,8 +16,10 @@ 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. diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index a959ead2f..31e1750a9 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -18,8 +18,10 @@ optional arguments --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` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/key.rst b/docs/usage/key.rst index d22db0447..ac6ba86bb 100644 --- a/docs/usage/key.rst +++ b/docs/usage/key.rst @@ -1,8 +1,3 @@ -.. include:: key_export.rst.inc - - -.. include:: key_import.rst.inc - .. _borg-change-passphrase: .. include:: key_change-passphrase.rst.inc @@ -40,3 +35,7 @@ Fully automated using environment variables: $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change-passphrase repo # now "new" is the current passphrase. + +.. include:: key_export.rst.inc + +.. include:: key_import.rst.inc diff --git a/docs/usage/key_change-passphrase.rst.inc b/docs/usage/key_change-passphrase.rst.inc index b40ab8065..b9e99df30 100644 --- a/docs/usage/key_change-passphrase.rst.inc +++ b/docs/usage/key_change-passphrase.rst.inc @@ -12,8 +12,10 @@ REPOSITORY +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 271d0eeb7..e3bae821b 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -19,8 +19,10 @@ optional arguments --qr-html Create an html file suitable for printing and later type-in or qr scan +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index e08ef912e..d08286b4a 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -18,8 +18,10 @@ optional arguments --paper interactively import from a backup done with ``--paper`` +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/key_migrate-to-repokey.rst.inc b/docs/usage/key_migrate-to-repokey.rst.inc index 948d7b8c1..f63aba77e 100644 --- a/docs/usage/key_migrate-to-repokey.rst.inc +++ b/docs/usage/key_migrate-to-repokey.rst.inc @@ -12,8 +12,10 @@ REPOSITORY +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index cb8e6d579..802a316ae 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -22,8 +22,10 @@ optional arguments --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. diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 40bbe5626..91799b1a8 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -19,8 +19,10 @@ optional arguments -o Extra mount options +.. class:: borg-common-opt-ref + :ref:`common_options` - | + filters -P, --prefix only consider archive names starting with this prefix. diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 6ded22c1b..4fec9a20f 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -28,8 +28,10 @@ optional arguments --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. diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index df43fd4bd..8425feb0d 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -21,8 +21,10 @@ optional arguments -s, --stats print statistics at end +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Exclusion options -e PATTERN, --exclude PATTERN exclude paths matching PATTERN diff --git a/docs/usage/rename.rst.inc b/docs/usage/rename.rst.inc index 03ca4f2b8..7c81e2ee4 100644 --- a/docs/usage/rename.rst.inc +++ b/docs/usage/rename.rst.inc @@ -14,8 +14,10 @@ NEWNAME the new archive name to use +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 006045d57..f7ccb0327 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -17,8 +17,10 @@ optional arguments --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` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/umount.rst.inc b/docs/usage/umount.rst.inc index deace69f9..f4f6da713 100644 --- a/docs/usage/umount.rst.inc +++ b/docs/usage/umount.rst.inc @@ -12,8 +12,10 @@ MOUNTPOINT mountpoint of the filesystem to umount +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index ad5ddcf35..7d13e6d8c 100644 --- a/docs/usage/upgrade.rst.inc +++ b/docs/usage/upgrade.rst.inc @@ -21,8 +21,10 @@ optional arguments --disable-tam Disable manifest authentication (in key and cache) +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/docs/usage/with-lock.rst.inc b/docs/usage/with-lock.rst.inc index 3e387611f..411b47d1b 100644 --- a/docs/usage/with-lock.rst.inc +++ b/docs/usage/with-lock.rst.inc @@ -16,8 +16,10 @@ ARGS command arguments +.. class:: borg-common-opt-ref + :ref:`common_options` - | + Description ~~~~~~~~~~~ diff --git a/setup.py b/setup.py index 2b58dcdf5..383e6e4b4 100644 --- a/setup.py +++ b/setup.py @@ -290,8 +290,7 @@ class build_usage(Command): def write_options(self, parser, fp): for group in parser._action_groups: if group.title == 'Common options': - fp.write('\n\n:ref:`common_options`\n') - fp.write(' |') + fp.write('\n\n.. class:: borg-common-opt-ref\n\n:ref:`common_options`\n') else: self.write_options_group(group, fp)