diff options
Diffstat (limited to 'docs/idevicebackup2.1')
-rw-r--r-- | docs/idevicebackup2.1 | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1 new file mode 100644 index 0000000..79b6dc4 --- /dev/null +++ b/docs/idevicebackup2.1 | |||
@@ -0,0 +1,104 @@ | |||
1 | .TH "idevicebackup2" 1 | ||
2 | .SH NAME | ||
3 | idevicebackup2 \- Create or restore backups for devices running iOS 4 or later. | ||
4 | .SH SYNOPSIS | ||
5 | .B idevicebackup2 | ||
6 | [OPTIONS] CMD [CMDOPTIONS] DIRECTORY | ||
7 | |||
8 | .SH DESCRIPTION | ||
9 | |||
10 | Create or restore backup in/from the specified directory. | ||
11 | |||
12 | .SH OPTIONS | ||
13 | .TP | ||
14 | .B \-u, \-\-udid UDID | ||
15 | target specific device by UDID. | ||
16 | .TP | ||
17 | .B \-s, \-\-source UDID | ||
18 | use backup data from device specified by UDID. | ||
19 | .TP | ||
20 | .B \-i, \-\-interactive | ||
21 | request passwords interactively on the command line. | ||
22 | .TP | ||
23 | .B \-n, \-\-network | ||
24 | connect to network device. | ||
25 | .TP | ||
26 | .B \-d, \-\-debug | ||
27 | enable communication debugging. | ||
28 | .TP | ||
29 | .B \-h, \-\-help | ||
30 | prints usage information. | ||
31 | .TP | ||
32 | .B \-v, \-\-version | ||
33 | prints version information. | ||
34 | |||
35 | .SH COMMANDS | ||
36 | .TP | ||
37 | .B backup | ||
38 | create backup for the device. | ||
39 | .TP | ||
40 | .B \t\-\-full | ||
41 | force full backup from device. | ||
42 | .TP | ||
43 | .B restore | ||
44 | restore last backup to the device. | ||
45 | .TP | ||
46 | .B \t\-\-system | ||
47 | restore system files, too. | ||
48 | .TP | ||
49 | .B \t\-\-no\-reboot | ||
50 | do NO reboot the system when done. | ||
51 | .TP | ||
52 | .B \t\-\-copy | ||
53 | create a copy of backup folder before restoring. | ||
54 | .TP | ||
55 | .B \t\-\-settings | ||
56 | restore device settings from the backup. | ||
57 | .TP | ||
58 | .B \t\-\-remove | ||
59 | remove items which are not being restored. | ||
60 | .TP | ||
61 | .B \t\-\-skip-apps | ||
62 | do not trigger re-installation of apps after restore. | ||
63 | .TP | ||
64 | .B \t\-\-password PWD | ||
65 | supply the password for the encrypted source backup. If omitted, the password | ||
66 | will be requested in interactive mode (\f[B]\-i\f[]), or it can be passed using | ||
67 | the environment variable \f[B]BACKUP_PASSWORD\f[]. | ||
68 | .TP | ||
69 | .B info | ||
70 | show details about last completed backup of device. | ||
71 | .TP | ||
72 | .B list | ||
73 | list files of last completed backup in CSV format. | ||
74 | .TP | ||
75 | .B unback | ||
76 | unpack a completed backup in DIRECTORY/_unback_/ | ||
77 | .TP | ||
78 | .B encryption on|off [PWD] | ||
79 | enable or disable backup encryption. The password will be requested in | ||
80 | interactive mode (\f[B]\-i\f[]) if omitted, or it can be passed using the | ||
81 | environment variable \f[B]BACKUP_PASSWORD\f[]. | ||
82 | .TP | ||
83 | .B changepw [OLD NEW] | ||
84 | change backup password on target device. The passwords will be requested in | ||
85 | interactive mode (\f[B]\-i\f[]) if omitted, or they can be passed using the | ||
86 | environment variables \f[B]BACKUP_PASSWORD\f[] (old password) and | ||
87 | \f[B]BACKUP_PASSWORD_NEW\f[] (new password) respectively. | ||
88 | .TP | ||
89 | .B cloud on|off | ||
90 | enable or disable cloud use (requires iCloud account). | ||
91 | .SH SECURITY CONSIDERATIONS | ||
92 | Passing passwords on the command line is not advised, since it might reveal | ||
93 | the backup password to other users via process list or command line history. | ||
94 | Use interactive mode (\f[B]\-i\f[]) or pass them via environment variable(s) | ||
95 | as mentioned in the description of the respective commands above. | ||
96 | .SH AUTHORS | ||
97 | Martin Szulecki | ||
98 | |||
99 | Nikias Bassen | ||
100 | |||
101 | .SH ON THE WEB | ||
102 | https://libimobiledevice.org | ||
103 | |||
104 | https://github.com/libimobiledevice/libimobiledevice | ||