]> arthur.barton.de Git - bup.git/commitdiff
Fix and regularize "<>-" escaping in Documentation/*.md.
authorRob Browning <rlb@defaultvalue.org>
Sun, 8 Apr 2012 17:42:45 +0000 (12:42 -0500)
committerRob Browning <rlb@defaultvalue.org>
Fri, 17 Aug 2012 18:42:58 +0000 (13:42 -0500)
Signed-off-by: Rob Browning <rlb@defaultvalue.org>
21 files changed:
Documentation/bup-bloom.md
Documentation/bup-daemon.md
Documentation/bup-damage.md
Documentation/bup-drecurse.md
Documentation/bup-fsck.md
Documentation/bup-fuse.md
Documentation/bup-import-rsnapshot.md
Documentation/bup-index.md
Documentation/bup-init.md
Documentation/bup-join.md
Documentation/bup-ls.md
Documentation/bup-margin.md
Documentation/bup-memtest.md
Documentation/bup-meta.md
Documentation/bup-midx.md
Documentation/bup-random.md
Documentation/bup-restore.md
Documentation/bup-save.md
Documentation/bup-split.md
Documentation/bup-tag.md
Documentation/bup.md

index ef7c3a3436401ad20eb63c5bff2007c38c8fb7b7..f50e07df6851c18b9fc84f2e843ec59cba7b473b 100644 (file)
@@ -8,7 +8,7 @@ bup-bloom - generates, regenerates, updates bloom filters
 
 # SYNOPSIS
 
-bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile] [-f] [--ruin]
+bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile] [-f] [\--ruin]
 
 # DESCRIPTION
 
@@ -18,30 +18,30 @@ updates or regenerates it as needed.
 
 # OPTIONS
 
---ruin
+\--ruin
 :   destroy bloom filters by setting the whole bitmask to
     zeros.  you really want to know what you are doing if
     run this and you want to delete the resulting bloom
     when you are done with it.
 
--f, --force
+-f, \--force
 :   don't update the existing bloom file; generate a new
     one from scratch.
 
--d, --dir=*directory*
+-d, \--dir=*directory*
 :   the directory, containing .idx files, to process.
     Defaults to $BUP_DIR/objects/pack
 
--o, --outfile=*outfile*
+-o, \--outfile=*outfile*
 :   the file to write the bloom filter to.  defaults to
     $dir/bup.bloom
 
--k, --hashes=*hashes*
+-k, \--hashes=*hashes*
 :   number of hash functions to use only 4 and 5 are valid.
     defaults to 5 for repositories < 2 TiB, or 4 otherwise.
     See comments in git.py for more on this value.
 
--c, --check=*idxfile*
+-c, \--check=*idxfile*
 :   checks the bloom file (counterintuitively outfile)
     against the specified .idx file, first checks that the
     bloom filter is claiming to contain the .idx, then
index fc032e6d80e600a48fd919c0b319d23085668227..7cc8297201af4209a45aabe6ae947f50022cf514 100644 (file)
@@ -17,10 +17,10 @@ socket and forks connections to `bup mux server` children.
 
 # OPTIONS
 
--l, --listen=*address*
+-l, \--listen=*address*
 :   the address or hostname to listen on
 
--p, --port=*port*
+-p, \--port=*port*
 :   the port to listen on
 
 # BUP
index 868902d492ecc54acc4ae3f0abce8a80fe69abc6..52f52843d4d558b9619bb765243d3965b7a8ff28 100644 (file)
@@ -8,8 +8,8 @@ bup-damage - randomly destroy blocks of a file
 
 # SYNOPSIS
 
-bup damage [-n count] [-s maxsize] [--percent pct] [-S seed] 
-[--equal] <filenames...>
+bup damage [-n count] [-s maxsize] [\--percent pct] [-S seed]
+[\--equal] \<filenames...\>
 
 # DESCRIPTION
 
@@ -26,7 +26,7 @@ actually work.
 
 # OPTIONS
 
--n, --num=*numblocks*
+-n, \--num=*numblocks*
 :   the number of separate blocks to damage in each file
     (default 10).
     Note that it's possible for more than one damaged
@@ -34,7 +34,7 @@ actually work.
     so you might not damage as many recovery blocks as you
     expect.  If this is a problem, use `--equal`.
 
--s, --size=*maxblocksize*
+-s, \--size=*maxblocksize*
 :   the maximum size, in bytes, of each damaged block
     (default 1 unless `--percent` is specified).  Note that
     because of the way `bup-fsck`(1) works, a multi-byte
@@ -45,7 +45,7 @@ actually work.
     might be a problem, you should use the default damage
     size of one byte.
     
---percent=*maxblockpercent*
+\--percent=*maxblockpercent*
 :   the maximum size, in percent of the original file, of
     each damaged block.  If both `--size` and `--percent`
     are given, the maximum block size is the minimum of the
@@ -53,7 +53,7 @@ actually work.
     given block will never damage more than one or two
     `git-fsck`(1) recovery blocks.
     
--S, --seed=*randomseed*
+-S, \--seed=*randomseed*
 :   seed the random number generator with the given value. 
     If you use this option, your tests will be repeatable,
     since the damaged block offsets, sizes, and contents
@@ -62,7 +62,7 @@ actually work.
     in a loop and repeatedly test with different
     damage each time).
     
---equal
+\--equal
 :   instead of choosing random offsets for each damaged
     block, space the blocks equally throughout the file,
     starting at offset 0.  If you also choose a correct
index ffa5caff72be771a8fad567ae5bfbfa708995d8e..46920257d329db7f95d7f100b11163bf485afc5e 100644 (file)
@@ -8,8 +8,8 @@ bup-drecurse - recursively list files in your filesystem
 
 # SYNOPSIS
 
-bup drecurse [-x] [-q] [--exclude *path*]
-[--exclude-from *filename*] [--profile] \<path\>
+bup drecurse [-x] [-q] [\--exclude *path*]
+[\--exclude-from *filename*] [\--profile] \<path\>
 
 # DESCRIPTION
 
@@ -29,22 +29,22 @@ come after its children, making this easy.
 
 # OPTIONS
 
--x, --xdev, --one-file-system
+-x, \--xdev, \--one-file-system
 :   don't cross filesystem boundaries.
 
--q, --quiet
+-q, \--quiet
 :   don't print filenames as they are encountered.  Useful
     when testing performance of the traversal algorithms.
 
---exclude=*path*
+\--exclude=*path*
 :   a path to exclude from the backup (can be used more
     than once)
 
---exclude-from=*filename*
+\--exclude-from=*filename*
 :   a file that contains exclude paths (can be used more
     than once)
     
---profile
+\--profile
 :   print profiling information upon completion.  Useful
     when testing performance of the traversal algorithms.
     
index da3cfc5b26c20e256e93ed8541e9c44b8c3b1148..2f7bb602a8c435e72b6942f2cc37879db9f88553 100644 (file)
@@ -8,8 +8,8 @@ bup-fsck - verify or repair a bup repository
 
 # SYNOPSIS
 
-bup fsck [-r] [-g] [-v] [--quick] [-j *jobs*] [--par2-ok]
-[--disable-par2] [filenames...]
+bup fsck [-r] [-g] [-v] [\--quick] [-j *jobs*] [\--par2-ok]
+[\--disable-par2] [filenames...]
 
 # DESCRIPTION
 
@@ -44,18 +44,18 @@ site redundancy).
 
 # OPTIONS
 
--r, --repair
+-r, \--repair
 :   attempt to repair any damaged packs using
     existing recovery blocks.  (Requires `par2`(1).)
     
--g, --generate
+-g, \--generate
 :   generate recovery blocks for any packs that don't
     already have them.  (Requires `par2`(1).)
 
--v, --verbose
+-v, \--verbose
 :   increase verbosity (can be used more than once).
 
---quick
+\--quick
 :   don't run a full `git verify-pack` on each pack file;
     instead just check the final checksum.  This can cause
     a significant speedup with no obvious decrease in
@@ -63,7 +63,7 @@ site redundancy).
     option if you're paranoid.  Has no effect on packs that
     already have recovery information.
     
--j, --jobs=*numjobs*
+-j, \--jobs=*numjobs*
 :   maximum number of pack verifications to run at a time. 
     The optimal value for this option depends how fast your
     CPU can verify packs vs. your disk throughput.  If you
@@ -73,12 +73,12 @@ site redundancy).
     the number of CPU cores on your system.  You can
     experiment with this option to find the optimal value.
     
---par2-ok
+\--par2-ok
 :   immediately return 0 if `par2`(1) is installed and
     working, or 1 otherwise.  Do not actually check
     anything.
     
---disable-par2
+\--disable-par2
 :   pretend that `par2`(1) is not installed, and ignore all
     recovery blocks.
 
index 3304b0bfc4454aa533196838c4549b4471d1a6f8..b3e42ef5a8f54aa3fcd994507b5b7dd808630f56 100644 (file)
@@ -27,15 +27,15 @@ should unmount it with `umount`(8).
 
 # OPTIONS
 
--d, --debug
+-d, \--debug
 :   run in the foreground and print FUSE debug information
     for each request.
 
--f, --foreground
+-f, \--foreground
 :   run in the foreground and exit only when the filesystem
     is unmounted.
 
--o, --allow-other
+-o, \--allow-other
 :   permit other users to access the filesystem. Necessary for
     exporting the filesystem via Samba, for example.
 
index d5b32db6045a2b18add5558c738afc992144c632..261ae3118466b5316e5b9d1509bbf6dd55ec187d 100644 (file)
@@ -8,7 +8,7 @@ bup-import-rsnapshot - import a rsnapshot archive
 
 # SYNOPSIS
 
-bup import-rsnapshot [-n] <path to snapshot_root> [<backuptarget>]
+bup import-rsnapshot [-n] \<path to snapshot_root\> [\<backuptarget\>]
 
 # SYNOPSIS
 
@@ -21,7 +21,7 @@ or imports all backups only for a given backuptarget.
 
 # OPTIONS
 
--n,--dry-run
+-n, \--dry-run
 :   don't do anything just print out what would be done
 
 # EXAMPLES
index 4f7eafb334c1b423cf25731be54e20325bc2d9a9..959177789f6e8271f270bc28754ff41fe41f33cd 100644 (file)
@@ -8,9 +8,9 @@ bup-index - print and/or update the bup filesystem index
 
 # SYNOPSIS
 
-bup index <-p|-m|-s|-u> [-H] [-l] [-x] [--fake-valid]
-[--fake-invalid] [--check] [-f *indexfile*] [--exclude *path*]
-[--exclude-from *filename*] [-v] <filenames...>
+bup index \<-p|-m|-s|-u\> [-H] [-l] [-x] [\--fake-valid]
+[\--fake-invalid] [\--check] [-f *indexfile*] [\--exclude *path*]
+[\--exclude-from *filename*] [-v] \<filenames...\>
 
 # DESCRIPTION
 
@@ -42,24 +42,24 @@ need the same information).
 
 # MODES
 
--u, --update
+-u, \--update
 :   recursively update the index for the given filenames and
     their descendants.  One or more filenames must be
     given.  If no mode option is given, this is the
     default.
 
--p, --print
+-p, \--print
 :   print the contents of the index.  If filenames are
     given, shows the given entries and their descendants. 
     If no filenames are given, shows the entries starting
     at the current working directory (.).
     
--m, --modified
+-m, \--modified
 :   prints only files which are marked as modified (ie.
     changed since the most recent backup) in the index. 
     Implies `-p`.
 
--s, --status
+-s, \--status
 :   prepend a status code (A, M, D, or space) before each
     filename.  Implies `-p`.  The codes mean, respectively,
     that a file is marked in the index as added, modified,
@@ -68,7 +68,7 @@ need the same information).
 
 # OPTIONS
 
--H, --hash
+-H, \--hash
 :   for each file printed, prepend the most recently
     recorded hash code.  The hash code is normally
     generated by `bup save`.  For objects which have not yet
@@ -79,42 +79,42 @@ need the same information).
     the filesystem no longer matches the recorded hash). 
     If this is a problem for you, use `--status`.
     
--l, --long
+-l, \--long
 :   print more information about each file, in a similar
     format to the `-l` option to `ls`(1).
 
--x, --xdev, --one-file-system
+-x, \--xdev, \--one-file-system
 :   don't cross filesystem boundaries when recursing
     through the filesystem.  Only applicable if you're
     using `-u`.
     
---fake-valid
+\--fake-valid
 :   mark specified filenames as up-to-date even if they
     aren't.  This can be useful for testing, or to avoid
     unnecessarily backing up files that you know are
     boring.
     
---fake-invalid
+\--fake-invalid
 :   mark specified filenames as not up-to-date, forcing the
     next "bup save" run to re-check their contents.
     
---check
+\--check
 :   carefully check index file integrity before and after
     updating.  Mostly useful for automated tests.
 
--f, --indexfile=*indexfile*
+-f, \--indexfile=*indexfile*
 :   use a different index filename instead of
     `~/.bup/bupindex`.
 
---exclude=*path*
+\--exclude=*path*
 :   a path to exclude from the backup (can be used more
     than once)
 
---exclude-from=*filename*
+\--exclude-from=*filename*
 :   a file that contains exclude paths (can be used more
     than once)
 
--v, --verbose
+-v, \--verbose
 :   increase log output during update (can be used more
     than once).  With one `-v`, print each directory as it
     is updated; with two `-v`, print each file too.
index c53e7fbc8c146eec411a12e3acb96563da6a94ad..529e72304e8c2840de5e314b208e0e63a4202b23 100644 (file)
@@ -19,7 +19,7 @@ initialized automatically whenever you run any bup command.
 
 # OPTIONS
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   Initialize not only the local repository, but also the
     remote repository given by the *host* and *path*.  This is
     not necessary if you intend to back up to the default
index a16fbc0445b24e4f52a9cbce5debc4de4c32580a..b5332f10c07fff29095f41171c7a2955f36eb2b8 100644 (file)
@@ -25,7 +25,7 @@ join` reads them from stdin instead.
 
 # OPTIONS
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   Retrieves objects from the given remote repository
     instead of the local one. *path* may be blank, in which
     case the default remote repository is used.  The connection to the
index ed07ca64a1b61853e57d351950b06da4d4732312..443f1788f35efbe7525f9180e81b5fbeafa34c49 100644 (file)
@@ -8,7 +8,7 @@ bup-ls - list the contents of a bup repository
 
 # SYNOPSIS
 
-bup ls [-s] [-a] <paths...>
+bup ls [-s] [-a] \<paths...\>
 
 # DESCRIPTION
 
@@ -38,10 +38,10 @@ you can view its contents using `bup join` or `git show`.
 
 # OPTIONS
 
--s, --hash
+-s, \--hash
 :   show hash for each file/directory.
 
--a, --all
+-a, \--all
 :   show hidden files.
 
 # EXAMPLE
index 8f1ebeb60ee76f65c71a620856f569bab0eacde3..23f0ef1231fb3c3887b8e9603f04a08e71a1f2ae 100644 (file)
@@ -39,14 +39,14 @@ close to 160 bits.
 
 # OPTIONS
 
---predict
+\--predict
 :   Guess the offset into each index file where a
     particular object will appear, and report the maximum
     deviation of the correct answer from the guess.  This
     is potentially useful for tuning an interpolation
     search algorithm.
     
---ignore-midx
+\--ignore-midx
 :   don't use .midx files, use only .idx files.  This is
     only really useful when used with `--predict`.
 
index 1450d2bb00ca750bb2a6e0795cbd66bf12424bab..b7b467e23d3c03ae115a9eed528775aeacb24eed 100644 (file)
@@ -28,22 +28,22 @@ what causes an increase in the VmRSS column.
 
 # OPTIONS
 
--n, --number=*number*
+-n, \--number=*number*
 :   set the number of objects to search for during each
     cycle (ie. before printing a line of output)
     
--c, --cycles=*cycles*
+-c, \--cycles=*cycles*
 :   set the number of cycles (ie. the number of lines of
     output after the first).  The first line of output is
     always 0 (ie. the baseline before searching for any
     objects).
     
---ignore-midx
+\--ignore-midx
 :   ignore any `.midx` files created by `bup midx`.  This
     allows you to compare memory performance with and
     without using midx.
     
---existing
+\--existing
 :   search for existing objects instead of searching for
     random nonexistent ones.  This can greatly affect
     memory usage and performance.  Note that most of the
index 2c2ea67f1c30ccb76f60839cad25a1a356a15fcd..853d0977de67219c5a88bab7ceb9f87a464dbcab 100644 (file)
@@ -8,20 +8,20 @@ bup-meta - create or extract a metadata archive
 
 # SYNOPSIS
 
-bup meta \-\-create
-  ~ [-R] [-v] [-q] [\-\-no-symlinks] [\-\-no-paths] [-f *file*] \<*paths*...\>
+bup meta \--create
+  ~ [-R] [-v] [-q] [\--no-symlinks] [\--no-paths] [-f *file*] \<*paths*...\>
   
-bup meta \-\-list
+bup meta \--list
   ~ [-v] [-q] [-f *file*]
   
-bup meta \-\-extract
-  ~ [-v] [-q] [\-\-numeric-ids] [\-\-no-symlinks] [-f *file*]
+bup meta \--extract
+  ~ [-v] [-q] [\--numeric-ids] [\--no-symlinks] [-f *file*]
   
-bup meta \-\-start-extract
-  ~ [-v] [-q] [\-\-numeric-ids] [\-\-no-symlinks] [-f *file*]
+bup meta \--start-extract
+  ~ [-v] [-q] [\--numeric-ids] [\--no-symlinks] [-f *file*]
   
-bup meta \-\-finish-extract
-  ~ [-v] [-q] [\-\-numeric-ids] [-f *file*]
+bup meta \--finish-extract
+  ~ [-v] [-q] [\--numeric-ids] [-f *file*]
 
 # DESCRIPTION
 
@@ -31,62 +31,62 @@ access permissions, etc.) for a set of filesystem paths.
 
 # OPTIONS
 
--c, \-\-create
+-c, \--create
 :   Create a metadata archive for the specified *path*s.  Write the
-    archive to standard output unless **\-\-file** is specified.
+    archive to standard output unless `--file` is specified.
 
--t, \-\-list
+-t, \--list
 :   Display information about the metadata in an archive.  Read the
-    archive from standard output unless **\-\-file** is specified.
+    archive from standard output unless `--file` is specified.
 
--x, \-\-extract
-:   Extract a metadata archive.  Conceptually, perform **\-\-start-extract**
-    followed by **\-\-finish-extract**.  Read the archive from standard input
-    unless **\-\-file** is specified.
+-x, \--extract
+:   Extract a metadata archive.  Conceptually, perform `--start-extract`
+    followed by `--finish-extract`.  Read the archive from standard input
+    unless `--file` is specified.
 
-\-\-start-extract
+\--start-extract
 :   Build a filesystem tree matching the paths stored in a metadata
     archive.  By itself, this command does not produce a full
     restoration of the metadata.  For a full restoration, this command
-    must be followed by a call to **\-\-finish-extract**.  Once this
+    must be followed by a call to `--finish-extract`.  Once this
     command has finished, all of the normal files described by the
     metadata will exist and be empty.  Restoring the data in those
-    files, and then calling **\-\-finish-extract** should restore the
+    files, and then calling `--finish-extract` should restore the
     original tree.  The archive will be read from standard input
-    unless **\-\-file** is specified.
+    unless `--file` is specified.
 
-\-\-finish-extract
+\--finish-extract
 :   Finish applying the metadata stored in an archive to the
     filesystem.  Normally, this command should follow a call to
-    **\-\-start-extract**.  The archive will be read from standard input
-    unless **\-\-file** is specified.
+    `--start-extract`.  The archive will be read from standard input
+    unless `--file` is specified.
 
--f, \-\-file=*filename*
+-f, \--file=*filename*
 :   Read the metadata archive from *filename* or write it to
     *filename* as appropriate.  If *filename* is "-", then read from
     standard input or write to standard output.
 
--R, \-\-recurse
-:   Recursively descend into subdirectories during **\-\-create**.
+-R, \--recurse
+:   Recursively descend into subdirectories during `--create`.
 
-\-\-numeric-ids
+\--numeric-ids
 :   Apply numeric user and group IDs (rather than text IDs) during
-    **\-\-extract** or **\-\-finish-extract**.
+    `--extract` or `--finish-extract`.
 
-\-\-symlinks
+\--symlinks
 :   Record symbolic link targets when creating an archive, or restore
-    symbolic links when extracting an archive (during **\-\-extract**
-    or **\-\-start-extract**).  This option is enabled by default.
-    Specify **\-\-no-symlinks** to disable it.
+    symbolic links when extracting an archive (during `--extract`
+    or `--start-extract`).  This option is enabled by default.
+    Specify `--no-symlinks` to disable it.
 
-\-\-paths
+\--paths
 :   Record pathnames when creating an archive.  This option is enabled
-    by default.  Specify **\-\-no-paths** to disable it.
+    by default.  Specify `--no-paths` to disable it.
 
--v, --verbose
+-v, \--verbose
 :   Be more verbose (can be used more than once).
 
--q, --quiet
+-q, \--quiet
 :   Be quiet.
 
 # EXAMPLES
@@ -103,9 +103,9 @@ access permissions, etc.) for a set of filesystem paths.
 
     # Restore /etc completely.
     $ mkdir tmp && cd tmp
-    $ bup meta \-\-start-extract -f ../etc.meta
+    $ bup meta --start-extract -f ../etc.meta
     ...fill in all regular file contents using some other tool...
-    $ bup meta \-\-finish-extract -f ../etc.meta
+    $ bup meta --finish-extract -f ../etc.meta
 
 # BUGS
 
index 2b4a0c26d1584905a35961e8144f69702b2843a4..7c67a2dd0e20ac8503b0b9eff13d54392f7a2745 100644 (file)
@@ -8,7 +8,7 @@ bup-midx - create a multi-index (.midx) file from several .idx files
 
 # SYNOPSIS
 
-bup midx [-o *outfile*] <-a|-f|*idxnames*...>
+bup midx [-o *outfile*] \<-a|-f|*idxnames*...\>
 
 # DESCRIPTION
 
@@ -21,26 +21,26 @@ commands.
 
 # OPTIONS
 
--o, --output=*filename.midx*
+-o, \--output=*filename.midx*
 :   use the given output filename for the .midx file. 
     Default is auto-generated.
     
--a, --auto
+-a, \--auto
 :   automatically generate new .midx files for any .idx
     files where it would be appropriate.
     
--f, --force
+-f, \--force
 :   force generation of a single new .midx file containing
     *all* your .idx files, even if other .midx files
     already exist.  This will result in the fastest backup
     performance, but may take a long time to run.
 
---dir=*packdir*
+\--dir=*packdir*
 :   specify the directory containing the .idx/.midx files
     to work with.  The default is $BUP_DIR/objects/pack and
     $BUP_DIR/indexcache/*.
 
---max-files
+\--max-files
 :   maximum number of .idx files to open at a time.  You
     can use this if you have an especially small number of file
     descriptors available, so that midx can complete
@@ -48,7 +48,7 @@ commands.
     all your .idx files at once.  The default value of this
     option should be fine for most people.
     
---check
+\--check
 :   validate a .midx file by ensuring that all objects in
     its contained .idx files exist inside the .midx.  May
     be useful for debugging.
index 7a4c3e54d7bc17748ca8166a872bceb1d5b8c131..6ee67bdf0a4f8eb8b90dccb6c51391f606c1cbda 100644 (file)
@@ -8,7 +8,7 @@ bup-random - generate a stream of random output
 
 # SYNOPSIS
 
-bup random [-S seed] [-fv] <numbytes>
+bup random [-S seed] [-fv] \<numbytes\>
 
 # DESCRIPTION
 
@@ -31,24 +31,24 @@ can be helpful when running microbenchmarks.
 
 # OPTIONS
 
-<numbytes>
+\<numbytes\>
 :   the number of bytes of data to generate.  Can be used
     with the suffices `k`, `M`, or `G` to indicate
     kilobytes, megabytes, or gigabytes, respectively.
     
--S, --seed=*seed*
+-S, \--seed=*seed*
 :   use the given value to seed the pseudorandom number
     generator.  The generated output stream will be
     identical for every stream seeded with the same value. 
     The default seed is 1.  A seed value of 0 is equivalent
     to 1.
 
--f, --force
+-f, \--force
 :   generate output even if stdout is a tty.  (Generating
     random data to a tty is generally considered
     ill-advised, but you can do if you really want.)
     
--v, --verbose
+-v, \--verbose
 :   print a progress message showing the number of bytes that
     has been output so far.
 
index 8e2687dccbcbf8a86c01d0918ef0f70109126251..f5a2ad4050c9b9001c78962824057f540772f6f9 100644 (file)
@@ -8,7 +8,7 @@ bup-restore - extract files from a backup set
 
 # SYNOPSIS
 
-bup restore [--outdir=*outdir*] [-v] [-q] <paths...>
+bup restore [\--outdir=*outdir*] [-v] [-q] \<paths...\>;
 
 # DESCRIPTION
 
@@ -21,7 +21,7 @@ path are as follows:
 
 branch
 :   the name of the backup set to restore from; this
-    corresponds to the --name (-n) option to `bup save`.
+    corresponds to the `--name` (`-n`) option to `bup save`.
 
 revision
 :   the revision of the backup set to restore.  The
@@ -48,16 +48,16 @@ this works.
 
 # OPTIONS
 
--C, --outdir=*outdir*
+-C, \--outdir=*outdir*
 :   create and change to directory *outdir* before
     extracting the files.
 
--v, --verbose
+-v, \--verbose
 :   increase log output.  Given once, prints every
     directory as it is restored; given twice, prints every
     file and directory.
 
--q, --quiet
+-q, \--quiet
 :   don't show the progress meter.  Normally, is stderr is
     a tty, a progress display is printed that shows the
     total number of files restored.
index 2dcd21a7e6c12784e6c6611183334620e431555f..091618c957192185e10a94a4ce8d4e7116877cf6 100644 (file)
@@ -8,8 +8,8 @@ bup-save - create a new bup backup set
 
 # SYNOPSIS
 
-bup save [-r *host*:*path*] <-t|-c|-n *name*> [-#] [-f *indexfile*]
-[-v] [-q] [--smaller=*maxsize*] <paths...>
+bup save [-r *host*:*path*] \<-t|-c|-n *name*\> [-#] [-f *indexfile*]
+[-v] [-q] [\--smaller=*maxsize*] \<paths...\>;
 
 # DESCRIPTION
 
@@ -23,7 +23,7 @@ for `bup-index`(1).
 
 # OPTIONS
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   save the backup set to 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
@@ -31,15 +31,15 @@ for `bup-index`(1).
     or private key to use for the SSH connection, we recommend you use the
     `~/.ssh/config` file.
 
--t, --tree
+-t, \--tree
 :   after creating the backup set, print out the git tree
     id of the resulting backup.
     
--c, --commit
+-c, \--commit
 :   after creating the backup set, print out the git commit
     id of the resulting backup.
 
--n, --name=*name*
+-n, \--name=*name*
 :   after creating the backup set, create a git branch
     named *name* so that the backup can be accessed using
     that name.  If *name* already exists, the new backup
@@ -48,23 +48,23 @@ for `bup-index`(1).
     the same name, and later view the history of that
     backup set to see how files have changed over time.)
 
--d, --date=*date*
+-d, \--date=*date*
 :   specify the date of the backup, in seconds since the epoch, instead
     of the current time.
 
--f, --indexfile=*indexfile*
+-f, \--indexfile=*indexfile*
 :   use a different index filename instead of
     `~/.bup/bupindex`.
 
--v, --verbose
+-v, \--verbose
 :   increase verbosity (can be used more than once).  With
     one -v, prints every directory name as it gets backed up.  With
     two -v, also prints every filename.
 
--q, --quiet
+-q, \--quiet
 :   disable progress messages.
 
---smaller=*maxsize*
+\--smaller=*maxsize*
 :   don't back up files >= *maxsize* bytes.  You can use
     this to run frequent incremental backups of your small
     files, which can usually be backed up quickly, and skip
@@ -74,37 +74,37 @@ for `bup-index`(1).
     specify multiples of 1024, 1024*1024, 1024*1024*1024
     respectively.
     
---bwlimit=*bytes/sec*
+\--bwlimit=*bytes/sec*
 :   don't transmit more than *bytes/sec* bytes per second
     to the server.  This is good for making your backups
     not suck up all your network bandwidth.  Use a suffix
     like k, M, or G to specify multiples of 1024,
     1024*1024, 1024*1024*1024 respectively.
     
---strip
+\--strip
 :   strips the path that is given from all files and directories.
     
     A directory */root/chroot/etc* saved with
