From 311ad2d2d0fb7e517d2c29ef63bfdbdf06f0f645 Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Sat, 19 Sep 2020 15:47:32 +0200 Subject: [PATCH] Improve wording for --password-file and related options --- cmd/restic/cmd_copy.go | 2 +- cmd/restic/cmd_key.go | 2 +- cmd/restic/global.go | 2 +- doc/manual_rest.rst | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/restic/cmd_copy.go b/cmd/restic/cmd_copy.go index 926e3035d..08fc2387d 100644 --- a/cmd/restic/cmd_copy.go +++ b/cmd/restic/cmd_copy.go @@ -46,7 +46,7 @@ func init() { f := cmdCopy.Flags() f.StringVarP(©Options.Repo, "repo2", "", os.Getenv("RESTIC_REPOSITORY2"), "destination repository to copy snapshots to (default: $RESTIC_REPOSITORY2)") - f.StringVarP(©Options.PasswordFile, "password-file2", "", os.Getenv("RESTIC_PASSWORD_FILE2"), "read the destination repository password from a file (default: $RESTIC_PASSWORD_FILE2)") + f.StringVarP(©Options.PasswordFile, "password-file2", "", os.Getenv("RESTIC_PASSWORD_FILE2"), "`file` to read the destination repository password from (default: $RESTIC_PASSWORD_FILE2)") f.StringVarP(©Options.KeyHint, "key-hint2", "", os.Getenv("RESTIC_KEY_HINT2"), "key ID of key to try decrypting the destination repository first (default: $RESTIC_KEY_HINT2)") f.StringVarP(©Options.PasswordCommand, "password-command2", "", os.Getenv("RESTIC_PASSWORD_COMMAND2"), "shell `command` to obtain the destination repository password from (default: $RESTIC_PASSWORD_COMMAND2)") diff --git a/cmd/restic/cmd_key.go b/cmd/restic/cmd_key.go index 360ffb484..d14ba400e 100644 --- a/cmd/restic/cmd_key.go +++ b/cmd/restic/cmd_key.go @@ -42,7 +42,7 @@ func init() { cmdRoot.AddCommand(cmdKey) flags := cmdKey.Flags() - flags.StringVarP(&newPasswordFile, "new-password-file", "", "", "the file from which to load a new password") + flags.StringVarP(&newPasswordFile, "new-password-file", "", "", "`file` from which to read the new password") flags.StringVarP(&keyUsername, "user", "", "", "the username for new keys") flags.StringVarP(&keyHostname, "host", "", "", "the hostname for new keys") } diff --git a/cmd/restic/global.go b/cmd/restic/global.go index 0c1c51ac3..6d96702e4 100644 --- a/cmd/restic/global.go +++ b/cmd/restic/global.go @@ -101,7 +101,7 @@ func init() { f := cmdRoot.PersistentFlags() f.StringVarP(&globalOptions.Repo, "repo", "r", os.Getenv("RESTIC_REPOSITORY"), "`repository` to backup to or restore from (default: $RESTIC_REPOSITORY)") - f.StringVarP(&globalOptions.PasswordFile, "password-file", "p", os.Getenv("RESTIC_PASSWORD_FILE"), "read the repository password from a `file` (default: $RESTIC_PASSWORD_FILE)") + f.StringVarP(&globalOptions.PasswordFile, "password-file", "p", os.Getenv("RESTIC_PASSWORD_FILE"), "`file` to read the repository password from (default: $RESTIC_PASSWORD_FILE)") f.StringVarP(&globalOptions.KeyHint, "key-hint", "", os.Getenv("RESTIC_KEY_HINT"), "`key` ID of key to try decrypting first (default: $RESTIC_KEY_HINT)") f.StringVarP(&globalOptions.PasswordCommand, "password-command", "", os.Getenv("RESTIC_PASSWORD_COMMAND"), "shell `command` to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)") f.BoolVarP(&globalOptions.Quiet, "quiet", "q", false, "do not output comprehensive progress report") diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 529d30c59..ea9e0673a 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -57,7 +57,7 @@ Usage help is available: --no-lock do not lock the repo, this allows some operations on read-only repos -o, --option key=value set extended option (key=value, can be specified multiple times) --password-command command shell command to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) - -p, --password-file file read the repository password from a file (default: $RESTIC_PASSWORD_FILE) + -p, --password-file file file to read the repository password from (default: $RESTIC_PASSWORD_FILE) -q, --quiet do not output comprehensive progress report -r, --repo repository repository to backup to or restore from (default: $RESTIC_REPOSITORY) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key @@ -119,7 +119,7 @@ command: --no-lock do not lock the repo, this allows some operations on read-only repos -o, --option key=value set extended option (key=value, can be specified multiple times) --password-command command shell command to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) - -p, --password-file file read the repository password from a file (default: $RESTIC_PASSWORD_FILE) + -p, --password-file file file to read the repository password from (default: $RESTIC_PASSWORD_FILE) -q, --quiet do not output comprehensive progress report -r, --repo repository repository to backup to or restore from (default: $RESTIC_REPOSITORY) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key