1XSCOPE(1) General Commands Manual XSCOPE(1)
2
6 xscope - X Window Protocol Viewer
7
9 xscope [-i<in-port>] [-o<out-port>] [-h<server-host>] [-d<display-num‐
10 ber>] [-q] [-v<n>] [-r] [-D<debug-level>] [-S<n>] [-t]
11
13 Xscope sits in-between an X11 client and an X11 server and prints the
14 contents of each request, reply, error, or event that is communicated
15 between them. Xscope can decode the core X11 protocol and several
16 extensions, including BIG-REQUESTS, LBX, MIT-SHM, NCD-WinCenterPro,
17 RANDR, and RENDER. This information can be useful in debugging and
18 performance tuning of X11 servers and clients.
19 To operate, xscope must know the host, port, and display to use to con‐
21 nect to the X11 server. In addition, it must know the port on which it
22 should listen for X11 clients. Two cases are common:
23 (1) The X11 server is on the same host as xscope.
25 In this case, the input port for xscope should be selected as an
26 X11 server on a different display, and the client DISPLAY argument
27 adjusted to select xscope . For example, if the X11 server is on
28 port 6001, display 1, then xscope can use port 6002 as its input
29 port. The client can use display 1 for direct access to X11 or
30 display 2 for access to xscope.
31 (2) The X11 server is on a different host than xscope.
33 In this case the same input and output ports can be used, and the
34 host component of the DISPLAY is used to select xscope or X11.
35
37 -i<input-port>
38 Specify the port that xscope will use to take requests from
39 clients (defaults to 1). For X11, this port is automatically
40 biased by 6000.
41 -o<output-port>
43 Determines the port that xscope will use to connect to X11
44 (defaults to 0). For X11, this port is automatically biased
45 by 6000.
46 -h<host> Determines the host that xscope will use to find its X11
48 server.
49 -d<display>
51 Defines the display number. The display number is added to
52 the input and output port to give the actual ports which are
53 used by xscope.
54 -q Quiet output mode. Gives only the names of requests,
56 replies, errors, and events, but does not indicate contents.
57 -v<print-level>
59 Determines the level of printing which xscope will provide.
60 The print-level can be 0 (same as quiet mode), 1, 2, 3, 4.
61 The larger numbers give more and more output. For example, a
62 successful setup returns a string which is the name of the
63 vendor of the X11 server. At level 1, the explicit field
64 giving the length of the string is suppressed since it can be
65 inferred from the string. At level 2 and above the length is
66 explicitly printed.
67 -r Print only raw data without decoding it.
69 -D<debug-level>
71 Print debugging information at the specified level.
72 -S<n> Toggle output on or off when SIGUSR1 is received. If n is 0,
74 the initial state is off. If n is 1, the initial state is
75 on.
76 -t Terminate xscope when all clients close.
78
80 When xscope receives an interrupt signal (normally generated by Con‐
81 trol-C) it enters an interactive mode in which it prompts for commands.
82 Available commands in this mode are:
83 audio, a Show current verbosity level for NAS protocol packets.
85 audio n, a n
87 Set current verbosity level for NAS protocol packets to n.
88 break, b List currently defined breakpoints.
90 break request..., b request...
92 Create a breakpoint for the specified protocol requests. The
93 breakpoint will be enabled by default. When the breakpoint
94 is enabled, xscope will stop for interactive commands after
95 processing a request of the specified type. Requests and
96 extensions may be specified by name or number. If an exten‐
97 sion is followed by a ":" and a number, it will only break
98 for the specified minor opcode for that extension. Note
99 that since extension opcodes are not known until the exten‐
100 sion is first seen, breakpoints cannot currently be set on
101 extensions until after a QueryExtension request and reply are
102 processed for that extension, so users may need to initially
103 set a breakpoint on QueryExtension, and after processing that
104 set the breakpoint for the target extension.
105 cont, c Resume processing of data passing between server and clients.
107 delete, del
109 Delete all breakpoints.
110 delete breakpoint..., del breakpoint...
112 Delete listed breakpoints, specified by number.
113 disable, d
115 Disable all breakpoints.
116 disable breakpoint..., d breakpoint...
118 Disable listed breakpoints, specified by number.
119 enable, e Enable all breakpoints.
121 enable breakpoint..., e breakpoint...
123 Enable listed breakpoints, specified by number.
124 help, ? Print list of available commands.
126 help command..., ? command...
128 Describe specified command or commands.
129 level, l Show current verbosity level for X11 protocol packets.
131 level n, l n
133 Set current verbosity level for X11 protocol packets to n.
134 quit, q Quit xscope.
136 step, s Process one request, then prompt for another command.
138
140 xscope -v4 -hcleo -d0 -o0 -i1
141 This command would have xscope communicate with an X11 server on host
143 ``cleo'', display 0; xscope itself would be available on the current
144 host as display 1 (display of 0 plus the 1 of -i1). Verbose level 4.
145 xscope -q -d1 -o1 -o3
147 The X11 server for the current host, display 2 (1 for -d1 plus 1 for
149 -o1) would be used by xscope which would run as display 4 (1 for -d1
150 plus 3 for -o3). Quiet mode (verbose level 0).
151
153 X(7), Xsecurity(7), X11 Protocol and extension protocol documents
154
156 James L. Peterson (MCC)
157 Copyright (C) 1988 MCC
159 Permission to use, copy, modify, distribute, and sell this software and
161 its documentation for any purpose is hereby granted without fee, pro‐
162 vided that the above copyright notice appear in all copies and that
163 both that copyright notice and this permission notice appear in sup‐
164 porting documentation, and that the name of MCC not be used in adver‐
165 tising or publicity pertaining to distribution of the software without
166 specific, written prior permission. MCC makes no representations about
167 the suitability of this software for any purpose. It is provided "as
168 is" without express or implied warranty.
169 MCC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
171 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT
172 SHALL MCC BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
173 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
174 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
175 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
176 SOFTWARE.
177X Version 11 xscope 1.2 XSCOPE(1)