summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2015-09-06 18:18:24 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2015-09-06 18:18:24 +0200
commitb3f5231bac387741aad790b6840697a24695d61c (patch)
tree27a0fc893998f3f5633c4d351009905280f87940 /docs
parent17c43948960110cbea4a5dcd746e286482b1aa20 (diff)
BORG_REPO env var support
sets the default repository to use, e.g. like: export BORG_REPO=/mnt/backup/repo borg init borg create ::archive borg list borg mount :: /mnt fusermount -u /mnt borg delete ::archive
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 8595ca7f8..882ba469b 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: