Also documenting common flags in subcommands

This commit is contained in:
Dennis Schwerdel 2017-05-17 08:58:54 +02:00
parent ca28d3ebff
commit 645022ce9c
23 changed files with 507 additions and 173 deletions

View File

@ -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)

View File

@ -39,11 +39,27 @@ key will be set as default encryption key.
This setting requires that `--generate` is set too.
* `-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

View File

@ -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

View File

@ -18,11 +18,26 @@ running _zvault-vacuum(1)_ with different ratios.
## OPTIONS
* `-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

View File

@ -113,11 +113,26 @@ restore and access times change by reading files.
in the backup.
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
## EXCLUDE PATTERNS
Exclude patterns can either be absolute patterns or relative patterns. Absolute

View File

@ -19,11 +19,26 @@ names on the remote storage that do not relate to the bundle id.
## OPTIONS
* `-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

View File

@ -16,11 +16,26 @@ given its bundle id.
## OPTIONS
* `-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

View File

@ -83,11 +83,26 @@ has become inaccessible.
Try to repair broken bundles, backups and rebuild local data when necessary.
* `-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

View File

@ -66,11 +66,26 @@ data and can be changed at any time without any drawback.
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

View File

@ -17,11 +17,26 @@ If `repository` is omitted, the default repository location is used instead.
## OPTIONS
* `-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

View File

@ -25,11 +25,26 @@ modified (_mod_).
## OPTIONS
* `-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

View File

@ -18,11 +18,27 @@ writes it to the given file `FILE`.
Derive the key pair from the given password instead of randomly creating it.
* `-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

View File

@ -33,11 +33,26 @@ imported via _zvault-backup(1)_ also with the `--tar` flag.
times.
* `-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

View File

@ -17,11 +17,26 @@ The repository, backup or backup subtree given by `PATH` must be in the format
## OPTIONS
* `-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

View File

@ -69,6 +69,27 @@ configuration can be changed by _zvault-config(1)_ later.
at this location.
* `-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

View File

@ -28,11 +28,26 @@ filesystem which is faster than _zvault-list(1)_ for multiple listings.
## OPTIONS
* `-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

View File

@ -30,11 +30,26 @@ this way is slower than using _zvault-restore(1)_.
## OPTIONS
* `-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

View File

@ -82,11 +82,26 @@ data of the deleted backups becomes inaccessible and can not be restored.**
Actually remove backups instead of displaying what would be removed.
* `-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

View File

@ -40,11 +40,26 @@ data of the deleted backups becomes inaccessible and can not be restored.**
Remove multiple backups in a backup folder
* `-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

View File

@ -32,11 +32,26 @@ If `--tar` is not set, the data will be written into the existing folder `DST`.
zvault-backup(1) with the `--tar` flag.
* `-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

View File

@ -59,11 +59,26 @@ should be avoided when the storage space permits it.
Actually run the vacuum instead of simulating it.
* `-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

View File

@ -20,11 +20,26 @@ earliest backup that version appeared in.
## OPTIONS
* `-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

View File

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