summaryrefslogtreecommitdiffstats
path: root/docs/idevicesyslog.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/idevicesyslog.1')
-rw-r--r--docs/idevicesyslog.1122
1 files changed, 112 insertions, 10 deletions
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1
index 178d7c5..66ae2e4 100644
--- a/docs/idevicesyslog.1
+++ b/docs/idevicesyslog.1
@@ -1,26 +1,128 @@
1.TH "idevicesyslog" 1 1.TH "idevicesyslog" 1
2.SH NAME 2.SH NAME
3idevicesyslog \- Relay syslog of a connected iPhone/iPod Touch. 3idevicesyslog \- Relay syslog of a connected device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicesyslog 5.B idevicesyslog
6[OPTIONS] 6[OPTIONS]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Relay syslog of a connected iPhone/iPod Touch. 10Relay syslog of a connected device.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
14.B \-u, \-\-udid UDID
15target specific device by UDID
16.TP
17.B \-n, \-\-network
18connect to network device
19.TP
20.B \-x, \-\-exit
21exit when device disconnects
22.TP
14.B \-d, \-\-debug 23.B \-d, \-\-debug
15enable communication debugging. 24enable communication debugging
16.TP 25.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID
19.TP
20.B \-h, \-\-help 26.B \-h, \-\-help
21prints usage information. 27prints usage information
28.TP
29.B \-v, \-\-version
30Prints version information.
31.TP
32.B \-\-no\-colors
33disable colored output
34.TP
35.B \-o, \-\-output FILE
36Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[].
37If FILE already exists, it will be overwritten without warning.
38.TP
39.B \-\-colors
40Force writing colored output, e.g. when using \f[B]\-\-output\f[].
41
42.SH FILTER OPTIONS
43.TP
44.B \-m, \-\-match STRING
45only print messages that contain STRING
22 46
23.SH AUTHOR 47This option will set a filter to only printed log messages that contain the given string.
24Martin Szulecki 48.TP
49.B \-t, \-\-trigger STRING
50start logging when matching STRING
51
52When specified, logging will start as soon as a log messages is encountered that contains the given string. See also
53\f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started.
54.TP
55.B \-T, \-\-untrigger STRING
56stop logging when matching STRING
57
58When specified logging will halt as soon as a log message is encountered that contains the given string. See also
59\f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops.
60
61NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered.
62.TP
63.B \-p, \-\-process PROCESS
64only print messages from matching process(es)
65
66PROCESS 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!).
67.TP
68.B \-e, \-\-exclude PROCESS
69print all messages except matching process(es)
70
71PROCESS 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!).
72.TP
73.B \-q, \-\-quiet
74set a filter to exclude common noisy processes
75
76Since 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[].
77.TP
78.B \-\-quiet\-list
79prints the list of processes for \f[B]\-\-quiet\f[] and exits
80.TP
81.B \-k, \-\-kernel
82only print kernel messages
83
84This 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.
85.TP
86.B \-K, \-\-no\-kernel
87suppress kernel messages
88
89This is equivalent to passing \f[B]\-\-exclude kernel\f[].
90
91.SH EXAMPLES
92.TP
93.B idevicesyslog \-u 00008030\-0000111ABC000DEF
94Relay syslog of device with UDID 00008030-0000111ABC000DEF.
95.TP
96.B idevicesyslog \-x
97Relay syslog of device and exit when the device is unplugged.
98.TP
99.B idevicesyslog \-m '####' \-e 'identityservicesd' \-K
100Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel.
101.TP
102.B idevicesyslog \-p MyApp \-p ReportCrash
103Only print log messages from the process named 'MyApp' and 'ReportCrash'.
104.TP
105.B idevicesyslog \-p 'MyApp|ReportCrash'
106Same as previous example with different syntax.
107.TP
108.B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder'
109Suppress log messages from backboardd, CommCenter, and mDNSResponder.
110.TP
111.B idevicesyslog \-q \-k
112Suppress log messages from common noisy processes, but DO print kernel log messages.
113.TP
114.B idevicesyslog \-K
115Suppress log messages from kernel, but print everything else
116.TP
117.B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q
118Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes
119
120.SH AUTHORS
121Nikias Bassen, Martin Szulecki
25 122
26Man page written to conform with Debian by Julien Lavergne. 123Man page written to conform with Debian by Julien Lavergne.
124
125.SH ON THE WEB
126https://libimobiledevice.org
127
128https://github.com/libimobiledevice/libimobiledevice