X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=Documentation%2Fbup-damage.md;h=e5c65c6065534a02dacb963fac1097feee6b1ffe;hb=HEAD;hp=868902d492ecc54acc4ae3f0abce8a80fe69abc6;hpb=d05d9df50c50ac944c81338a274b775b9972100f;p=bup.git diff --git a/Documentation/bup-damage.md b/Documentation/bup-damage.md index 868902d..e5c65c6 100644 --- a/Documentation/bup-damage.md +++ b/Documentation/bup-damage.md @@ -8,8 +8,8 @@ bup-damage - randomly destroy blocks of a file # SYNOPSIS -bup damage [-n count] [-s maxsize] [--percent pct] [-S seed] -[--equal] +bup damage [-n count] [-s maxsize] [\--percent pct] [-S seed] +[\--equal] \ # 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 @@ -71,10 +71,9 @@ actually work. recovery block. (This is also guaranteed if you use `-s 1`.) -# EXAMPLE - +# EXAMPLES # make a backup in case things go horribly wrong - cp -a ~/.bup/objects/pack ~/bup-packs.bak + cp -pPR ~/.bup/objects/pack ~/bup-packs.bak # generate recovery blocks for all packs bup fsck -g