diff options
author | Martin Szulecki | 2012-09-08 16:05:01 +0200 |
---|---|---|
committer | Martin Szulecki | 2012-10-21 14:19:50 +0200 |
commit | 71840e12059b2ea84bb7ec31877c2d05a2c3aed0 (patch) | |
tree | c7467cfd4436c26631186035e84163d70b41d281 | |
parent | 9c760c9563b88d6f5ce352a79181f33b8329c6f8 (diff) | |
download | libimobiledevice-71840e12059b2ea84bb7ec31877c2d05a2c3aed0.tar.gz libimobiledevice-71840e12059b2ea84bb7ec31877c2d05a2c3aed0.tar.bz2 |
Add manpages for new tools
-rw-r--r-- | docs/Makefile.am | 2 | ||||
-rw-r--r-- | docs/idevicedebugserverproxy.1 | 34 | ||||
-rw-r--r-- | docs/idevicediagnostics.1 | 51 | ||||
-rw-r--r-- | docs/ideviceprovision.1 | 41 |
4 files changed, 127 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index d15ba09..22fa4ff 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 idevicebackup2.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 +man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 idevicebackup2.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 ideviceprovision.1 idevicedebugserverproxy.1 idevicediagnostics.1 EXTRA_DIST = $(man_MANS) diff --git a/docs/idevicedebugserverproxy.1 b/docs/idevicedebugserverproxy.1 new file mode 100644 index 0000000..46dfeb7 --- /dev/null +++ b/docs/idevicedebugserverproxy.1 @@ -0,0 +1,34 @@ +.TH "idevicedebugserverproxy" 1 +.SH NAME +idevicedebugserverproxy \- Remote debugging proxy. +.SH SYNOPSIS +.B idevicedebugserverproxy +[OPTIONS] PORT + +.SH DESCRIPTION + +Proxy a debugserver connection from a device for remote debugging. +After starting up, clients can connect to PORT and communicate with the remote +debugserver using the LLVM remote serial debugging protocol. +Thus connecting using LLDB or a LLVM based gdb to this port would allow +remote debugging. +The developer disk image needs to be mounted for this service to be available. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by its 40-digit device UDID. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP +.B \-h, \-\-help +prints usage information. + +.SH USAGE +.TP +.B PORT +The port under which the proxy should listen for connections from clients. + +.SH AUTHORS +Martin Szulecki diff --git a/docs/idevicediagnostics.1 b/docs/idevicediagnostics.1 new file mode 100644 index 0000000..2098955 --- /dev/null +++ b/docs/idevicediagnostics.1 @@ -0,0 +1,51 @@ +.TH "idevicediagnostics" 1 +.SH NAME +idevicediagnostics \- Interact with the diagnostics interface of a device. +.SH SYNOPSIS +.B idevicediagnostics +[OPTIONS] COMMAND + +.SH DESCRIPTION + +Interact with the diagnostics interface of a device which allows to retrive +all kinds of information including diagnostics data, mobilegestalt data, remote +access to the IORegistry and certain commands like restart, shutdown and sleep. +Only available for iOS 4 and later. Accessing IORegistry is only supported on +iOS 5 and later. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by its 40-digit device UDID. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP +.B \-h, \-\-help +prints usage information. + +.SH COMMANDS +.TP +.B diagnostics [TYPE] +print diagnostics information from device optionally by TYPE. This includes +"All", "WiFi", "GasGauge" or "NAND". Default is "All". +.TP +.B mobilegestalt KEY [...] +print values of mobilegestalt keys passed as arguments after the command and +seperated by a space. +.TP +.B ioreg [PLANE] +print IORegistry of device, optionally by PLANE like "IODeviceTree", "IOPower" + or "IOService". Only available on iOS 5 and later. +.TP +.B shutdown +shutdown device +.TP +.B restart +restart device +.TP +.B sleep +put device into sleep mode which also disconnects it from the host. + +.SH AUTHORS +Martin Szulecki diff --git a/docs/ideviceprovision.1 b/docs/ideviceprovision.1 new file mode 100644 index 0000000..e48ea91 --- /dev/null +++ b/docs/ideviceprovision.1 @@ -0,0 +1,41 @@ +.TH "ideviceprovision" 1 +.SH NAME +ideviceprovision \- Manage provisioning profiles on a device. +.SH SYNOPSIS +.B ideviceprovision +[OPTIONS] COMMAND + +.SH DESCRIPTION + +Manage provisioning profiles on a device. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by its 40-digit device UDID. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP +.B \-h, \-\-help +prints usage information. + +.SH COMMANDS +.TP +.B install FILE +Install the provisioning profile specified by FILE. A valid ".mobileprovision" +file is expected. +.TP +.B list +Get a list of all provisioning profiles on the device. +.TP +.B copy PATH +Retrieves all provisioning profiles from the device and stores them into the +existing directory specified by PATH. The files will be stored +as "UUID.mobileprovision". +.TP +.B remove UUID +Removes the provisioning profile identified by UUID. + +.SH AUTHORS +Nikias Bassen |