blob: b7d4bab17add60a18764d4ead4db758a4ceadf5e [file] [log] [blame]
Martin Szuleckic25847a2010-03-13 19:49:52 +01001.TH "idevicesyslog" 1
2.SH NAME
Martin Szuleckiaa7eed42012-04-07 15:51:13 +02003idevicesyslog \- Relay syslog of a connected device.
Martin Szuleckic25847a2010-03-13 19:49:52 +01004.SH SYNOPSIS
5.B idevicesyslog
6[OPTIONS]
7
8.SH DESCRIPTION
9
Martin Szuleckiaa7eed42012-04-07 15:51:13 +020010Relay syslog of a connected device.
Martin Szuleckic25847a2010-03-13 19:49:52 +010011
12.SH OPTIONS
Martin Szuleckic25847a2010-03-13 19:49:52 +010013.TP
Martin Szulecki74573462012-03-22 16:07:07 +010014.B \-u, \-\-udid UDID
Nikias Bassenbc559ab2020-04-27 06:16:55 +020015target specific device by UDID
16.TP
17.B \-n, \-\-network
Nikias Bassen18a93b12020-06-05 20:52:23 +020018connect to network device
Nikias Bassenbc559ab2020-04-27 06:16:55 +020019.TP
20.B \-x, \-\-exit
21exit when device disconnects
22.TP
23.B \-d, \-\-debug
24enable communication debugging
25.TP
Martin Szuleckic25847a2010-03-13 19:49:52 +010026.B \-h, \-\-help
Nikias Bassenbc559ab2020-04-27 06:16:55 +020027prints usage information
Nikias Bassen45ba75a2020-05-28 23:11:24 +020028.TP
Nikias Bassen18a93b12020-06-05 20:52:23 +020029.B \-v, \-\-version
30prints version information.
31.TP
Nikias Bassen45ba75a2020-05-28 23:11:24 +020032.B \-\-no\-colors
33disable colored output
Martin Szuleckic25847a2010-03-13 19:49:52 +010034
Nikias Bassenbc559ab2020-04-27 06:16:55 +020035.SH FILTER OPTIONS
36.TP
37.B \-m, \-\-match STRING
38only print messages that contain STRING
39
40This option will set a filter to only printed log messages that contain the given string.
41.TP
42.B \-t, \-\-trigger STRING
43start logging when matching STRING
44
45When 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
49stop logging when matching STRING
50
51When 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
54NOTE: 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
57only print messages from matching process(es)
58
59PROCESS 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
62print all messages except matching process(es)
63
64PROCESS 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
67set a filter to exclude common noisy processes
68
Nikias Bassen9050bf02020-12-10 01:49:55 +010069Since 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 Bassenbc559ab2020-04-27 06:16:55 +020070.TP
71.B \-\-quiet\-list
72prints the list of processes for \f[B]\-\-quiet\f[] and exits
73.TP
74.B \-k, \-\-kernel
75only print kernel messages
76
77This 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
80suppress kernel messages
81
82This is equivalent to passing \f[B]\-\-exclude kernel\f[].
83
84.SH EXAMPLES
85.TP
86.B idevicesyslog \-u 00008030\-0000111ABC000DEF
87Relay syslog of device with UDID 00008030-0000111ABC000DEF.
88.TP
89.B idevicesyslog \-x
90Relay syslog of device and exit when the device is unplugged.
91.TP
92.B idevicesyslog \-m '####' \-e 'identityservicesd' \-K
93Only 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
96Only print log messages from the process named 'MyApp' and 'ReportCrash'.
97.TP
98.B idevicesyslog \-p 'MyApp|ReportCrash'
99Same as previous example with different syntax.
100.TP
101.B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder'
102Suppress log messages from backboardd, CommCenter, and mDNSResponder.
103.TP
104.B idevicesyslog \-q \-k
105Suppress log messages from common noisy processes, but DO print kernel log messages.
106.TP
107.B idevicesyslog \-K
108Suppress log messages from kernel, but print everything else
109.TP
110.B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q
111Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes
112
113.SH AUTHORS
114Nikias Bassen, Martin Szulecki
Martin Szuleckic25847a2010-03-13 19:49:52 +0100115
116Man page written to conform with Debian by Julien Lavergne.
Martin Szulecki65354322015-01-27 23:19:51 +0100117
118.SH ON THE WEB
Nikias Bassenbc559ab2020-04-27 06:16:55 +0200119https://libimobiledevice.org
Martin Szuleckie1cfe7f2020-06-04 02:44:02 +0200120
121https://github.com/libimobiledevice/libimobiledevice