diff options
Diffstat (limited to 'docs/idevicesyslog.1')
| -rw-r--r-- | docs/idevicesyslog.1 | 150 |
1 files changed, 142 insertions, 8 deletions
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index 97012cb..5a677b6 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 @@ -10,17 +10,151 @@ idevicesyslog \- Relay syslog of a connected device. Relay syslog of a connected device. .SH OPTIONS -.TP -.B \-d, \-\-debug -enable communication debugging. .TP .B \-u, \-\-udid UDID -target specific device by its 40-digit device UDID -.TP +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-x, \-\-exit +exit when device disconnects +.TP +.B \-d, \-\-debug +enable communication debugging +.TP .B \-h, \-\-help -prints usage information. +prints usage information +.TP +.B \-v, \-\-version +Prints version information. +.TP +.B \-\-no\-colors +disable colored output +.TP +.B \-o, \-\-output FILE +Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[]. +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. -.SH AUTHOR -Martin Szulecki +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 +.TP +.B \-M, \-\-unmatch STRING +print messages that do not contain STRING +.TP +.B \-t, \-\-trigger STRING +start logging when matching STRING + +When specified, logging will start as soon as a log messages is encountered that contains the given string. See also +\f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started. +.TP +.B \-T, \-\-untrigger STRING +stop logging when matching STRING + +When specified logging will halt as soon as a log message is encountered that contains the given string. See also +\f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops. + +NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered. +.TP +.B \-p, \-\-process PROCESS +only print messages from matching process(es) + +PROCESS is a string that can either be a numeric pid or a process name. It also supports multiple process names or pids in one string, separated by | (make sure to use quotes!). +.TP +.B \-e, \-\-exclude PROCESS +print all messages except matching process(es) + +PROCESS is a string that can either be a numeric pid or a process name. It also supports multiple process names or pids in one string, separated by | (make sure to use quotes!). +.TP +.B \-q, \-\-quiet +set a filter to exclude common noisy processes + +Since the syslog can be quite noisy, this quick command line switch allows silencing a predefined set of commonly known processes. The list of processes that are silenced can be retrieved with \f[B]\-\-quiet\-list\f[]. +.TP +.B \-\-quiet\-list +prints the list of processes for \f[B]\-\-quiet\f[] and exits +.TP +.B \-k, \-\-kernel +only print kernel messages + +This is actually equivalent to passing \f[B]\-\-process kernel\f[] with the exception that it can be used with \f[B]\-\-quiet\f[] to silence out the noisy process but still get all the kernel log messages. +.TP +.B \-K, \-\-no\-kernel +suppress kernel messages + +This is equivalent to passing \f[B]\-\-exclude kernel\f[]. + +.SH EXAMPLES +.TP +.B idevicesyslog \-u 00008030\-0000111ABC000DEF +Relay syslog of device with UDID 00008030-0000111ABC000DEF. +.TP +.B idevicesyslog \-x +Relay syslog of device and exit when the device is unplugged. +.TP +.B idevicesyslog \-m '####' \-e 'identityservicesd' \-K +Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel. +.TP +.B idevicesyslog \-p MyApp \-p ReportCrash +Only print log messages from the process named 'MyApp' and 'ReportCrash'. +.TP +.B idevicesyslog \-p 'MyApp|ReportCrash' +Same as previous example with different syntax. +.TP +.B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder' +Suppress log messages from backboardd, CommCenter, and mDNSResponder. +.TP +.B idevicesyslog \-q \-k +Suppress log messages from common noisy processes, but DO print kernel log messages. +.TP +.B idevicesyslog \-K +Suppress log messages from kernel, but print everything else +.TP +.B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q +Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes + +.SH AUTHORS +Nikias Bassen, Martin Szulecki Man page written to conform with Debian by Julien Lavergne. + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice |