From c18b119a9b216510906cdddcf09b7f7111b6f97d Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Thu, 1 Oct 2020 00:14:34 +0200 Subject: [PATCH] Document new option --repository-file --- doc/030_preparing_a_new_repo.rst | 6 ++++-- doc/040_backup.rst | 2 +- doc/manual_rest.rst | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index 28c79217f..d7907645a 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -22,8 +22,10 @@ other options. You can skip to the next chapter once you've read the relevant section here. For automated backups, restic accepts the repository location in the -environment variable ``RESTIC_REPOSITORY``. For the password, several options -exist: +environment variable ``RESTIC_REPOSITORY``. Restic can also read the repository +location from a file specified via the ``--repository-file`` option or the +environment variable ``RESTIC_REPOSITORY_FILE``. For the password, several +options exist: * Setting the environment variable ``RESTIC_PASSWORD`` diff --git a/doc/040_backup.rst b/doc/040_backup.rst index 3c0152569..970038930 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -407,7 +407,7 @@ environment variables. The following lists these environment variables: .. code-block:: console - RESTIC_REPOSITORY_FILE Name of a file containing the location of the repository (replaces --repository-file) + RESTIC_REPOSITORY_FILE Name of file containing the repository location (replaces --repository-file) RESTIC_REPOSITORY Location of repository (replaces -r) RESTIC_PASSWORD_FILE Location of password file (replaces --password-file) RESTIC_PASSWORD The actual password for the repository diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index ea9e0673a..b0fd44a60 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -60,6 +60,7 @@ Usage help is available: -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) + --repository-file file file to read the repository location from (default: $RESTIC_REPOSITORY_FILE) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key -v, --verbose n be verbose (specify --verbose multiple times or level --verbose=n) @@ -122,6 +123,7 @@ command: -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) + --repository-file file file to read the repository location from (default: $RESTIC_REPOSITORY_FILE) --tls-client-cert file path to a file containing PEM encoded TLS client certificate and private key -v, --verbose n be verbose (specify --verbose multiple times or level --verbose=n)