-    "bup save -n chroot --strip /root/chroot" would be saved
+    "bup save -n chroot \--strip /root/chroot" would be saved
     as */etc*.
     
---strip-path=*path-prefix*
+\--strip-path=*path-prefix*
 :   strips the given path prefix *path-prefix* from all
     files and directories.
     
     A directory */root/chroots/webserver* saved with
-    "bup save -n webserver --strip-path=/root/chroots" would
+    "bup save -n webserver \--strip-path=/root/chroots" would
     be saved as */webserver/etc*
     
---graft=*old_path*=*new_path*
+\--graft=*old_path*=*new_path*
 :   a graft point *old_path*=*new_path* (can be used more than
     once).
 
     A directory */root/chroot/a/etc* saved with
-    "bup save -n chroots --graft /root/chroot/a/etc=/chroots/a"
+    "bup save -n chroots \--graft /root/chroot/a/etc=/chroots/a"
     would be saved as */chroots/a/etc*
 
--*#*, --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 eba57ea0cf3dad3518c0316d58e6b85cc37f2368..4382b6c1a636a927583696d8703e8230d4f1d273 100644 (file)
@@ -8,10 +8,10 @@ bup-split - save individual files to bup backup sets
 
 # SYNOPSIS
 
-bup split [-r *host*:*path*] <-b|-t|-c|-n *name*> [-v] [-q]
-  [--bench] [--max-pack-size=*bytes*] [-#]
-  [--max-pack-objects=*n*] [--fanout=*count]
-  [--git-ids] [--keep-boundaries] [filenames...]
+bup split [-r *host*:*path*] \<-b|-t|-c|-n *name*\> [-v] [-q]
+  [\--bench] [\--max-pack-size=*bytes*] [-#]
+  [\--max-pack-objects=*n*] [\--fanout=*count]
+  [\--git-ids] [\--keep-boundaries] [filenames...]
 
 # DESCRIPTION
 
@@ -43,7 +43,7 @@ To get the data back, use `bup-join`(1).
 
 # OPTIONS
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   save the backup set to 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
@@ -51,17 +51,17 @@ To get the data back, use `bup-join`(1).
     or private key to use for the SSH connection, we recommend you use the
     `~/.ssh/config` file.
 
--b, --blobs
+-b, \--blobs
 :   output a series of git blob ids that correspond to the
     chunks in the dataset.
 
--t, --tree
+-t, \--tree
 :   output the git tree id of the resulting dataset.
     
--c, --commit
+-c, \--commit
 :   output the git commit id of the resulting dataset.
 
--n, --name=*name*
+-n, \--name=*name*
 :   after creating the dataset, create a git branch
     named *name* so that it can be accessed using
     that name.  If *name* already exists, the new dataset
@@ -70,13 +70,13 @@ To get the data back, use `bup-join`(1).
     the same name, and later view the history of that
     dataset to see how it has changed over time.)
     
--q, --quiet
+-q, \--quiet
 :   disable progress messages.
 
--v, --verbose
+-v, \--verbose
 :   increase verbosity (can be used more than once).
 
---git-ids
+\--git-ids
 :   stdin is a list of git object ids instead of raw data.
     `bup split` will read the contents of each named git
     object (if it exists in the bup repository) and split
@@ -85,7 +85,7 @@ To get the data back, use `bup-join`(1).
     hashsplitting instead.  This option is probably most
     useful when combined with `--keep-boundaries`.
 
---keep-boundaries
+\--keep-boundaries
 :   if multiple filenames are given on the command line,
     they are normally concatenated together as if the
     content all came from a single file.  That is, the
@@ -97,43 +97,43 @@ To get the data back, use `bup-join`(1).
     only one of the files; the end of one of the input
     files always ends a blob.
 
---noop
+\--noop
 :   read the data and split it into blocks based on the "bupsplit"
     rolling checksum algorithm, but don't do anything with
     the blocks.  This is mostly useful for benchmarking.
 
---copy
-:   like --noop, but also write the data to stdout.  This
+\--copy
+:   like `--noop`, but also write the data to stdout.  This
     can be useful for benchmarking the speed of read+bupsplit+write
     for large amounts of data.
 
---bench
+\--bench
 :   print benchmark timings to stderr.
 
---max-pack-size=*bytes*
+\--max-pack-size=*bytes*
 :   never create git packfiles larger than the given number
     of bytes.  Default is 1 billion bytes.  Usually there
     is no reason to change this.
 
---max-pack-objects=*numobjs*
+\--max-pack-objects=*numobjs*
 :   never create git packfiles with more than the given
     number of objects.  Default is 200 thousand objects. 
     Usually there is no reason to change this.
     
---fanout=*numobjs*
+\--fanout=*numobjs*
 :   when splitting very large files, never put more than
     this number of git blobs in a single git tree.  Instead,
     generate a new tree and link to that.  Default is
     4096 objects per tree.
 
---bwlimit=*bytes/sec*
+\--bwlimit=*bytes/sec*
 :   don't transmit more than *bytes/sec* bytes per second
     to the server.  This is good for making your backups
     not suck 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 77b04ff0ec61a0f07709845796d57b80e482db1a..25339b228eb8104e694e32f49ba7ec9edf555f07 100644 (file)
@@ -40,7 +40,7 @@ through /.tag/important as long as the tag is not deleted.
 
 # OPTIONS
 
--d, --delete
+-d, \--delete
 :   delete a tag
 
 # EXAMPLE
index 560e0d63cac3412b6a3dead9ae74763bb3dcafda..79fca64d0e6f86cb86ce3e433ec310e780236b47 100644 (file)
@@ -26,11 +26,11 @@ pages.
 
 # GLOBAL OPTIONS
 
---version
+\--version
 :   print bup's version number.  Equivalent to
     `bup-version`(1)
 
--d, --bup-dir=*BUP_DIR*
+-d, \--bup-dir=*BUP_DIR*
 :   use the given BUP_DIR parameter as the bup repository
     location, instead of reading it from the $BUP_DIR
     environment variable or using the default `~/.bup`