Add interactive mode description & command list to man page

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

1 files changed, 59 insertions, 0 deletions

diff --git a/xscope.man b/xscope.man
index a5502d9..b52746f 100644
--- a/xscope.man
+++ b/xscope.man
@@ -88,6 +88,65 @@ the initial state is off.  If \fIn\fP is 1, the initial state is on.
 .TP 10
 .B -t
 Terminate \fIxscope\fP when all clients close.
+.SH INTERACTIVE MODE
+.PP
+When \fBxscope\fP receives an interrupt signal (normally generated by
+Control-C) it enters an interactive mode in which it prompts for commands.
+Available commands in this mode are:
+.TP 10
+.B audio, a
+Show current verbosity level for NAS protocol packets.
+.TP 10
+\fBaudio\fP \fIn\fP, \fBa\fP \fIn\fP
+Set current verbosity level for NAS protocol packets to \fIn\fP.
+.TP 10
+.B break, b
+List currently defined breakpoints.
+.TP 10
+\fBbreak\fP \fIrequest...\fP, \fBb\fP \fIrequest...\fP
+Create a breakpoint for the specified protocol requests.  The breakpoint
+will be enabled by default.   When the breakpoint is enabled, \fBxscope\fP
+will stop for interactive commands after processing a request of the
+specified type.
+.TP 10
+.B cont, c
+Resume processing of data passing between server and clients.
+.TP 10
+.B delete, del
+Delete all breakpoints.
+.TP 10
+\fBdelete\fP \fIbreakpoint...\fP, \fBdel\fP \fIbreakpoint...\fP
+Delete listed breakpoints, specified by number.
+.TP 10
+.B disable, d
+Disable all breakpoints.
+.TP 10
+\fBdisable\fP \fIbreakpoint...\fP, \fBd\fP \fIbreakpoint...\fP
+Disable listed breakpoints, specified by number.
+.TP 10
+.B enable, e
+Enable all breakpoints.
+.TP 10
+\fBenable\fP \fIbreakpoint...\fP, \fBe\fP \fIbreakpoint...\fP
+Enable listed breakpoints, specified by number.
+.TP 10
+.B help, ?
+Print list of available commands.
+.TP 10
+\fBhelp\fP \fIcommand...\fP, \fB?\fP \fIcommand...\fP
+Describe specified command or commands.
+.TP 10
+.B level, l
+Show current verbosity level for X11 protocol packets.
+.TP 10
+\fBlevel\fP \fIn\fP, \fBl\fP \fIn\fP
+Set current verbosity level for X11 protocol packets to \fIn\fP.
+.TP 10
+.B quit, q
+Quit \fBxscope\fP.
+.TP 10
+.B step, s
+Process one request, then prompt for another command.
 .SH EXAMPLES
 .LP
 xscope -v4 -hcleo -d0 -o0 -i1