summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2025-05-31 12:20:53 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2025-06-07 16:02:46 -0700
commit31b838d61caea9e8b1dd5dcf09c22c4b39131717 (patch)
treee8d47fda5694386d7414c77f4a4d665269174e3a
parentd0a61a2655e652205b6c029a5952aec710deb267 (diff)
man page: fix warnings from `mandoc -T lint` and `groff -rCHECKSTYLE=10`HEADmaster
mandoc: xscope.1:64:81: STYLE: input text line longer than 80 bytes: Determines the port ... mandoc: xscope.1:1:14: WARNING: cannot parse date, using it verbatim: TH xscope 1.4.5 mandoc: xscope.1:39:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:49:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:55:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:61:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:66:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:70:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:76:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:81:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:85:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:91:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:95:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:100:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:104:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:108:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:124:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:130:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:134:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:145:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:149:2: WARNING: skipping paragraph macro: PP empty mandoc: xscope.1:154:2: WARNING: skipping paragraph macro: PP after SH mandoc: xscope.1:221:2: WARNING: skipping paragraph macro: PP after SH mandoc: xscope.1:239:2: WARNING: skipping paragraph macro: PP after SH an.tmac:xscope.1:75: style: .BI expects at least 2 arguments, got 1 an.tmac:xscope.1:83: style: .BI expects at least 2 arguments, got 1 an.tmac:xscope.1:86: style: .BI expects at least 2 arguments, got 1 an.tmac:xscope.1:129: style: .BI expects at least 2 arguments, got 1 Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Part-of: <https://gitlab.freedesktop.org/xorg/app/xscope/-/merge_requests/17>
-rw-r--r--man/xscope.man49
1 files changed, 14 insertions, 35 deletions
diff --git a/man/xscope.man b/man/xscope.man
index 71bdecc..8ec35ba 100644
--- a/man/xscope.man
+++ b/man/xscope.man
@@ -1,4 +1,4 @@
-.TH XSCOPE 1 __xorgversion__
+.TH XSCOPE 1 2025-05-31 __xorgversion__
.SH NAME
xscope - X Window Protocol Viewer
.SH SYNOPSIS
@@ -36,7 +36,6 @@ To operate, \fBxscope\fP must know the host, port, and display to use
to connect to the X11 server.
In addition, it must know the port on which it should listen for X11 clients.
Two cases are common:
-.PP
.TP 5
(1) The X11 server is on the same host as \fBxscope\fP.
In this case, the input port for \fBxscope\fP should be selected as an
@@ -46,68 +45,56 @@ For example, if the X11 server is on port 6001, display 1,
then \fBxscope\fP can use port 6002 as its input port.
The client can use display 1 for direct access to X11 or
display 2 for access to \fBxscope\fP.
-.PP
.TP 5
(2) The X11 server is on a different host than \fBxscope\fP.
In this case the same input and output ports can be used,
and the host component of the DISPLAY is used to select \fBxscope\fP or X11.
.SH ARGUMENTS
-.PP
.TP 10
.BI \-i in-port
Specify the port that \fBxscope\fP will use to take requests from clients
(defaults to 1).
For X11, this port is automatically biased by 6000.
-.PP
.TP 10
.BI \-o output-port
-Determines the port that \fBxscope\fP will use to connect to X11 (defaults to 0).
+Determines the port that \fBxscope\fP will use to connect to the X11 server
+(defaults to 0).
For X11, this port is automatically biased by 6000.
-.PP
.TP 10
.BI \-h host
Determines the host that \fBxscope\fP will use to find its X11 server.
-.PP
.TP 10
.BI \-d display-number
Defines the display number.
The display number is added to the input and output port
to give the actual ports which are used by \fBxscope\fP.
-.PP
.TP 10
.BI \-f filename
Instead of decoding a live session,
reads previously captured raw data from a file to decode.
-.PP
.TP 10
-.BI -I
+.B \-I
Enter interactive mode at startup.
-.PP
.TP 10
-.BI -S n
+.BI \-S n
Toggle output on or off when SIGUSR1 is received.
If \fIn\fP is 0, the initial state is off.
If \fIn\fP is 1, the initial state is on.
-.PP
.TP 10
-.BI -T
+.B \-T
Transpose some output with an offset of 0x20.
-.PP
.TP 10
-.BI -A
+.B \-A
Enables tracing of the Network Audio System (NAS) protocol as well,
using a port number derived by adding 2000 to the X11 port number.
-.PP
.TP 10
-.BI -a level
+.BI \-a level
NAS verbose output level (1 to 4, 1 by default).
-.PP
.TP 10
-.BI -n server-host
+.BI \-n server-host
Set the hostname of the NAS server to connect to.
-.PP
.TP 10
-.BI -D level
+.BI \-D level
Print debugging information at the specified level (255 by default):
.IP
\- 2, Trace each procedure entry
@@ -121,17 +108,14 @@ Print debugging information at the specified level (255 by default):
\- 32 to 64, Was malloc, now unused
.IP
\- 128 to 256, Really low level
-.PP
.TP 10
.B \-q
Quiet output mode.
Gives only the names of requests, replies, errors, and events,
but does not indicate contents.
-.PP
.TP 10
-.B -r
+.B \-r
Print only raw data without decoding it.
-.PP
.TP 10
.BI \-v level
Determines the level of printing which \fBxscope\fP will provide.
@@ -142,18 +126,15 @@ which is the name of the vendor of the X11 server.
At level 1, the explicit field giving the length of the string is
suppressed since it can be inferred from the string.
At level 2 and above the length is explicitly printed.
-.PP
.TP 10
-.BI -V
+.B \-V
Print version information and exit.
-.PP
.TP 10
-.B -t
+.B \-t
Terminate \fBxscope\fP when all clients close.
.SH INTERACTIVE MODE
-.PP
When \fBxscope\fP receives an interrupt signal (normally generated by
-Control-C) or is started with the -I flag,
+Control-C) or is started with the \-I flag,
it enters an interactive mode in which it prompts for commands.
Available commands in this mode are:
.TP 10
@@ -218,7 +199,6 @@ Quit \fBxscope\fP.
.BR step ", " s
Process one request, then prompt for another command.
.SH EXAMPLES
-.LP
xscope \-v4 \-hcleo \-d0 \-o0 \-i1
.PP
This command would have xscope communicate with an X11 server on host
@@ -236,7 +216,6 @@ Quiet mode (verbose level 0).
.BR Xsecurity (__miscmansuffix__),
X11 Protocol and extension protocol documents
.SH AUTHOR
-.PP
James L. Peterson (MCC)
.PP
Copyright (C) 1988 MCC