diff --git a/CHANGELOG.md b/CHANGELOG.md index 766213d..28021d9 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/docs/man/zvault-addkey.1.md b/docs/man/zvault-addkey.1.md index 764c99b..9f44f5d 100644 --- a/docs/man/zvault-addkey.1.md +++ b/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 `: +* `-p`, `--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 diff --git a/docs/man/zvault-algotest.1.md b/docs/man/zvault-algotest.1.md index b87701f..f3fc6df 100644 --- a/docs/man/zvault-algotest.1.md +++ b/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 diff --git a/docs/man/zvault-analyze.1.md b/docs/man/zvault-analyze.1.md index af6e4f9..8703bce 100644 --- a/docs/man/zvault-analyze.1.md +++ b/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 diff --git a/docs/man/zvault-backup.1.md b/docs/man/zvault-backup.1.md index a1d6e2c..66b74b7 100644 --- a/docs/man/zvault-backup.1.md +++ b/docs/man/zvault-backup.1.md @@ -45,77 +45,92 @@ restore and access times change by reading files. ## OPTIONS - * `-e`, `--exclude ...`: +* `-e`, `--exclude ...`: - 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 `: +* `--excludes-from `: - 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 `: - 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 diff --git a/docs/man/zvault-bundleinfo.1.md b/docs/man/zvault-bundleinfo.1.md index edd2c4f..cdea19e 100644 --- a/docs/man/zvault-bundleinfo.1.md +++ b/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 diff --git a/docs/man/zvault-bundlelist.1.md b/docs/man/zvault-bundlelist.1.md index 3f441aa..2e02263 100644 --- a/docs/man/zvault-bundlelist.1.md +++ b/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 diff --git a/docs/man/zvault-check.1.md b/docs/man/zvault-check.1.md index 33fa0f0..6a337bd 100644 --- a/docs/man/zvault-check.1.md +++ b/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 diff --git a/docs/man/zvault-config.1.md b/docs/man/zvault-config.1.md index b35fb47..8abe871 100644 --- a/docs/man/zvault-config.1.md +++ b/docs/man/zvault-config.1.md @@ -25,50 +25,65 @@ data and can be changed at any time without any drawback. ## OPTIONS - * `--bundle-size `: +* `--bundle-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 `: - 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 `: +* `-c`, `--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 `: +* `-e`, `--encryption `: - 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 `: - 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 diff --git a/docs/man/zvault-copy.1.md b/docs/man/zvault-copy.1.md index cd82943..08e2e8e 100644 --- a/docs/man/zvault-copy.1.md +++ b/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 diff --git a/docs/man/zvault-diff.1.md b/docs/man/zvault-diff.1.md index a62a121..0b5c2f4 100644 --- a/docs/man/zvault-diff.1.md +++ b/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 diff --git a/docs/man/zvault-genkey.1.md b/docs/man/zvault-genkey.1.md index 21dffdf..9a4a84d 100644 --- a/docs/man/zvault-genkey.1.md +++ b/docs/man/zvault-genkey.1.md @@ -14,13 +14,29 @@ writes it to the given file `FILE`. ## OPTIONS - * `-p`, `--password `: +* `-p`, `--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 diff --git a/docs/man/zvault-import.1.md b/docs/man/zvault-import.1.md index 8e6ec9c..8706793 100644 --- a/docs/man/zvault-import.1.md +++ b/docs/man/zvault-import.1.md @@ -25,17 +25,32 @@ imported via _zvault-backup(1)_ also with the `--tar` flag. ## OPTIONS - * `-k`, `--key ...`: +* `-k`, `--key ...`: - 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 diff --git a/docs/man/zvault-info.1.md b/docs/man/zvault-info.1.md index e2e75ac..259ef94 100644 --- a/docs/man/zvault-info.1.md +++ b/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 diff --git a/docs/man/zvault-init.1.md b/docs/man/zvault-init.1.md index bf729e5..55b845f 100644 --- a/docs/man/zvault-init.1.md +++ b/docs/man/zvault-init.1.md @@ -25,48 +25,69 @@ configuration can be changed by _zvault-config(1)_ later. ## OPTIONS - * `--bundle-size `: +* `--bundle-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 `: - 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 `: +* `-c`, `--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 `: - 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 `: +* `-r`, `--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 diff --git a/docs/man/zvault-list.1.md b/docs/man/zvault-list.1.md index 1543d8c..6912529 100644 --- a/docs/man/zvault-list.1.md +++ b/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 diff --git a/docs/man/zvault-mount.1.md b/docs/man/zvault-mount.1.md index a8bbc49..2a49c72 100644 --- a/docs/man/zvault-mount.1.md +++ b/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 diff --git a/docs/man/zvault-prune.1.md b/docs/man/zvault-prune.1.md index 047c3f7..7b0be15 100644 --- a/docs/man/zvault-prune.1.md +++ b/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 `: +* `-p`, `--prefix `: - Only consider backups starting with this prefix. + Only consider backups starting with this prefix. - * `-d`, `--daily `: +* `-d`, `--daily `: - Keep the newest backup for each of the last `NUM` days. + Keep the newest backup for each of the last `NUM` days. - * `-w`, `--weekly `: +* `-w`, `--weekly `: - Keep the newest backup for each of the last `NUM` weeks. + Keep the newest backup for each of the last `NUM` weeks. - * `-m`, `--monthly `: +* `-m`, `--monthly `: - Keep the newest backup for each of the last `NUM` months. + Keep the newest backup for each of the last `NUM` months. - * `-y`, `--yearly `: +* `-y`, `--yearly `: - 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 diff --git a/docs/man/zvault-remove.1.md b/docs/man/zvault-remove.1.md index f767c2a..8fba4f8 100644 --- a/docs/man/zvault-remove.1.md +++ b/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 diff --git a/docs/man/zvault-restore.1.md b/docs/man/zvault-restore.1.md index bc8549a..72ff294 100644 --- a/docs/man/zvault-restore.1.md +++ b/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 diff --git a/docs/man/zvault-vacuum.1.md b/docs/man/zvault-vacuum.1.md index cce7432..42bb329 100644 --- a/docs/man/zvault-vacuum.1.md +++ b/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 `: +* `-r`, `--ratio `: - 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 diff --git a/docs/man/zvault-versions.1.md b/docs/man/zvault-versions.1.md index e7dd169..e7153e8 100644 --- a/docs/man/zvault-versions.1.md +++ b/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 diff --git a/docs/man/zvault.1.md b/docs/man/zvault.1.md index ee5bea3..02d57e1 100644 --- a/docs/man/zvault.1.md +++ b/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