summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2010-03-13 19:49:52 +0100
committerGravatar Martin Szulecki2010-03-13 19:49:52 +0100
commitc25847a1f2628b5d769814dd42b2c7d501c322e6 (patch)
tree29cafbd829e79e0b89eed1027f7138c3987af6b6 /docs
parentc01f740e26a5c0ac2aa13200cacd50890f125c06 (diff)
downloadlibimobiledevice-c25847a1f2628b5d769814dd42b2c7d501c322e6.tar.gz
libimobiledevice-c25847a1f2628b5d769814dd42b2c7d501c322e6.tar.bz2
Add man pages for tools
Diffstat (limited to 'docs')
-rw-r--r--docs/idevice_id.149
-rw-r--r--docs/idevicebackup.136
-rw-r--r--docs/ideviceimagemounter.141
-rw-r--r--docs/ideviceinfo.135
-rw-r--r--docs/idevicescreenshot.129
-rw-r--r--docs/idevicesyslog.126
6 files changed, 216 insertions, 0 deletions
diff --git a/docs/idevice_id.1 b/docs/idevice_id.1
new file mode 100644
index 0000000..c06fb5e
--- /dev/null
+++ b/docs/idevice_id.1
@@ -0,0 +1,49 @@
1.TH "idevice_id" 1
2.SH NAME
3idevice_id \- Prints device name or a list of attached iPhone/iPod Touch devices.
4.SH SYNOPSIS
5.B idevice_id
6[OPTIONS] [UUID]
7
8.SH DESCRIPTION
9
10Prints device name or a list of attached iPhone/iPod Touch devices.
11The UUID is a 40-digit hexadecimal number of the device
12for which the name should be retrieved.
13
14.SH OPTIONS
15.TP
16.B \-l, \-\-list
17list UUID of all attached devices
18.TP
19.B \-d, \-\-debug
20enable communication debugging.
21.TP
22.B \-h, \-\-help
23prints usage information.
24.TP
25
26.SH AUTHORS
27 Zach C.
28
29 Jonathan Beck
30
31 Matt Colyer
32
33 Martin Aumueller
34
35 Christophe Fergeau
36
37 Martin S.
38
39 Paul Sladen
40
41 Patrick Walton
42
43 Zoltan Balaton
44
45 Nikias Bassen
46
47 Todd Zullinger
48
49Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1
new file mode 100644
index 0000000..5ae867e
--- /dev/null
+++ b/docs/idevicebackup.1
@@ -0,0 +1,36 @@
1.TH "idevicebackup" 1
2.SH NAME
3idevicebackup \- Create or restore backup for iPhone/iPod Touch devices.
4.SH SYNOPSIS
5.B idevicebackup
6[OPTIONS] CMD [DIRECTORY]
7
8.SH DESCRIPTION
9
10Create or restore backup from the current or specified directory.
11
12.SH OPTIONS
13.TP
14.B \-u, \-\-uuid UUID
15target specific device by its 40-digit device UUID.
16.TP
17.B \-d, \-\-debug
18enable communication debugging.
19.TP
20.B \-h, \-\-help
21prints usage information.
22
23.SH COMMANDS
24.TP
25.B backup
26saves a device backup into DIRECTORY.
27.TP
28.B restore
29restores a device backup from DIRECTORY.
30
31.SH AUTHORS
32Martin Szulecki
33
34Nikias Bassen
35
36Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1
new file mode 100644
index 0000000..55d81e9
--- /dev/null
+++ b/docs/ideviceimagemounter.1
@@ -0,0 +1,41 @@
1.TH "ideviceimagemounter" 1
2.SH NAME
3ideviceimagemounter \- Mount disk images on the iPhone/iPod Touch.
4.SH SYNOPSIS
5.B ideviceimagemounter
6[OPTIONS] IMAGE_FILE IMAGE_SIGNATURE_FILE
7
8.SH DESCRIPTION
9
10Mounts the specified disk image on the iPhone/iPod Touch device.
11
12.SH OPTIONS
13.TP
14.B \-d, \-\-debug
15enable communication debugging.
16.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID.
19.TP
20.B \-l, \-\-list
21list mount information
22.TP
23.B \-t, \-\-imagetype NAME
24the image type to use, default is 'Developer'
25.TP
26.B \-x, \-\-xml
27use XML output
28.TP
29.B \-h, \-\-help
30prints usage information
31.TP
32.B IMAGE_FILE
33the image filename to mount
34.TP
35.B IMAGE_SIGNATURE_FILE
36corresponding signature file for image filename
37
38.SH AUTHOR
39Nikias Bassen
40
41Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/ideviceinfo.1 b/docs/ideviceinfo.1
new file mode 100644
index 0000000..e350dd0
--- /dev/null
+++ b/docs/ideviceinfo.1
@@ -0,0 +1,35 @@
1.TH "ideviceinfo" 1
2.SH NAME
3ideviceinfo \- Show information about the first connected iPhone/iPod Touch.
4.SH SYNOPSIS
5.B ideviceinfo
6[OPTIONS]
7
8.SH DESCRIPTION
9
10Show information about the first connected iPhone/iPod Touch.
11
12.SH OPTIONS
13.TP
14.B \-d, \-\-debug
15enable communication debugging.
16.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID.
19.TP
20.B \-q, \-\-domain NAME
21set domain of query to NAME. Default: None.
22.TP
23.B \-k, \-\-key NAME
24only query key specified by NAME. Default: All keys.
25.TP
26.B \-x, \-\-xml
27output information as xml plist instead of key/value pairs.
28.TP
29.B \-h, \-\-help
30prints usage information
31
32.SH AUTHOR
33Martin Szulecki
34
35Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicescreenshot.1 b/docs/idevicescreenshot.1
new file mode 100644
index 0000000..cf0ed15
--- /dev/null
+++ b/docs/idevicescreenshot.1
@@ -0,0 +1,29 @@
1.TH "idevicescreenshot" 1
2.SH NAME
3idevicescreenshot \- Gets a screenshot from the connected iPhone/iPod Touch.
4.SH SYNOPSIS
5.B idevicescreenshot
6[OPTIONS]
7
8.SH DESCRIPTION
9
10Gets a screenshot from the connected iPhone/iPod Touch.
11
12NOTE: A mounted developer disk image is required on the device, otherwise
13 the screenshotr service is not available.
14
15.SH OPTIONS
16.TP
17.B \-d, \-\-debug
18enable communication debugging.
19.TP
20.B \-u, \-\-uuid UUID
21target specific device by its 40-digit device UUID.
22.TP
23.B \-h, \-\-help
24prints usage information
25
26.SH AUTHOR
27Nikias Bassen
28
29Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1
new file mode 100644
index 0000000..178d7c5
--- /dev/null
+++ b/docs/idevicesyslog.1
@@ -0,0 +1,26 @@
1.TH "idevicesyslog" 1
2.SH NAME
3idevicesyslog \- Relay syslog of a connected iPhone/iPod Touch.
4.SH SYNOPSIS
5.B idevicesyslog
6[OPTIONS]
7
8.SH DESCRIPTION
9
10Relay syslog of a connected iPhone/iPod Touch.
11
12.SH OPTIONS
13.TP
14.B \-d, \-\-debug
15enable communication debugging.
16.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID
19.TP
20.B \-h, \-\-help
21prints usage information.
22
23.SH AUTHOR
24Martin Szulecki
25
26Man page written to conform with Debian by Julien Lavergne.