diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 3 | ||||
| -rw-r--r-- | docs/doxygen/custom.css | 3 | ||||
| -rw-r--r-- | docs/idevicecrashreport.1 | 19 | ||||
| -rw-r--r-- | docs/idevicenotificationproxy.1 | 15 | ||||
| -rw-r--r-- | docs/idevicesyslog.1 | 36 |
5 files changed, 59 insertions, 17 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 8156d4f..c9b742f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -21,6 +21,7 @@ man_MANS = \ idevicesetlocation.1 \ afcclient.1 -EXTRA_DIST = $(man_MANS) +EXTRA_DIST = $(man_MANS) \ + doxygen DISTCLEANFILES = html/* html diff --git a/docs/doxygen/custom.css b/docs/doxygen/custom.css index 62183bf..e9f1ea8 100644 --- a/docs/doxygen/custom.css +++ b/docs/doxygen/custom.css @@ -230,6 +230,7 @@ div.fragment { border: solid 1px rgb(221, 221, 221); border-radius: 3px; background-color: rgb(248, 248, 248); + color: rgb(0,0,0); } div.line { @@ -1719,4 +1720,4 @@ th.markdownTableHeadNone { #projectnumber { font-size: 0.75rem; } -}
\ No newline at end of file +} 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/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 |
