KurlesHS/restic
1
0
Fork 0
forked from TrueCloudLab/restic
Code Pull requests Activity

Update usage help output in doc/manual_rest.rst

Browse source 
The usage help in the documentation was outdated relative to current version (0.8.0) with some commands outdated and some missing.
This commit is contained in:
zertrin 2017-12-04 22:57:00 +08:00 committed by GitHub
parent 9d0f13c4c0
commit 2253a73837
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
doc/manual_rest.rst
View file

@ -16,18 +16,19 @@ Usage help is available:
restic [command] restic [command]
Available Commands: Available Commands:
autocomplete Generate shell autocompletion script
backup Create a new backup of files and/or directories backup Create a new backup of files and/or directories
cat Print internal objects to stdout cat Print internal objects to stdout
check Check the repository for errors check Check the repository for errors
dump Dump data structures dump Print a backed-up file to stdout
find Find a file or directory find Find a file or directory
forget Remove snapshots from the repository forget Remove snapshots from the repository
generate Generate manual pages and auto-completion files (bash, zsh)
help Help about any command help Help about any command
init Initialize a new repository init Initialize a new repository
key Manage keys (passwords) key Manage keys (passwords)
list List items in the repository list List objects in the repository
ls List files in a snapshot ls List files in a snapshot
migrate Apply migrations
mount Mount the repository mount Mount the repository
prune Remove unneeded data from the repository prune Remove unneeded data from the repository
rebuild-index Build a new index file rebuild-index Build a new index file
@ -38,14 +39,22 @@ Usage help is available:
version Print version information version Print version information
Flags: Flags:
--cacert stringSlice path to load root certificates from (default: use system certificates)
--cache-dir string set the cache directory
-h, --help help for restic
--json set output mode to JSON for commands that support it --json set output mode to JSON for commands that support it
--limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited)
--limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited)
--no-cache do not use a local cache
--no-lock do not lock the repo, this allows some operations on read-only repos --no-lock do not lock the repo, this allows some operations on read-only repos
-p, --password-file string read the repository password from a file -o, --option key=value set extended option (key=value, can be specified multiple times)
-p, --password-file string read the repository password from a file (default: $RESTIC_PASSWORD_FILE)
-q, --quiet do not output comprehensive progress report -q, --quiet do not output comprehensive progress report
-r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY) -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)
Use "restic [command] --help" for more information about a command. Use "restic [command] --help" for more information about a command.
Similar to programs such as ``git``, restic has a number of Similar to programs such as ``git``, restic has a number of
sub-commands. You can see these commands in the listing above. Each sub-commands. You can see these commands in the listing above. Each
sub-command may have own command-line options, and there is a help sub-command may have own command-line options, and there is a help
@ -62,21 +71,31 @@ command:
restic backup [flags] FILE/DIR [FILE/DIR] ... restic backup [flags] FILE/DIR [FILE/DIR] ...
Flags: Flags:
-e, --exclude pattern exclude a pattern (can be specified multiple times) -e, --exclude pattern exclude a pattern (can be specified multiple times)
--exclude-file string read exclude patterns from a file --exclude-caches excludes cache directories that are marked with a CACHEDIR.TAG file
--files-from string read the files to backup from file (can be combined with file args) --exclude-file file read exclude patterns from a file (can be specified multiple times)
-f, --force force re-reading the target files/directories. Overrides the "parent" flag --exclude-if-present stringArray takes filename[:header], exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)
-x, --one-file-system Exclude other file systems --files-from string read the files to backup from file (can be combined with file args)
--parent string use this parent snapshot (default: last snapshot in the repo that has the same target files/directories) -f, --force force re-reading the target files/directories (overrides the "parent" flag)
--stdin read backup from stdin -h, --help help for backup
--stdin-filename string file name to use when reading from stdin --hostname hostname set the hostname for the snapshot manually. To prevent an expensive rescan use the "parent" flag
--tag tag add a tag for the new snapshot (can be specified multiple times) -x, --one-file-system exclude other file systems
--time string time of the backup (ex. '2012-11-01 22:08:41') (default: now) --parent string use this parent snapshot (default: last snapshot in the repo that has the same target files/directories)
--stdin read backup from stdin
--stdin-filename string file name to use when reading from stdin (default "stdin")
--tag tag add a tag for the new snapshot (can be specified multiple times)
--time string time of the backup (ex. '2012-11-01 22:08:41') (default: now)
Global Flags: Global Flags:
--cacert stringSlice path to load root certificates from (default: use system certificates)
--cache-dir string set the cache directory
--json set output mode to JSON for commands that support it --json set output mode to JSON for commands that support it
--limit-download int limits downloads to a maximum rate in KiB/s. (default: unlimited)
--limit-upload int limits uploads to a maximum rate in KiB/s. (default: unlimited)
--no-cache do not use a local cache
--no-lock do not lock the repo, this allows some operations on read-only repos --no-lock do not lock the repo, this allows some operations on read-only repos
-p, --password-file string read the repository password from a file -o, --option key=value set extended option (key=value, can be specified multiple times)
-p, --password-file string read the repository password from a file (default: $RESTIC_PASSWORD_FILE)
-q, --quiet do not output comprehensive progress report -q, --quiet do not output comprehensive progress report
-r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY) -r, --repo string repository to backup to or restore from (default: $RESTIC_REPOSITORY)