Browse Source

Also documenting common flags in subcommands

pull/10/head
Dennis Schwerdel 5 years ago
parent
commit
645022ce9c
  1. 1
      CHANGELOG.md
  2. 34
      docs/man/zvault-addkey.1.md
  3. 15
      docs/man/zvault-algotest.1.md
  4. 19
      docs/man/zvault-analyze.1.md
  5. 101
      docs/man/zvault-backup.1.md
  6. 19
      docs/man/zvault-bundleinfo.1.md
  7. 19
      docs/man/zvault-bundlelist.1.md
  8. 35
      docs/man/zvault-check.1.md
  9. 65
      docs/man/zvault-config.1.md
  10. 19
      docs/man/zvault-copy.1.md
  11. 19
      docs/man/zvault-diff.1.md
  12. 24
      docs/man/zvault-genkey.1.md
  13. 29
      docs/man/zvault-import.1.md
  14. 19
      docs/man/zvault-info.1.md
  15. 67
      docs/man/zvault-init.1.md
  16. 19
      docs/man/zvault-list.1.md
  17. 19
      docs/man/zvault-mount.1.md
  18. 43
      docs/man/zvault-prune.1.md
  19. 23
      docs/man/zvault-remove.1.md
  20. 29
      docs/man/zvault-restore.1.md
  21. 33
      docs/man/zvault-vacuum.1.md
  22. 19
      docs/man/zvault-versions.1.md
  23. 10
      docs/man/zvault.1.md

1
CHANGELOG.md

