Debian Codegraph @

docs/idevicesyslog.1

raw
1 .TH "idevicesyslog" 1
2 .SH NAME
3 idevicesyslog \- Relay syslog of a connected device.
4 .SH SYNOPSIS
5 .B idevicesyslog
6 [OPTIONS]
7
8 .SH DESCRIPTION
9
10 Relay syslog of a connected device.
11
12 .SH OPTIONS
13 .TP
14 .B \-u, \-\-udid UDID
15 target specific device by UDID
16 .TP
17 .B \-n, \-\-network
18 connect to network device
19 .TP
20 .B \-x, \-\-exit
21 exit when device disconnects
22 .TP
23 .B \-d, \-\-debug
24 enable communication debugging
25 .TP
26 .B \-h, \-\-help
27 prints usage information
28 .TP
29 .B \-v, \-\-version
30 Prints version information.
31 .TP
32 .B \-\-no\-colors
33 disable colored output
34 .TP
35 .B \-o, \-\-output FILE
36 Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[].
37 If FILE already exists, it will be overwritten without warning.
38 .TP
39 .B \-\-colors
40 Force writing colored output, e.g. when using \f[B]\-\-output\f[].
41 .TP
42 .B \-\-syslog\-relay
43 Use old syslog_relay service instead of os_trace_relay (iOS 9+).
44
45 .SH COMMANDS
46 .TP
47 .B pidlist
48 Print a list with PID and name of all processes currently running on the device.
49 .TP
50 .B archive PATH
51 Request a logarchive from the device. It will be written in tar format to PATH. To pipe to another process use \- as PATH.
52 Below are some options to restrict the log message data.
53
54 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:
55
56 \f[B]mkdir test.logarchive && tools/idevicesyslog archive - |tar -C test.logarchive -xv\f[]
57
58 This will also print the filenames while they are extracted.
59 .TP
60 Further options for \f[B]archive\f[]:
61 .TP
62 .B \-\-start\-time VALUE
63 Start time of the log data as UNIX timestamp. Earlier messages will be dropped.
64 .TP
65 .B \-\-age\-limit VALUE
66 Maximum age of the log data, supposedly number of days.
67 .TP
68 .B \-\-size\-limit VALUE
69 Limit the size of the archive. The unit is currently unknown, so feel free to experiment.
70 .TP
71 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.
72
73 .SH FILTER OPTIONS
74 .TP
75 .B \-m, \-\-match STRING
76 only print messages that contain STRING
77 .TP
78 .B \-M, \-\-unmatch STRING
79 print messages that do not contain STRING
80 .TP
81 .B \-t, \-\-trigger STRING
82 start logging when matching STRING
83
84 When specified, logging will start as soon as a log messages is encountered that contains the given string. See also
85 \f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started.
86 .TP
87 .B \-T, \-\-untrigger STRING
88 stop logging when matching STRING
89
90 When specified logging will halt as soon as a log message is encountered that contains the given string. See also
91 \f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops.
92
93 NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered.
94 .TP
95 .B \-p, \-\-process PROCESS
96 only print messages from matching process(es)
97
98 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!).
99 .TP
100 .B \-e, \-\-exclude PROCESS
101 print all messages except matching process(es)
102
103 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!).
104 .TP
105 .B \-q, \-\-quiet
106 set a filter to exclude common noisy processes
107
108 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[].
109 .TP
110 .B \-\-quiet\-list
111 prints the list of processes for \f[B]\-\-quiet\f[] and exits
112 .TP
113 .B \-k, \-\-kernel
114 only print kernel messages
115
116 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.
117 .TP
118 .B \-K, \-\-no\-kernel
119 suppress kernel messages
120
121 This is equivalent to passing \f[B]\-\-exclude kernel\f[].
122
123 .SH EXAMPLES
124 .TP
125 .B idevicesyslog \-u 00008030\-0000111ABC000DEF
126 Relay syslog of device with UDID 00008030-0000111ABC000DEF.
127 .TP
128 .B idevicesyslog \-x
129 Relay syslog of device and exit when the device is unplugged.
130 .TP
131 .B idevicesyslog \-m '####' \-e 'identityservicesd' \-K
132 Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel.
133 .TP
134 .B idevicesyslog \-p MyApp \-p ReportCrash
135 Only print log messages from the process named 'MyApp' and 'ReportCrash'.
136 .TP
137 .B idevicesyslog \-p 'MyApp|ReportCrash'
138 Same as previous example with different syntax.
139 .TP
140 .B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder'
141 Suppress log messages from backboardd, CommCenter, and mDNSResponder.
142 .TP
143 .B idevicesyslog \-q \-k
144 Suppress log messages from common noisy processes, but DO print kernel log messages.
145 .TP
146 .B idevicesyslog \-K
147 Suppress log messages from kernel, but print everything else
148 .TP
149 .B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q
150 Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes
151
152 .SH AUTHORS
153 Nikias Bassen, Martin Szulecki
154
155 Man page written to conform with Debian by Julien Lavergne.
156
157 .SH ON THE WEB
158 https://libimobiledevice.org
159
160 https://github.com/libimobiledevice/libimobiledevice