]> arthur.barton.de Git - bup.git/commitdiff
man pages: fix some formatting
authorJohannes Berg <johannes@sipsolutions.net>
Fri, 13 Dec 2019 20:37:16 +0000 (21:37 +0100)
committerRob Browning <rlb@defaultvalue.org>
Sat, 25 Apr 2020 19:14:49 +0000 (14:14 -0500)
I noticed one place where -- was used instead of \--, leading to a
emdash instead of two hyphens, but then I looked and realized this
was not just a single place; fix all of those.

While at it, I saw some --keep options being referenced without
backticks, fix that too.

Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
(cherry picked from commit 27e6ee3680585fd445ce04955333a4bdf585db30)
Tested-by: Rob Browning <rlb@defaultvalue.org>
Documentation/bup-cat-file.md
Documentation/bup-gc.md
Documentation/bup-get.md
Documentation/bup-import-duplicity.md
Documentation/bup-import-rdiff-backup.md
Documentation/bup-prune-older.md
Documentation/bup-rm.md
Documentation/bup-split.md
Documentation/bup-web.md

index 8f5585e899729cd1cff97513c8c2557501369ee4..c3ea1f1d221b135dbf84fa099bbb80da42e057d1 100644 (file)
@@ -8,7 +8,7 @@ bup-cat-file - extract archive content (low-level)
 
 # SYNOPSIS
 
-bup cat-file [--meta|--bupm] <*path*>
+bup cat-file [\--meta|\--bupm] <*path*>
 
 # DESCRIPTION
 
index 4996f3d1e429a1589efd64a61ffefa91ec57f6a1..1eb9901822d7d47ec22ce8137259d602673d4840 100644 (file)
@@ -8,7 +8,7 @@ bup-gc - remove unreferenced, unneeded data (CAUTION: EXPERIMENTAL)
 
 # SYNOPSIS
 
-bup gc [-#|--verbose] <*branch*|*save*...>
+bup gc [-#|\--verbose] <*branch*|*save*...>
 
 # DESCRIPTION
 
index f40c753176b832bd0c20c08da1c322ff911c54b6..94cb4f3ea0cf888aab84b4db53981dc8133536e5 100644 (file)
@@ -65,50 +65,50 @@ used to help test before/after results.)
 
 # METHODS
 
---ff *ref*, --ff: *ref* *dest*
+\--ff *ref*, \--ff: *ref* *dest*
 :   fast-forward *dest* to match *ref*.  If *dest* is not specified
     and *ref* names a save, set *dest* to the save's branch.  If
     *dest* is not specified and *ref* names a branch or a tag, use the
     same name for *dest*.
 
---append *ref*, --append: *ref* *dest*
+\--append *ref*, \--append: *ref* *dest*
 :   append all of the commits represented by *ref* to *dest* as new
     commits.  If *ref* names a directory/tree, append a new commit for
     that tree.  If *dest* is not specified and *ref* names a save or
     branch, set *dest* to the *ref* branch name.  If *dest* is not
     specified and *ref* names a tag, use the same name for *dest*.
 
---pick *ref*, --pick: *ref* *dest*
+\--pick *ref*, \--pick: *ref* *dest*
 :   append the single commit named by *ref* to *dest* as a new commit.
     If *dest* is not specified and *ref* names a save, set *dest* to
     the *ref* branch name.  If *dest* is not specified and *ref* names
     a tag, use the same name for *dest*.
 
---force-pick *ref*, --force-pick: *ref* *dest*
+\--force-pick *ref*, \--force-pick: *ref* *dest*
 :   do the same thing as `--pick`, but don't refuse to overwrite an
     existing tag.
 
---new-tag *ref*, --new-tag: *ref* *dest*
+\--new-tag *ref*, \--new-tag: *ref* *dest*
 :   create a *dest* tag for *ref*, but refuse to overwrite an existing
     tag.  If *dest* is not specified and *ref* names a tag, use the
     same name for *dest*.
 
---replace *ref*, --replace: *ref* *dest*
+\--replace *ref*, \--replace: *ref* *dest*
 :   clobber *dest* with *ref*, overwriting any existing tag, or
     replacing any existing branch.  If *dest* is not specified and
     *ref* names a branch or tag, use the same name for *dest*.
 
---unnamed *ref*
+\--unnamed *ref*
 :   copy *ref* into the destination repository, without any name,
     leaving a potentially dangling reference until/unless the object
     named by *ref* is referred to some other way (cf. `bup tag`).
 
 # OPTIONS
 
--s, --source=*path*
+-s, \--source=*path*
 :   use *path* as the source repository, instead of the default.
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   store the indicated items on the given remote server.  If *path*
     is omitted, uses the default path on the remote server (you still
     need to include the ':').  The connection to the remote server is
@@ -116,28 +116,28 @@ used to help test before/after results.)
     private key to use for the SSH connection, we recommend you use
     the `~/.ssh/config` file.
 
--c, --print-commits
+-c, \--print-commits
 :   for each updated branch, print the new git commit id.
 
--t, --print-trees
+-t, \--print-trees
 :   for each updated branch, print the new git tree id of the
     filesystem root.
 
