man page: add missing options & info, fix formatting

Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>

1 files changed, 38 insertions, 13 deletions

diff --git a/xscope.man b/xscope.man
index 50f9b34..a5502d9 100644
--- a/xscope.man
+++ b/xscope.man
@@ -1,13 +1,19 @@
-.TH XSCOPE 1 "8 Sept 1988" "X Version 11"
+.TH XSCOPE 1 __xorgversion__
 .SH NAME
 xscope - X Window Protocol Viewer
 .SH SYNOPSIS
 .B xscope
-[ option ] ...
+[\fB-i\fP\fI<in-port>\fP] [\fB-o\fP\fI<out-port>\fP]
+[\fB-h\fP\fI<server-host>\fP] [\fB-d\fP\fI<display-number>\fP]
+[\fB-q\fP] [\fB-v\fP\fI<n>\fP] [\fB-r\fP]
+[\fB-D\fP\fI<debug-level>\fP] [\fB-S\fP\fI<n>\fP] [\fB-t\fP]
 .SH DESCRIPTION
 .I Xscope
 sits in-between an X11 client and an X11 server and prints the contents
 of each request, reply, error, or event that is communicated between them.
+.I Xscope
+can decode the core X11 protocol and several extensions, including
+BIG-REQUESTS, LBX, MIT-SHM, NCD-WinCenterPro, RANDR, and RENDER.
 This information can be useful in debugging and performance
 tuning of X11 servers and clients.
 .PP
@@ -20,7 +26,7 @@ which it should listen for X11 clients.  Two cases are common:
 In this case, the input port for \fIxscope\fP should be selected as an
 X11 server on a different display, and the client DISPLAY argument
 adjusted to select \fIxscope\fP .  For example, if the X11 server is
-on port 6000, display 1, then \fIxscope\fP can use port 6002 as its
+on port 6001, display 1, then \fIxscope\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 \fIxscope\fP.
 .PP
@@ -31,33 +37,33 @@ component of the DISPLAY is used to select \fIxscope\fP or X11.
 .SH ARGUMENTS
 .PP
 .TP 10
-.B \-i<input-port>
+.BI \-i <input-port>
 Specify the port that \fIxscope\fP will use to take requests from clients
 (defaults to 1).
 For X11, this port is automatically biased by 6000.
 .PP
 .TP 10
-.B \-o<output-port>
-Determines the port that 
-\fIxscope\fP will use to connect to X11 (defaults to 0). 
+.BI \-o <output-port>
+Determines the port that
+\fIxscope\fP will use to connect to X11 (defaults to 0).
 For X11, this port is automatically biased by 6000.
 .PP
 .TP 10
-.B \-h<host>
+.BI \-h <host>
 Determines the host that  \fIxscope\fP will use to find its X11 server.
 .PP
 .TP 10
-.B \-d<display>
+.BI \-d <display>
 Defines the display number.  The display number is added to the input
 and output port to give the actual ports which are used by  \fIxscope\fP.
 .PP
 .TP 10
 .B \-q
-Quiet output mode.  Gives only the names of requests, replies, errors, and 
+Quiet output mode.  Gives only the names of requests, replies, errors, and
 events, but does not indicate contents.
 .PP
 .TP 10
-.B \-v<print-level>
+.BI \-v <print-level>
 Determines the level of printing which \fIxscope\fP will provide.  The
 print-level can be 0 (same as quiet mode), 1, 2, 3, 4.  The larger
 numbers give more and more output.  For example, a successful setup
@@ -65,6 +71,23 @@ returns a string 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
+.B -r
+Print only raw data without decoding it.
+.PP
+.TP 10
+.BI -D <debug-level>
+Print debugging information at the specified level.
+.PP
+.TP 10
+.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
+.B -t
+Terminate \fIxscope\fP when all clients close.
 .SH EXAMPLES
 .LP
 xscope -v4 -hcleo -d0 -o0 -i1
@@ -77,9 +100,11 @@ xscope -q -d1 -o1 -o3
 .PP
 The X11 server for the current host, display 2 (1 for -d1 plus 1 for -o1)
 would be used by xscope which would run as display 4 (1 for -d1 plus 3 for
--o3). Quite mode (verbose level 0).
+-o3). Quiet mode (verbose level 0).
 .SH SEE ALSO
-X(1), X11 Protocol document (doc/Protocol/X11.protocol)
+.BR X (__miscmansuffix__),
+.BR Xsecurity (__miscmansuffix__),
+X11 Protocol and extension protocol documents
 .SH AUTHOR
 .PP
 James L. Peterson (MCC)