trivial diff: minor fixes to the user's guide

[Fergus Henderson]

Estimated hours taken: 0.5

doc/user_guide.texi:
	Fix a few typos and formatting errors.
	Use `-' rather than `_' in meta-variable names,
	because the latter were being printed out as raised dots
	rather than underscores in the dvi output.

Index: doc/user_guide.texi
===================================================================
RCS file: /home/mercury1/repository/mercury/doc/user_guide.texi,v
retrieving revision 1.151
diff -u -r1.151 user_guide.texi
--- user_guide.texi	1998/11/15 17:24:04	1.151
+++ user_guide.texi	1998/11/16 08:41:10
@@ -261,8 +261,8 @@
 contained in the C code of the modules of the program:
 
 @example
-c2init @var{module1}.c @var{module2}.c ... > @var{main_module}_init.c,
-mgnuc -c @var{main_module}_init.c
+c2init @var{module1}.c @var{module2}.c ... > @var{main-module}_init.c,
+mgnuc -c @var{main-module}_init.c
 @end example
 
 The @samp{c2init} command line must contain
@@ -278,7 +278,7 @@
 with the object code of the initialization file to yield the executable:
 
 @example
-ml -o @var{main_module} @var{module1}.o @var{module2}.o ... @var{main_module}_init.o
+ml -o @var{main-module} @var{module1}.o @var{module2}.o ... @var{main_module}_init.o
 @end example
 
 @samp{ml}, the Mercury linker, is another shell script
@@ -289,7 +289,7 @@
 the Mercury source code rather than to the names used in the intermediate
 C code.
 
-The above command puts the executable in the file @file{@var{main_module}}.
+The above command puts the executable in the file @file{@var{main-module}}.
 The same command line without the @samp{-o} option
 would put the executable into the file @file{a.out}.
 
@@ -953,7 +953,7 @@
 at every execution point that represents a potential trace event,
 which is very convenient.
 
-The two drawbacks of using a debugging grade,
+The two drawbacks of using a debugging grade
 are the large size of the resulting executables,
 and the fact that often you discover that you need to debug a big program
 only after having built it in a non-debugging grade.
@@ -990,19 +990,19 @@
 
 The intended uses of these trace levels are as follows.
 
- at table @emph
- at item
+ at table @samp
+ at item deep
 You should compile a module with trace level @samp{deep}
 if you suspect there may be a bug in the module,
 or if you think that being able to examine what happens inside that module
 can help you locate a bug.
- at item
+ at item shallow
 You should compile a module with trace level @samp{shallow}
 if you believe the code of the module is reliable and unlikely to have bugs,
 but you still want to be able to get control at calls to and returns from
 any predicates and functions defined in the module,
 and if you want to be able to see the arguments of those calls.
- at item
+ at item none
 You should compile a module with trace level @samp{none}
 only if you are reasonably confident that the module is reliable,
 and if you believe that knowing what calls other modules make to this module
@@ -1151,7 +1151,7 @@
 
 When the debugger starts up, as part of its initialization
 it executes commands from the following three sources, in order:
- at table @emph
+ at enumerate
 @item
 The file named by the @samp{MERCURY_DEBUGGER_INIT} environment variable.
 Usually, @samp{mdb} sets this variable to point to a file
@@ -1169,7 +1169,7 @@
 @item
 The file named @samp{.mdbrc} in the current working directory.
 You can put program-specific aliases and settings here.
- at end table
+ at end enumerate
 
 @node Mercury debugger concepts
 @section Mercury debugger concepts
@@ -1598,7 +1598,7 @@
 @subsection Breakpoint commands
 @sp 1
 @table @code
- at item break [-PSaei] @var{proc_spec}
+ at item break [-PSaei] @var{proc-spec}
 @c <module name> <predicate name> [<arity> [<mode> [<predfunc>]]]
 Puts a break point on the specified procedure.
 @sp 1
@@ -1704,7 +1704,7 @@
 @item scroll
 Reports whether user scroll control is enabled and what the window size is.
 @sp 1
- at item alias @var{name} @var{command} [@var{command_parameter} ...]
+ at item alias @var{name} @var{command} [@var{command-parameter} ...]
 Introduces @var{name} as an alias
 for the given command with the given parameters.
 Whenever a command line has @var{name} as its first word,
@@ -2560,7 +2560,7 @@
 
 @sp 1
 @item --type-inference-iteration-limit @var{n}
-Perform at most @var{n} passes of mode inference (default: 60).
+Perform at most @var{n} passes of type inference (default: 60).
 
 @sp 1
 @item --mode-inference-iteration-limit @var{n}
@@ -3391,7 +3391,7 @@
 
 @sp 1
 @item -?
- at item -h
+ at itemx -h
 @itemx --help
 Print a usage message.
 
@@ -3600,10 +3600,10 @@
 @c and to print the result of this time measurement.
 
 @sp 1
- at item -T @var{time_method}
+ at item -T @var{time-method}
 If the executable was compiled in a grade that includes time profiling,
 this option specifies what time is counted in the profile.
- at var{time_method} must have one of the following values:
+ at var{time-method} must have one of the following values:
 
 @sp 1
 @table @code
@@ -3766,7 +3766,7 @@
 You can link these together using the command
 
 @example
-mnl -o @var{main_module} @var{filename1}.no ...
+mnl -o @var{main-module} @var{filename1}.no ...
 @end example
 
 Ignore any warnings such as
@@ -3779,11 +3779,11 @@
 
 @samp{mnl}, the Mercury NU-Prolog linker,
 will put the executable (actually a shell script invoking a save file)
-into the file @file{@var{main_module}.nu}.
+into the file @file{@var{main-module}.nu}.
 This can be executed normally using
 
 @example
-./@var{main_module}.nu @var{arguments}
+./@var{main-module}.nu @var{arguments}
 @end example
 
 Alternatively, one can execute such programs using @samp{mnp},

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "Binaries may die
WWW: <http://www.cs.mu.oz.au/~fjh>  |   but source code lives forever"
PGP: finger fjh at 128.250.37.3        |     -- leaked Microsoft memo.