1XSCOPE(1)                   General Commands Manual                  XSCOPE(1)
2
3
4

NAME

6       xscope - X Window Protocol Viewer
7

SYNOPSIS

9       xscope  [-i<in-port>] [-o<out-port>] [-h<server-host>] [-d<display-num‐
10       ber>] [-q] [-v<n>] [-r] [-D<debug-level>] [-I] [-S<n>] [-V] [-t]
11

DESCRIPTION

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
20       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
24       (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
32       (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

ARGUMENTS

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
42       -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
47       -h<host>  Determines  the  host  that   xscope will use to find its X11
48                 server.
49
50       -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
55       -f<filename>
56                 Instead of decoding a live session, reads previously captured
57                 raw data from a file to decode.
58
59       -q        Quiet  output  mode.   Gives  only  the  names  of  requests,
60                 replies, errors, and events, but does not indicate contents.
61
62       -v<print-level>
63                 Determines the level of printing which xscope  will  provide.
64                 The  print-level  can  be 0 (same as quiet mode), 1, 2, 3, 4.
65                 The larger numbers give more and more output.  For example, a
66                 successful  setup  returns  a string which is the name of the
67                 vendor of the X11 server.  At level  1,  the  explicit  field
68                 giving the length of the string is suppressed since it can be
69                 inferred from the string.  At level 2 and above the length is
70                 explicitly printed.
71
72       -r        Print only raw data without decoding it.
73
74       -D<debug-level>
75                 Print debugging information at the specified level.
76
77       -I        Enter interactive mode at startup.
78
79       -S<n>     Toggle output on or off when SIGUSR1 is received.  If n is 0,
80                 the initial state is off.  If n is 1, the  initial  state  is
81                 on.
82
83       -V        Print version information and exit.
84
85       -t        Terminate xscope when all clients close.
86

INTERACTIVE MODE

88       When  xscope  receives  an interrupt signal (normally generated by Con‐
89       trol-C) or is started with the -I flag, it enters an  interactive  mode
90       in which it prompts for commands.  Available commands in this mode are:
91
92       audio, a  Show current verbosity level for NAS protocol packets.
93
94       audio n, a n
95                 Set current verbosity level for NAS protocol packets to n.
96
97       break, b  List currently defined breakpoints.
98
99       break request..., b request...
100                 Create a breakpoint for the specified protocol requests.  The
101                 breakpoint will be enabled by default.   When the  breakpoint
102                 is  enabled,  xscope will stop for interactive commands after
103                 processing a request of the specified  type.    Requests  and
104                 extensions  may be specified by name or number.  If an exten‐
105                 sion is followed by a ":" and a number, it  will  only  break
106                 for  the  specified  minor  opcode for that extension.   Note
107                 that since extension opcodes are not known until  the  exten‐
108                 sion  is  first  seen, breakpoints cannot currently be set on
109                 extensions until after a QueryExtension request and reply are
110                 processed  for that extension, so users may need to initially
111                 set a breakpoint on QueryExtension, and after processing that
112                 set the breakpoint for the target extension.
113
114       cont, c   Resume processing of data passing between server and clients.
115
116       delete, del
117                 Delete all breakpoints.
118
119       delete breakpoint..., del breakpoint...
120                 Delete listed breakpoints, specified by number.
121
122       disable, d
123                 Disable all breakpoints.
124
125       disable breakpoint..., d breakpoint...
126                 Disable listed breakpoints, specified by number.
127
128       enable, e Enable all breakpoints.
129
130       enable breakpoint..., e breakpoint...
131                 Enable listed breakpoints, specified by number.
132
133       help, ?   Print list of available commands.
134
135       help command..., ? command...
136                 Describe specified command or commands.
137
138       level, l  Show current verbosity level for X11 protocol packets.
139
140       level n, l n
141                 Set current verbosity level for X11 protocol packets to n.
142
143       quit, q   Quit xscope.
144
145       step, s   Process one request, then prompt for another command.
146

EXAMPLES

148       xscope -v4 -hcleo -d0 -o0 -i1
149
150       This  command  would have xscope communicate with an X11 server on host
151       ``cleo'', display 0;  xscope itself would be available on  the  current
152       host as display 1 (display of 0 plus the 1 of -i1). Verbose level 4.
153
154       xscope -q -d1 -o1 -o3
155
156       The  X11  server  for the current host, display 2 (1 for -d1 plus 1 for
157       -o1) would be used by xscope which would run as display 4  (1  for  -d1
158       plus 3 for -o3). Quiet mode (verbose level 0).
159

SEE ALSO

161       X(7), Xsecurity(7), X11 Protocol and extension protocol documents
162

AUTHOR

164       James L. Peterson (MCC)
165
166       Copyright (C) 1988 MCC
167
168       Permission to use, copy, modify, distribute, and sell this software and
169       its documentation for any purpose is hereby granted without  fee,  pro‐
170       vided  that  the  above  copyright notice appear in all copies and that
171       both that copyright notice and this permission notice  appear  in  sup‐
172       porting  documentation,  and that the name of MCC not be used in adver‐
173       tising or publicity pertaining to distribution of the software  without
174       specific, written prior permission.  MCC makes no representations about
175       the suitability of this software for any purpose.  It is  provided  "as
176       is" without express or implied warranty.
177
178       MCC  DISCLAIMS  ALL  WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
179       ALL IMPLIED WARRANTIES OF MERCHANTABILITY  AND  FITNESS,  IN  NO  EVENT
180       SHALL  MCC BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
181       OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  PROFITS,
182       WHETHER  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
183       ARISING OUT OF OR IN CONNECTION WITH THE USE  OR  PERFORMANCE  OF  THIS
184       SOFTWARE.
185
186
187
188
189X Version 11                     xscope 1.4.1                        XSCOPE(1)
Impressum