summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am6
-rw-r--r--docs/afcclient.18
-rw-r--r--docs/idevicecrashreport.119
-rw-r--r--docs/ideviceimagemounter.134
-rw-r--r--docs/idevicenotificationproxy.115
-rw-r--r--docs/idevicesyslog.136
6 files changed, 84 insertions, 34 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 4a4c56f..c9b742f 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -18,8 +18,10 @@ man_MANS = \
idevicedebug.1 \
idevicedevmodectl.1 \
idevicenotificationproxy.1 \
- idevicesetlocation.1
+ idevicesetlocation.1 \
+ afcclient.1
-EXTRA_DIST = $(man_MANS)
+EXTRA_DIST = $(man_MANS) \
+ doxygen
DISTCLEANFILES = html/* html
diff --git a/docs/afcclient.1 b/docs/afcclient.1
index ca7cb86..a4eeacb 100644
--- a/docs/afcclient.1
+++ b/docs/afcclient.1
@@ -32,16 +32,14 @@ create directory at PATH
.B ln [-s] FILE [LINK]
Create a (symbolic) link to file named LINKNAME. \f[B]NOTE: This feature has been disabled in newer versions of iOS\f[].
.TP
-.B rm PATH
+.B rm [-rf] PATH
remove item at PATH
.TP
-.B get PATH [LOCALPATH]
+.B get [-rf] PATH [LOCALPATH]
transfer file at PATH from device to LOCALPATH, or current directory if omitted. If LOCALPATH is a directory, the file will be stored inside the directory.
-\f[B]WARNING\f[]: Existing files will be overwritten!
.TP
-.B put LOCALPATH [PATH]
+.B put [-rf] LOCALPATH [PATH]
transfer local file at LOCALPATH to device at PATH, or current directory if omitted. If PATH is a directory, the file will be stored inside the directory.
-\f[B]WARNING\f[]: Existing files will be overwritten!
.TP
.SH OPTIONS
diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1
index 6acd6e9..f117c87 100644
--- a/docs/idevicecrashreport.1
+++ b/docs/idevicecrashreport.1
@@ -16,28 +16,31 @@ the device to the target DIRECTORY.
.SH OPTIONS
.TP
.B \-u, \-\-udid UDID
-target specific device by UDID.
+Target specific device by UDID.
.TP
.B \-n, \-\-network
-connect to network device.
+Connect to network device.
.TP
.B \-e, \-\-extract
-extract raw crash report into separate '.crash' files.
+Extract raw crash report into separate '.crash' files.
.TP
.B \-k, \-\-keep
-copy but do not remove crash reports from device.
+Copy but do not remove crash reports from device.
.TP
.B \-d, \-\-debug
-enable communication debugging.
+Enable communication debugging.
.TP
.B \-f, \-\-filter NAME
-filter crash reports by NAME (case sensitive)
+Filter crash reports by NAME (case sensitive)
+.TP
+.B \-\-remove\-all
+Remove all crash log files without copying. Can be used with \f[B]-f\f[] to only remove matching files.
.TP
.B \-h, \-\-help
-prints usage information.
+Prints usage information.
.TP
.B \-v, \-\-version
-prints version information.
+Prints version information.
.SH AUTHOR
Martin Szulecki
diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1
index 832850a..1fe7e45 100644
--- a/docs/ideviceimagemounter.1
+++ b/docs/ideviceimagemounter.1
@@ -1,13 +1,32 @@
.TH "ideviceimagemounter" 1
.SH NAME
-ideviceimagemounter \- Mount disk images on the device.
+ideviceimagemounter \- Mount, list, or unmount a disk image on the device.
.SH SYNOPSIS
.B ideviceimagemounter
-[OPTIONS] IMAGE_FILE IMAGE_SIGNATURE_FILE
+[OPTIONS] COMMAND [COMMAND OPTIONS]
.SH DESCRIPTION
-Mounts the specified disk image on the device.
+Mount, list, or unmount a disk image on the device.
+
+.SH COMMANDS
+.TP
+.B mount PATH
+Mount the developer disk image at PATH.
+For iOS 17+, PATH is a directory containing a .dmg image, a BuildManifest.plist,
+and a Firmware sub-directory.
+
+For older versions PATH is a .dmg filename with a .dmg.signature file in the same directory, or with
+another parameter pointing to a file elsewhere.
+.TP
+.B list
+List mounted disk images.
+.TP
+.B unmount PATH
+Unmount the image mounted at PATH.
+.TP
+.B devmodestatus
+Query the developer mode status (iOS 16+)
.SH OPTIONS
.TP
@@ -20,9 +39,6 @@ connect to network device.
.B \-d, \-\-debug
enable communication debugging.
.TP
-.B \-l, \-\-list
-list mount information
-.TP
.B \-t, \-\-imagetype NAME
the image type to use, default is 'Developer'
.TP
@@ -34,12 +50,6 @@ prints usage information
.TP
.B \-v, \-\-version
prints version information.
-.TP
-.B IMAGE_FILE
-the image filename to mount
-.TP
-.B IMAGE_SIGNATURE_FILE
-corresponding signature file for image filename
.SH AUTHOR
Nikias Bassen
diff --git a/docs/idevicenotificationproxy.1 b/docs/idevicenotificationproxy.1
index 56dd0b0..627ee5d 100644
--- a/docs/idevicenotificationproxy.1
+++ b/docs/idevicenotificationproxy.1
@@ -12,19 +12,22 @@ Post or observe notifications on an iOS device from the command line.
.SH OPTIONS
.TP
.B \-u, \-\-udid UDID
-target specific device by UDID.
+Target specific device by UDID.
+.TP
+.B \-i, \-\-insecure
+Connect to insecure notification proxy (for non-paired devices).
.TP
.B \-n, \-\-network
-connect to network device.
+Connect to network device.
.TP
.B \-d, \-\-debug
-enable communication debugging.
+Enable communication debugging.
.TP
.B \-h, \-\-help
-prints usage information.
+Prints usage information.
.TP
.B \-v, \-\-version
-prints version information.
+Prints version information.
.SH COMMANDS
.TP
@@ -38,6 +41,8 @@ observe notification IDs in the foreground until CTRL+C or signal is received.
Martin Szulecki
+Nikias Bassen
+
.SH ON THE WEB
https://libimobiledevice.org
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1
index 66ae2e4..5a677b6 100644
--- a/docs/idevicesyslog.1
+++ b/docs/idevicesyslog.1
@@ -38,13 +38,45 @@ If FILE already exists, it will be overwritten without warning.
.TP
.B \-\-colors
Force writing colored output, e.g. when using \f[B]\-\-output\f[].
+.TP
+.B \-\-syslog\-relay
+Use old syslog_relay service instead of os_trace_relay (iOS 9+).
+
+.SH COMMANDS
+.TP
+.B pidlist
+Print a list with PID and name of all processes currently running on the device.
+.TP
+.B archive PATH
+Request a logarchive from the device. It will be written in tar format to PATH. To pipe to another process use \- as PATH.
+Below are some options to restrict the log message data.
+
+In order to view the logarchive in a compatible log viewer, you can pipe the output data to \f[B]tar\f[] and have it extract into a new directory:
+
+\f[B]mkdir test.logarchive && tools/idevicesyslog archive - |tar -C test.logarchive -xv\f[]
+
+This will also print the filenames while they are extracted.
+.TP
+Further options for \f[B]archive\f[]:
+.TP
+.B \-\-start\-time VALUE
+Start time of the log data as UNIX timestamp. Earlier messages will be dropped.
+.TP
+.B \-\-age\-limit VALUE
+Maximum age of the log data, supposedly number of days.
+.TP
+.B \-\-size\-limit VALUE
+Limit the size of the archive. The unit is currently unknown, so feel free to experiment.
+.TP
+Keep in mind that the device usually only has a backlog of a few minutes so the options might not have the desired effect. This is not a bug.
.SH FILTER OPTIONS
.TP
.B \-m, \-\-match STRING
only print messages that contain STRING
-
-This option will set a filter to only printed log messages that contain the given string.
+.TP
+.B \-M, \-\-unmatch STRING
+print messages that do not contain STRING
.TP
.B \-t, \-\-trigger STRING
start logging when matching STRING