[m-rev.] for review: document mdb's options in the user guide

[Ian MacLarty]

Estimated hours taken: 0.3
Branches: main

doc/user_guide.texi:
	Document mdb's command line options in the user guide.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.452
diff -u -r1.452 user_guide.texi
--- doc/user_guide.texi	1 Sep 2005 12:04:27 -0000	1.452
+++ doc/user_guide.texi	10 Oct 2005 06:15:55 -0000
@@ -1825,7 +1825,7 @@
 The executables of Mercury programs
 by default do not invoke the Mercury debugger
 even if some or all of their modules were compiled with some form of tracing,
-and even if the grade of the executable is a debugging grade,
+and even if the grade of the executable is a debugging grade.
 This is similar to the behaviour of executables
 created by the implementations of other languages;
 for example the executable of a C program compiled with @samp{-g}
@@ -1845,7 +1845,7 @@
 you must execute the command

 @example
-mdb @var{prog} @var{arg1} @var{arg2} ...
+mdb [@var{mdb-options}] @var{prog} @var{arg1} @var{arg2} ...
 @end example

 because you do not get a chance
@@ -1875,6 +1875,40 @@
 The file named @samp{.mdbrc} in the current working directory.
 You can put program-specific aliases and settings here.
 @end enumerate
+
+mdb accepts the following options from the command line.  The options
+should be given to mdb before the name of the executable to be debugged.
+
+ at table @code
+ at item -t @var{file-name}, --tty @var{file-name}
+Redirect all of the I/O for the debugger to the device
+specified by @var{file-name}.  The I/O for the program
+being debugged will not be redirected.
+This option allows the contents of a file to be piped to the program being
+debugged and not to mdb.  For example on Linux the command
+ at samp{mdb -t /dev/tty ./myprog < myinput} will cause the contents of myinput
+to be piped to the program myprog, but mdb will read its input from
+the terminal.
+ at sp 1
+ at item -w, --window, --mdb-in-window
+Run mdb in a new window, with mdb's I/O going to that
+window, but with the program's I/O going to the current
+terminal.  Note that this will not work on all systems.
+ at sp 1
+ at item --program-in-window
+Run the program in a new window, with the program's I/O
+going to that window, but with mdb's I/O going to the
+current terminal.  Note that input and output redirection
+will not work with the @samp{--program-in-window} option.
+ at samp{--program-in-window} will work on most UNIX systems
+running the X Window System, even those for which
+ at samp{--mdb-in-window} is not supported.
+ at sp 1
+ at item -c @var{window-command}, --window-command @var{window-command}
+Specify the command used by the @samp{--program-in-window}
+option for executing a command in a new window.
+The default such command is @samp{xterm -e}.
+ at end table

 @node Mercury debugger concepts
 @section Mercury debugger concepts

--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------