@ -5,6 +5,7 @@ This project follows [semantic versioning](http://semver.org).
### UNRELEASED
* [added] Added `copy` subcommand
* [modified] Also documenting common flags in subcommands
### v0.3.2 (2017-05-11)

34
docs/man/zvault-addkey.1.md

@ -23,25 +23,41 @@ key will be set as default encryption key.
## OPTIONS
* `-g`, `--generate`:
* `-g`, `--generate`:
Generate a new key pair
Generate a new key pair
* `-d`, `--default`:
* `-d`, `--default`:
Set the key pair as default
Set the key pair as default
* `-p`, `--password <PASSWORD>`:
* `-p`, `--password <PASSWORD>`:
Derive the key pair from the given password instead of randomly creating it.
This setting requires that `--generate` is set too.
Derive the key pair from the given password instead of randomly creating it.
This setting requires that `--generate` is set too.
* `-h`, `--help`:
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
Prints help information
## COPYRIGHT

15
docs/man/zvault-algotest.1.md

@ -62,11 +62,26 @@ The options are exactly the same as for _zvault-init(1)_.
values.
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT
Copyright (C) 2017 Dennis Schwerdel

19
docs/man/zvault-analyze.1.md

@ -18,9 +18,24 @@ running _zvault-vacuum(1)_ with different ratios.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

101
docs/man/zvault-backup.1.md

@ -45,77 +45,92 @@ restore and access times change by reading files.
## OPTIONS
* `-e`, `--exclude <PATTERN>...`:
* `-e`, `--exclude <PATTERN>...`:
Exclude this path or file pattern. This option can be given multiple times.
Please see *EXCLUDE PATTERNS* for details on pattern.
Exclude this path or file pattern. This option can be given multiple times.
Please see *EXCLUDE PATTERNS* for details on pattern.
This option conflicts with `--tar`.
This option conflicts with `--tar`.
* `--excludes-from <FILE>`:
* `--excludes-from <FILE>`:
Read the list of excludes from this file.
Please see *EXCLUDE PATTERNS* for details on pattern.
Read the list of excludes from this file.
Please see *EXCLUDE PATTERNS* for details on pattern.
This option conflicts with `--tar`.
This option conflicts with `--tar`.
* `--full`:
* `--full`:
Create a full backup without using another backup as a reference. This makes
sure that all files in the source path (except excluded files) are fully
read. The file contents will still be deduplicated by using existing backups
but all files are read fully.
Create a full backup without using another backup as a reference. This makes
sure that all files in the source path (except excluded files) are fully
read. The file contents will still be deduplicated by using existing backups
but all files are read fully.
This option conflicts with `--ref`.
This option conflicts with `--ref`.
* `--no-default-excludes`:
* `--no-default-excludes`:
Do not load the default `excludes` file from the repository folder.
Those excludes are pre-filled with generic pattern to exclude like pseudo
filesystems or cache folders.
Do not load the default `excludes` file from the repository folder.
Those excludes are pre-filled with generic pattern to exclude like pseudo
filesystems or cache folders.
* `--ref <REF>`:
* `--ref <REF>`:
Base the new backup on this reference backup instead of automatically
selecting a matching one. The backup given as `REF` must be a valid backup
name as listed by zvault-list(1).
Base the new backup on this reference backup instead of automatically
selecting a matching one. The backup given as `REF` must be a valid backup
name as listed by zvault-list(1).
This option conflicts with `--full`.
This option conflicts with `--full`.
* `--tar`:
* `--tar`:
Read the source data from a tar archive instead of the filesystem. When this
flag is set, the `SRC` path must specify a valid tar file.
The contents of the archive are then read instead of the filesystem. Note
that the tar file contents are read as files and directories and not just
as a single file (this would happen when `SRC` is a tar file and `--tar` is
not set).
Read the source data from a tar archive instead of the filesystem. When this
flag is set, the `SRC` path must specify a valid tar file.
The contents of the archive are then read instead of the filesystem. Note
that the tar file contents are read as files and directories and not just
as a single file (this would happen when `SRC` is a tar file and `--tar` is
not set).
This option can be used to import a backup that has been exported using
zvault-restore(1) with the `--tar` flag.
This option can be used to import a backup that has been exported using
zvault-restore(1) with the `--tar` flag.
This flag conflicts with `--exclude` and `--excludes_from`.
This flag conflicts with `--exclude` and `--excludes_from`.
* `-x`, `--xdev`:
* `-x`, `--xdev`:
Allow to cross filesystem boundaries. By default, paths on different
filesystems than the start path will be ignored. If this flag is set,
the scan will traverse also into mounted filesystems.
**Note:** Please use this option with case. Some pseudo filesystems
contain arbitrarily deep nested directories that will send zVault into
an infinite loop. Also it should be avoided to include the remote storage
in the backup.
Allow to cross filesystem boundaries. By default, paths on different
filesystems than the start path will be ignored. If this flag is set,
the scan will traverse also into mounted filesystems.
**Note:** Please use this option with case. Some pseudo filesystems
contain arbitrarily deep nested directories that will send zVault into
an infinite loop. Also it should be avoided to include the remote storage
in the backup.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## EXCLUDE PATTERNS

19
docs/man/zvault-bundleinfo.1.md

@ -19,9 +19,24 @@ names on the remote storage that do not relate to the bundle id.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-bundlelist.1.md

@ -16,9 +16,24 @@ given its bundle id.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

35
docs/man/zvault-check.1.md

@ -62,30 +62,45 @@ has become inaccessible.
## OPTIONS
* `-b`, `--bundles`:
* `-b`, `--bundles`:
Check the integrity of the bundles too.
* `--bundle-data`:
* `--bundle-data`:
Also check the contents of the bundles by fetching and decompressing them.
Note: This flag causes the check to be much slower.
Also check the contents of the bundles by fetching and decompressing them.
Note: This flag causes the check to be much slower.
* `-i`, `--index`:
* `-i`, `--index`:
Also check the integrity of the index and its contents.
Also check the integrity of the index and its contents.
* `-r`, `--repair`:
* `-r`, `--repair`:
Try to repair broken bundles, backups and rebuild local data when necessary.
Try to repair broken bundles, backups and rebuild local data when necessary.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

65
docs/man/zvault-config.1.md

@ -25,50 +25,65 @@ data and can be changed at any time without any drawback.
## OPTIONS
* `--bundle-size <SIZE>`:
* `--bundle-size <SIZE>`:
Set the target bundle size in MiB (default: 25).
Please see _zvault(1)_ for more information on *bundle size*.
Set the target bundle size in MiB (default: 25).
Please see _zvault(1)_ for more information on *bundle size*.
* `--chunker <CHUNKER>`:
* `--chunker <CHUNKER>`:
Set the chunker algorithm and target chunk size (default: fastcdc/16).
Please see _zvault(1)_ for more information on *chunkers* and possible
values.
Set the chunker algorithm and target chunk size (default: fastcdc/16).
Please see _zvault(1)_ for more information on *chunkers* and possible
values.
* `-c`, `--compression <COMPRESSION>`:
* `-c`, `--compression <COMPRESSION>`:
Set the compression method and level (default: brotli/3).
Please see _zvault(1)_ for more information on *compression* and possible
values.
Set the compression method and level (default: brotli/3).
Please see _zvault(1)_ for more information on *compression* and possible
values.
* `-e`, `--encryption <PUBLIC_KEY>`:
* `-e`, `--encryption <PUBLIC_KEY>`:
Use the given public key for encryption. The key must be a valid public key
encoded as hexadecimal. Please use _zvault-genkey(1)_ to generate keys and
_zvault-addkey(1)_ to add keys to the repository.
Use the given public key for encryption. The key must be a valid public key
encoded as hexadecimal. Please use _zvault-genkey(1)_ to generate keys and
_zvault-addkey(1)_ to add keys to the repository.
If `none` is given as public key, encryption is deactivated.
If `none` is given as public key, encryption is deactivated.
**Warning:** ZVault does not verify that the matching secret key which is
needed for decryption is known.
**Warning:** ZVault does not verify that the matching secret key which is
needed for decryption is known.
Please see _zvault(1)_ for more information on *encryption*.
Please see _zvault(1)_ for more information on *encryption*.
* `--hash <HASH>`:
* `--hash <HASH>`:
Set the hash method (default: blake2).
Please see _zvault(1)_ for more information on *hash methods* and possible
values.
Set the hash method (default: blake2).
Please see _zvault(1)_ for more information on *hash methods* and possible
values.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-copy.1.md

@ -17,9 +17,24 @@ If `repository` is omitted, the default repository location is used instead.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-diff.1.md

@ -25,9 +25,24 @@ modified (_mod_).
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

24
docs/man/zvault-genkey.1.md

@ -14,13 +14,29 @@ writes it to the given file `FILE`.
## OPTIONS
* `-p`, `--password <PASSWORD>`:
* `-p`, `--password <PASSWORD>`:
Derive the key pair from the given password instead of randomly creating it.
Derive the key pair from the given password instead of randomly creating it.
* `-h`, `--help`:
Prints help information
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

29
docs/man/zvault-import.1.md

@ -25,17 +25,32 @@ imported via _zvault-backup(1)_ also with the `--tar` flag.
## OPTIONS
* `-k`, `--key <FILE>...`:
* `-k`, `--key <FILE>...`:
Add the key pair in the given file to the repository before importing the
remote bundles. This option can be used to add keys that are needed to read
the bundles. If multiple keys are needed, this options can be given multiple
times.
Add the key pair in the given file to the repository before importing the
remote bundles. This option can be used to add keys that are needed to read
the bundles. If multiple keys are needed, this options can be given multiple
times.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-info.1.md

@ -17,9 +17,24 @@ The repository, backup or backup subtree given by `PATH` must be in the format
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

67
docs/man/zvault-init.1.md

@ -25,48 +25,69 @@ configuration can be changed by _zvault-config(1)_ later.
## OPTIONS
* `--bundle-size <SIZE>`:
* `--bundle-size <SIZE>`:
Set the target bundle size in MiB (default: 25).
Please see zvault(1) for more information on *bundle size*.
Set the target bundle size in MiB (default: 25).
Please see zvault(1) for more information on *bundle size*.
* `--chunker <CHUNKER>`:
* `--chunker <CHUNKER>`:
Set the chunker algorithm and target chunk size (default: fastcdc/16).
Please see _zvault(1)_ for more information on *chunkers* and possible
values.
Set the chunker algorithm and target chunk size (default: fastcdc/16).
Please see _zvault(1)_ for more information on *chunkers* and possible
values.
* `-c`, `--compression <COMPRESSION>`:
* `-c`, `--compression <COMPRESSION>`:
Set the compression method and level (default: brotli/3).
Please see _zvault(1)_ for more information on *compression* and possible
values.
Set the compression method and level (default: brotli/3).
Please see _zvault(1)_ for more information on *compression* and possible
values.
* `-e`, `--encrypt`:
* `-e`, `--encrypt`:
Generate a keypair and enable encryption.
Please see _zvault(1)_ for more information on *encryption*.
Generate a keypair and enable encryption.
Please see _zvault(1)_ for more information on *encryption*.
* `--hash <HASH>`:
* `--hash <HASH>`:
Set the hash method (default: blake2).
Please see _zvault(1)_ for more information on *hash methods* and possible
values.
Set the hash method (default: blake2).
Please see _zvault(1)_ for more information on *hash methods* and possible
values.
* `-h`, `--help`:
* `-h`, `--help`:
Prints help information
Prints help information
* `-r`, `--remote <REMOTE>`:
* `-r`, `--remote <REMOTE>`:
Set the path to the mounted remote storage. There should be an empty folder
at this location.
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
Set the path to the mounted remote storage. There should be an empty folder
at this location.
## COPYRIGHT

19
docs/man/zvault-list.1.md

@ -28,9 +28,24 @@ filesystem which is faster than _zvault-list(1)_ for multiple listings.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-mount.1.md

@ -30,9 +30,24 @@ this way is slower than using _zvault-restore(1)_.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

43
docs/man/zvault-prune.1.md

@ -52,39 +52,54 @@ data of the deleted backups becomes inaccessible and can not be restored.**
## OPTIONS
* `-p`, `--prefix <PREFIX>`:
* `-p`, `--prefix <PREFIX>`:
Only consider backups starting with this prefix.
Only consider backups starting with this prefix.
* `-d`, `--daily <NUM>`:
* `-d`, `--daily <NUM>`:
Keep the newest backup for each of the last `NUM` days.
Keep the newest backup for each of the last `NUM` days.
* `-w`, `--weekly <NUM>`:
* `-w`, `--weekly <NUM>`:
Keep the newest backup for each of the last `NUM` weeks.
Keep the newest backup for each of the last `NUM` weeks.
* `-m`, `--monthly <NUM>`:
* `-m`, `--monthly <NUM>`:
Keep the newest backup for each of the last `NUM` months.
Keep the newest backup for each of the last `NUM` months.
* `-y`, `--yearly <NUM>`:
* `-y`, `--yearly <NUM>`:
Keep the newest backup for each of the last `NUM` years.
Keep the newest backup for each of the last `NUM` years.
* `-f`, `--force`:
* `-f`, `--force`:
Actually remove backups instead of displaying what would be removed.
Actually remove backups instead of displaying what would be removed.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

23
docs/man/zvault-remove.1.md

@ -35,14 +35,29 @@ data of the deleted backups becomes inaccessible and can not be restored.**
## OPTIONS
* `-f`, `--force`:
* `-f`, `--force`:
Remove multiple backups in a backup folder
Remove multiple backups in a backup folder
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

29
docs/man/zvault-restore.1.md

@ -23,18 +23,33 @@ If `--tar` is not set, the data will be written into the existing folder `DST`.
## OPTIONS
* `--tar`:
* `--tar`:
Write the backup to a tar archive named `DST` instead of creating files and
folders at this location.
Write the backup to a tar archive named `DST` instead of creating files and
folders at this location.
This option can be used to export a backup that can be imported again using
zvault-backup(1) with the `--tar` flag.
This option can be used to export a backup that can be imported again using
zvault-backup(1) with the `--tar` flag.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

33
docs/man/zvault-vacuum.1.md

@ -43,25 +43,40 @@ should be avoided when the storage space permits it.
## OPTIONS
* `--combine`:
* `--combine`:
Also combine small bundles into larger ones.
Also combine small bundles into larger ones.
* `-r`, `--ratio <NUM>`:
* `-r`, `--ratio <NUM>`:
Do not rewrite bundles with more than `NUM`% of used chunks.
The ratio must be given in whole percentage, e.g. 50 mean 50%.
Do not rewrite bundles with more than `NUM`% of used chunks.
The ratio must be given in whole percentage, e.g. 50 mean 50%.
* `-f`, `--force`:
* `-f`, `--force`:
Actually run the vacuum instead of simulating it.
Actually run the vacuum instead of simulating it.
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

19
docs/man/zvault-versions.1.md

@ -20,9 +20,24 @@ earliest backup that version appeared in.
## OPTIONS
* `-h`, `--help`:
* `-q`, `--quiet`:
Prints help information
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## COPYRIGHT

10
docs/man/zvault.1.md

@ -18,6 +18,16 @@ location.
## OPTIONS
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information

Loading…
Cancel
Save