summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am2
-rw-r--r--docs/idevicedebug.134
2 files changed, 35 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 826105a..e9fc21c 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 ideviceprovision.1 idevicedebugserverproxy.1 idevicediagnostics.1 idevicecrashreport.1 idevicename.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 idevicecrashreport.1 idevicename.1 idevicedebug.1
EXTRA_DIST = $(man_MANS)
diff --git a/docs/idevicedebug.1 b/docs/idevicedebug.1
new file mode 100644
index 0000000..aa9890a
--- /dev/null
+++ b/docs/idevicedebug.1
@@ -0,0 +1,34 @@
+.TH "idevicedebug" 1
+.SH NAME
+idevicedebug \- Interact with the debugserver service of a device.
+.SH SYNOPSIS
+.B idevicedebug
+[OPTIONS] COMMAND
+
+.SH DESCRIPTION
+
+Interact with the debug service of a device. Currently the only implemented
+command is "run" and allows execution of developer apps and watch the
+stdout/stderr of the process.
+
+.SH OPTIONS
+.TP
+.B \-e, \-\-env NAME=VALUE
+set environment variable NAME to VALUE.
+.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 run BUNDLEID [ARGS...]
+run app with BUNDLEID and optional ARGS on device.
+
+.SH AUTHORS
+Martin Szulecki