summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am2
-rw-r--r--docs/idevicecrashreport.136
2 files changed, 37 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 22fa4ff..dddf8d6 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
+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
EXTRA_DIST = $(man_MANS)
diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1
new file mode 100644
index 0000000..1129efc
--- /dev/null
+++ b/docs/idevicecrashreport.1
@@ -0,0 +1,36 @@
+.TH "idevicecrashreport" 1
+.SH NAME
+idevicecrashreport \- Retrieve crash reports from a device.
+.SH SYNOPSIS
+.B idevicecrashreport
+[OPTIONS] DIRECTORY
+
+.SH DESCRIPTION
+
+Simple utility to move crash reports from a device to a local directory.
+
+The utility outputs lines prefixed with either "Link:", "Copy:" or "Move:"
+depending on whether a symlink was created, a file was copied or moved from
+the device to the target DIRECTORY.
+
+.SH OPTIONS
+.TP
+.B \-e, \-\-extract
+extract raw crash report into separate '.crash' files.
+.TP
+.B \-k, \-\-keep
+copy but do not remove crash reports from device.
+.TP
+.B \-d, \-\-debug
+enable communication debugging.
+.TP
+.B \-u, \-\-udid UDID
+target specific device by its 40-digit device UDID.
+.TP
+.B \-h, \-\-help
+prints usage information.
+
+.SH AUTHOR
+Martin Szulecki
+
+Nikias Bassen