diff options
Diffstat (limited to 'docs/idevicesyslog.1')
| -rw-r--r-- | docs/idevicesyslog.1 | 104 |
1 files changed, 95 insertions, 9 deletions
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index aa24339..fce1ff5 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 | |||
| @@ -10,20 +10,106 @@ idevicesyslog \- Relay syslog of a connected device. | |||
| 10 | Relay syslog of a connected device. | 10 | Relay syslog of a connected device. |
| 11 | 11 | ||
| 12 | .SH OPTIONS | 12 | .SH OPTIONS |
| 13 | .TP | ||
| 14 | .B \-d, \-\-debug | ||
| 15 | enable communication debugging. | ||
| 16 | .TP | 13 | .TP |
| 17 | .B \-u, \-\-udid UDID | 14 | .B \-u, \-\-udid UDID |
| 18 | target specific device by UDID. | 15 | target specific device by UDID |
| 19 | .TP | 16 | .TP |
| 17 | .B \-n, \-\-network | ||
| 18 | connect to network device even if available via USB | ||
| 19 | .TP | ||
| 20 | .B \-x, \-\-exit | ||
| 21 | exit when device disconnects | ||
| 22 | .TP | ||
| 23 | .B \-d, \-\-debug | ||
| 24 | enable communication debugging | ||
| 25 | .TP | ||
| 20 | .B \-h, \-\-help | 26 | .B \-h, \-\-help |
| 21 | prints usage information. | 27 | prints usage information |
| 28 | |||
| 29 | .SH FILTER OPTIONS | ||
| 30 | .TP | ||
| 31 | .B \-m, \-\-match STRING | ||
| 32 | only print messages that contain STRING | ||
| 33 | |||
| 34 | This option will set a filter to only printed log messages that contain the given string. | ||
| 35 | .TP | ||
| 36 | .B \-t, \-\-trigger STRING | ||
| 37 | start logging when matching STRING | ||
| 38 | |||
| 39 | When specified, logging will start as soon as a log messages is encountered that contains the given string. See also | ||
| 40 | \f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started. | ||
| 41 | .TP | ||
| 42 | .B \-T, \-\-untrigger STRING | ||
| 43 | stop logging when matching STRING | ||
| 44 | |||
| 45 | When specified logging will halt as soon as a log message is encountered that contains the given string. See also | ||
| 46 | \f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops. | ||
| 47 | |||
| 48 | NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered. | ||
| 49 | .TP | ||
| 50 | .B \-p, \-\-process PROCESS | ||
| 51 | only print messages from matching process(es) | ||
| 52 | |||
| 53 | 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!). | ||
| 54 | .TP | ||
| 55 | .B \-e, \-\-exclude PROCESS | ||
| 56 | print all messages except matching process(es) | ||
| 57 | |||
| 58 | 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!). | ||
| 59 | .TP | ||
| 60 | .B \-q, \-\-quiet | ||
| 61 | set a filter to exclude common noisy processes | ||
| 62 | |||
| 63 | Since the syslog can be quite noisy, this quick command line switch allows to silence out a predefined set of commonly known processes. The list of processes that are silenced can be retrieved with \f[B]\-\-quiet\-list\f[]. | ||
| 64 | .TP | ||
| 65 | .B \-\-quiet\-list | ||
| 66 | prints the list of processes for \f[B]\-\-quiet\f[] and exits | ||
| 67 | .TP | ||
| 68 | .B \-k, \-\-kernel | ||
| 69 | only print kernel messages | ||
| 70 | |||
| 71 | 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. | ||
| 72 | .TP | ||
| 73 | .B \-K, \-\-no\-kernel | ||
| 74 | suppress kernel messages | ||
| 75 | |||
| 76 | This is equivalent to passing \f[B]\-\-exclude kernel\f[]. | ||
| 77 | |||
| 78 | .SH EXAMPLES | ||
| 79 | .TP | ||
| 80 | .B idevicesyslog \-u 00008030\-0000111ABC000DEF | ||
| 81 | Relay syslog of device with UDID 00008030-0000111ABC000DEF. | ||
| 82 | .TP | ||
| 83 | .B idevicesyslog \-x | ||
| 84 | Relay syslog of device and exit when the device is unplugged. | ||
| 85 | .TP | ||
| 86 | .B idevicesyslog \-m '####' \-e 'identityservicesd' \-K | ||
| 87 | Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel. | ||
| 88 | .TP | ||
| 89 | .B idevicesyslog \-p MyApp \-p ReportCrash | ||
| 90 | Only print log messages from the process named 'MyApp' and 'ReportCrash'. | ||
| 91 | .TP | ||
| 92 | .B idevicesyslog \-p 'MyApp|ReportCrash' | ||
| 93 | Same as previous example with different syntax. | ||
| 94 | .TP | ||
| 95 | .B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder' | ||
| 96 | Suppress log messages from backboardd, CommCenter, and mDNSResponder. | ||
| 97 | .TP | ||
| 98 | .B idevicesyslog \-q \-k | ||
| 99 | Suppress log messages from common noisy processes, but DO print kernel log messages. | ||
| 100 | .TP | ||
| 101 | .B idevicesyslog \-K | ||
| 102 | Suppress log messages from kernel, but print everything else | ||
| 103 | .TP | ||
| 104 | .B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q | ||
| 105 | Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes | ||
| 22 | 106 | ||
| 23 | .SH AUTHOR | 107 | .SH AUTHORS |
| 24 | Martin Szulecki | 108 | Nikias Bassen, Martin Szulecki |
| 25 | 109 | ||
| 26 | Man page written to conform with Debian by Julien Lavergne. | 110 | Man page written to conform with Debian by Julien Lavergne. |
| 27 | 111 | ||
| 28 | .SH ON THE WEB | 112 | .SH ON THE WEB |
| 29 | http://libimobiledevice.org | 113 | https://github.com/libimobiledevice/libimobiledevice |
| 114 | |||
| 115 | https://libimobiledevice.org | ||
