Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 1 | .TH "idevicesyslog" 1 |
| 2 | .SH NAME |
Martin Szulecki | aa7eed4 | 2012-04-07 15:51:13 +0200 | [diff] [blame] | 3 | idevicesyslog \- Relay syslog of a connected device. |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 4 | .SH SYNOPSIS |
| 5 | .B idevicesyslog |
| 6 | [OPTIONS] |
| 7 | |
| 8 | .SH DESCRIPTION |
| 9 | |
Martin Szulecki | aa7eed4 | 2012-04-07 15:51:13 +0200 | [diff] [blame] | 10 | Relay syslog of a connected device. |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 11 | |
| 12 | .SH OPTIONS |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 13 | .TP |
Martin Szulecki | 7457346 | 2012-03-22 16:07:07 +0100 | [diff] [blame] | 14 | .B \-u, \-\-udid UDID |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 15 | target specific device by UDID |
| 16 | .TP |
| 17 | .B \-n, \-\-network |
Nikias Bassen | 18a93b1 | 2020-06-05 20:52:23 +0200 | [diff] [blame] | 18 | connect to network device |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 19 | .TP |
| 20 | .B \-x, \-\-exit |
| 21 | exit when device disconnects |
| 22 | .TP |
| 23 | .B \-d, \-\-debug |
| 24 | enable communication debugging |
| 25 | .TP |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 26 | .B \-h, \-\-help |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 27 | prints usage information |
Nikias Bassen | 45ba75a | 2020-05-28 23:11:24 +0200 | [diff] [blame] | 28 | .TP |
Nikias Bassen | 18a93b1 | 2020-06-05 20:52:23 +0200 | [diff] [blame] | 29 | .B \-v, \-\-version |
| 30 | prints version information. |
| 31 | .TP |
Nikias Bassen | 45ba75a | 2020-05-28 23:11:24 +0200 | [diff] [blame] | 32 | .B \-\-no\-colors |
| 33 | disable colored output |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 34 | |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 35 | .SH FILTER OPTIONS |
| 36 | .TP |
| 37 | .B \-m, \-\-match STRING |
| 38 | only print messages that contain STRING |
| 39 | |
| 40 | This option will set a filter to only printed log messages that contain the given string. |
| 41 | .TP |
| 42 | .B \-t, \-\-trigger STRING |
| 43 | start logging when matching STRING |
| 44 | |
| 45 | When specified, logging will start as soon as a log messages is encountered that contains the given string. See also |
| 46 | \f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started. |
| 47 | .TP |
| 48 | .B \-T, \-\-untrigger STRING |
| 49 | stop logging when matching STRING |
| 50 | |
| 51 | When specified logging will halt as soon as a log message is encountered that contains the given string. See also |
| 52 | \f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops. |
| 53 | |
| 54 | NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered. |
| 55 | .TP |
| 56 | .B \-p, \-\-process PROCESS |
| 57 | only print messages from matching process(es) |
| 58 | |
| 59 | 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!). |
| 60 | .TP |
| 61 | .B \-e, \-\-exclude PROCESS |
| 62 | print all messages except matching process(es) |
| 63 | |
| 64 | 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!). |
| 65 | .TP |
| 66 | .B \-q, \-\-quiet |
| 67 | set a filter to exclude common noisy processes |
| 68 | |
Nikias Bassen | 9050bf0 | 2020-12-10 01:49:55 +0100 | [diff] [blame] | 69 | 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[]. |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 70 | .TP |
| 71 | .B \-\-quiet\-list |
| 72 | prints the list of processes for \f[B]\-\-quiet\f[] and exits |
| 73 | .TP |
| 74 | .B \-k, \-\-kernel |
| 75 | only print kernel messages |
| 76 | |
| 77 | 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. |
| 78 | .TP |
| 79 | .B \-K, \-\-no\-kernel |
| 80 | suppress kernel messages |
| 81 | |
| 82 | This is equivalent to passing \f[B]\-\-exclude kernel\f[]. |
| 83 | |
| 84 | .SH EXAMPLES |
| 85 | .TP |
| 86 | .B idevicesyslog \-u 00008030\-0000111ABC000DEF |
| 87 | Relay syslog of device with UDID 00008030-0000111ABC000DEF. |
| 88 | .TP |
| 89 | .B idevicesyslog \-x |
| 90 | Relay syslog of device and exit when the device is unplugged. |
| 91 | .TP |
| 92 | .B idevicesyslog \-m '####' \-e 'identityservicesd' \-K |
| 93 | Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel. |
| 94 | .TP |
| 95 | .B idevicesyslog \-p MyApp \-p ReportCrash |
| 96 | Only print log messages from the process named 'MyApp' and 'ReportCrash'. |
| 97 | .TP |
| 98 | .B idevicesyslog \-p 'MyApp|ReportCrash' |
| 99 | Same as previous example with different syntax. |
| 100 | .TP |
| 101 | .B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder' |
| 102 | Suppress log messages from backboardd, CommCenter, and mDNSResponder. |
| 103 | .TP |
| 104 | .B idevicesyslog \-q \-k |
| 105 | Suppress log messages from common noisy processes, but DO print kernel log messages. |
| 106 | .TP |
| 107 | .B idevicesyslog \-K |
| 108 | Suppress log messages from kernel, but print everything else |
| 109 | .TP |
| 110 | .B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q |
| 111 | Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes |
| 112 | |
| 113 | .SH AUTHORS |
| 114 | Nikias Bassen, Martin Szulecki |
Martin Szulecki | c25847a | 2010-03-13 19:49:52 +0100 | [diff] [blame] | 115 | |
| 116 | Man page written to conform with Debian by Julien Lavergne. |
Martin Szulecki | 6535432 | 2015-01-27 23:19:51 +0100 | [diff] [blame] | 117 | |
| 118 | .SH ON THE WEB |
Nikias Bassen | bc559ab | 2020-04-27 06:16:55 +0200 | [diff] [blame] | 119 | https://libimobiledevice.org |
Martin Szulecki | e1cfe7f | 2020-06-04 02:44:02 +0200 | [diff] [blame] | 120 | |
| 121 | https://github.com/libimobiledevice/libimobiledevice |