summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTW <tw@waldmann-edv.de>2015-09-06 21:51:24 +0200
committerTW <tw@waldmann-edv.de>2015-09-06 21:51:24 +0200
commit947fc095d85a3fba7313a5afbbabd2d2ce33121f (patch)
tree1aae8c5899e8378a7733220d8bcc4c5f744933f5 /docs
parent70d97c4467ce5c0d51f115aed7b4796edf174e35 (diff)
parent817ce18bc6c1f9507e4ce70169d73bf7ae7769e2 (diff)
Merge pull request #183 from ThomasWaldmann/borg-repo-envvar
BORG_REPO env var support
Diffstat (limited to 'docs')
-rw-r--r--docs/usage.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/usage.rst b/docs/usage.rst
index 27c258504..0ce547b93 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -41,9 +41,15 @@ Environment Variables
|project_name| uses some environment variables for automation:
-Specifying a passphrase:
+General:
+ BORG_REPO
+ When set, use the value to give the default repository location. If a command needs an archive
+ parameter, you can abbreviate as `::archive`. If a command needs a repository parameter, you
+ can either leave it away or abbreviate as `::`, if a positional parameter is required.
BORG_PASSPHRASE
When set, use the value to answer the passphrase question for encrypted repositories.
+ TMPDIR
+ where temporary files are stored (might need a lot of temporary space for some operations)
Some "yes" sayers (if set, they automatically confirm that you really want to do X even if there is that warning):
BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK
@@ -64,10 +70,6 @@ Building:
BORG_OPENSSL_PREFIX
Adds given OpenSSL header file directory to the default locations (setup.py).
-General:
- TMPDIR
- where temporary files are stored (might need a lot of temporary space for some operations)
-
Please note: