summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2022-04-22 12:05:34 +0200
committerGravatar Nikias Bassen2022-04-22 12:05:34 +0200
commit1f625b2e89b27c391a8c2f4aa9a82630f10abb92 (patch)
tree477d38b68d417f9577e89fd4baf74768a1b3ecc4 /docs
parent7a0aedc97c66025d678afee66e735b6e3dcf0b9c (diff)
downloadlibimobiledevice-1f625b2e89b27c391a8c2f4aa9a82630f10abb92.tar.gz
libimobiledevice-1f625b2e89b27c391a8c2f4aa9a82630f10abb92.tar.bz2
idevicebackup2: Allow passing backup password via environment variable
Diffstat (limited to 'docs')
-rw-r--r--docs/idevicebackup2.118
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1
index ba5ef53..74d1c68 100644
--- a/docs/idevicebackup2.1
+++ b/docs/idevicebackup2.1
@@ -62,7 +62,9 @@ remove items which are not being restored.
do not trigger re-installation of apps after restore.
.TP
.B \t\-\-password PWD
-supply the password of the source backup.
+supply the password for the encrypted source backup. If omitted, the password
+will be requested in interactive mode (\f[B]\-i\f[]), or it can be passed using
+the environment variable \f[B]BACKUP_PASSWORD\f[].
.TP
.B info
show details about last completed backup of device.
@@ -74,13 +76,23 @@ list files of last completed backup in CSV format.
unpack a completed backup in DIRECTORY/_unback_/
.TP
.B encryption on|off [PWD]
-enable or disable backup encryption.
+enable or disable backup encryption. The password will be requested in
+interactive mode (\f[B]\-i\f[]) if omitted, or it can be passed using the
+environment variable \f[B]BACKUP_PASSWORD\f[].
.TP
.B changepw [OLD NEW]
-change backup password on target device.
+change backup password on target device. The passwords will be requested in
+interactive mode (\f[B]\-i\f[]) if omitted, or they can be passed using the
+environment variables \f[B]BACKUP_PASSWORD\f[] (old password) and
+\f[B]BACKUP_PASSWORD_NEW\f[] (new password) respectively.
.TP
.B cloud on|off
enable or disable cloud use (requires iCloud account).
+.SH SECURITY CONSIDERATIONS
+Passing passwords on the command line is not advised, since it might reveal
+the backup password to other users via process list or command line history.
+Use interactive mode (\f[B]\-i\f[]) or pass them via environment variable(s)
+as mentioned in the description of the respective commands above.
.SH AUTHORS
Martin Szulecki