---print-tags
+\--print-tags
 :   for each updated tag, print the new git id.
 
--v, --verbose
+-v, \--verbose
 :   increase verbosity (can be used more than once).  With
     `-v`, print the name of every item fetched, with `-vv` add
     directory names, and with `-vvv` add every filename.
 
---bwlimit=*bytes/sec*
+\--bwlimit=*bytes/sec*
 :   don't transmit more than *bytes/sec* bytes per second to the
     server.  This can help avoid sucking up all your network
     bandwidth.  Use a suffix like k, M, or G to specify multiples of
     1024, 1024\*1024, 1024\*1024\*1024 respectively.
 
--*#*, --compress=*#*
+-*#*, \--compress=*#*
 :   set the compression level to # (a value from 0-9, where
     9 is the highest and 0 is no compression).  The default
     is 1 (fast, loose compression)
index b09840b18b618ff075c04adab23360b9126b256e..b75071b2c195b41c9f3fd0511e325c32b502081e 100644 (file)
@@ -38,7 +38,7 @@ Since all invocations of duplicity use a temporary `--archive-dir`,
 
 # OPTIONS
 
--n,--dry-run
+-n, \--dry-run
 :   don't do anything; just print out what would be done
 
 # EXAMPLES
index 3182b7e7a5c22c13e9f3597f6e9e745d682b0cb7..4698fce430172019876879acf19e125725b42635 100644 (file)
@@ -18,7 +18,7 @@ the rdiff-backup archive is stripped from the paths.
 
 # OPTIONS
 
--n,--dry-run
+-n, \--dry-run
 :   don't do anything just print out what would be done
 
 # EXAMPLES
index ffce535a2cc4ee4ab18240daf0da853db69d0c44..b4959a2475b2920ee30315811f39e60f1f63cc17 100644 (file)
@@ -46,27 +46,27 @@ calendar, so `--keep-dailies-for 5d` means a period starting exactly
 
 # OPTIONS
 
---keep-all-for PERIOD
-:   when no smaller time scale --keep option applies, retain all saves
+\--keep-all-for PERIOD
+:   when no smaller time scale `--keep` option applies, retain all saves
     within the given period.
 
---keep-dailies-for PERIOD
-:   when no smaller time scale --keep option applies, retain the
+\--keep-dailies-for PERIOD
+:   when no smaller time scale `--keep` option applies, retain the
     newest save for any day within the given period.
 
---keep-monthlies-for PERIOD
-:   when no smaller time scale --keep option applies, retain the
+\--keep-monthlies-for PERIOD
+:   when no smaller time scale `--keep` option applies, retain the
     newest save for any month within the given period.
 
---keep-yearlies-for PERIOD
-:   when no smaller time scale --keep option applies, retain the
+\--keep-yearlies-for PERIOD
+:   when no smaller time scale `--keep` option applies, retain the
     newest save for any year within the given period.
 
---wrt UTC_SECONDS
+\--wrt UTC_SECONDS
 :   when computing a keep period, place the most recent end of the
     range at UTC\_SECONDS, and any saves newer than this will be kept.
 
---pretend
+\--pretend
 :   don't do anything, just list the actions that would be taken to
     standard output, one action per line like this:
 
@@ -74,7 +74,7 @@ calendar, so `--keep-dailies-for 5d` means a period starting exactly
         + SAVE
         ...
 
---gc
+\--gc
 :   garbage collect the repository after removing the relevant saves.
     This is the default behavior, but it can be avoided with `--no-gc`.
 
index 12e733cc986f0446e1ae80a09f2d0f7838e90c2e..2cbca16164d534fd78d9eb4a80e96f69f2a6333c 100644 (file)
@@ -8,7 +8,7 @@ bup-rm - remove references to archive content (CAUTION: EXPERIMENTAL)
 
 # SYNOPSIS
 
-bup rm [-#|--verbose] <*branch*|*save*...>
+bup rm [-#|\--verbose] <*branch*|*save*...>
 
 # DESCRIPTION
 
index 3c407cd630780184be3a0fefd73e0aff1c2ce77f..be083a64cde06fee1eae4a0465514208f2f70d0f 100644 (file)
@@ -20,7 +20,7 @@ COMMON\_OPTIONS
   ~ \[-r *host*:*path*\] \[-v\] \[-q\] \[-d *seconds-since-epoch*\] \[\--bench\]
     \[\--max-pack-size=*bytes*\] \[-#\] \[\--bwlimit=*bytes*\]
     \[\--max-pack-objects=*n*\] \[\--fanout=*count*\]
-    \[\--keep-boundaries\] \[--git-ids | filenames...\]
+    \[\--keep-boundaries\] \[\--git-ids | filenames...\]
 
 # DESCRIPTION
 
index 2f7750f66f49b0022711b00c63a0c95fbb1b0fe9..03a0a77d1e9c275fe6f41b15132d51ba8d0bdd09 100644 (file)
@@ -31,10 +31,10 @@ shutdown.
 
 # OPTIONS
 
---human-readable
+\--human-readable
 :   display human readable file sizes (i.e. 3.9K, 4.7M)
 
---browser
+\--browser
 :   open the site in the default browser
 
 # EXAMPLES