Next stage of doing GOOBE improvements to documentation now that the html generation works

1 files changed, 40 insertions, 14 deletions

diff --git a/doc/subst.n b/doc/subst.n
index f52a155..8f4cb91 100644
--- a/doc/subst.n
+++ b/doc/subst.n
@@ -6,7 +6,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: subst.n,v 1.13 2007/10/28 14:17:40 dkf Exp $
+'\" RCS: @(#) $Id: subst.n,v 1.14 2007/10/29 01:42:19 dkf Exp $
 '\" 
 .so man.macros
 .TH subst n 7.4 Tcl "Tcl Built-In Commands"
@@ -17,7 +17,6 @@ subst \- Perform backslash, command, and variable substitutions
 .SH SYNOPSIS
 \fBsubst \fR?\fB\-nobackslashes\fR? ?\fB\-nocommands\fR? ?\fB\-novariables\fR? \fIstring\fR
 .BE
-
 .SH DESCRIPTION
 .PP
 This command performs variable substitutions, command substitutions,
@@ -56,7 +55,9 @@ will be substituted for that entire command or variable substitution
 or any other return code is returned during command or variable
 substitution, then the returned value is substituted for that
 substitution.  See the EXAMPLES below.  In this way, all exceptional
-return codes are ``caught'' by \fBsubst\fR.  The \fBsubst\fR command
+return codes are
+.QW caught
+by \fBsubst\fR.  The \fBsubst\fR command
 itself will either return an error, or will complete successfully.
 .SH EXAMPLES
 .PP
@@ -67,21 +68,31 @@ command substitutions) so the script
 set a 44
 \fBsubst\fR {xyz {$a}}
 .CE
-returns ``\fBxyz {44}\fR'', not ``\fBxyz {$a}\fR''
+returns
+.QW "\fBxyz {44}\fR" ,
+not
+.QW "\fBxyz {$a}\fR"
 and the script
 .CS
 set a "p\e} q \e{r"
 \fBsubst\fR {xyz {$a}}
 .CE
-return ``\fBxyz {p} q {r}\fR'', not ``\fBxyz {p\e} q \e{r}\fR''.
+returns
+.QW "\fBxyz {p} q {r}\fR" ,
+not
+.QW "\fBxyz {p\e} q \e{r}\fR".
 .PP
 When command substitution is performed, it includes any variable
-substitution necessary to evaluate the script.  
+substitution necessary to evaluate the script.
 .CS
 set a 44
 \fBsubst\fR -novariables {$a [format $a]}
 .CE
-returns ``\fB$a 44\fR'', not ``\fB$a $a\fR''.  Similarly, when
+returns
+.QW "\fB$a 44\fR" ,
+not
+.QW "\fB$a $a\fR" .
+Similarly, when
 variable substitution is performed, it includes any command
 substitution necessary to retrieve the value of the variable.
 .CS
@@ -89,7 +100,10 @@ proc b {} {return c}
 array set a {c c [b] tricky}
 \fBsubst\fR -nocommands {[b] $a([b])}
 .CE
-returns ``\fB[b] c\fR'', not ``\fB[b] tricky\fR''.
+returns
+.QW "\fB[b] c\fR" ,
+not
+.QW "\fB[b] tricky\fR" .
 .PP
 The continue and break exceptions allow command substitutions to
 prevent substitution of the rest of the command substitution and the
@@ -98,24 +112,36 @@ when processing text using \fIsubst\fR.  For example, the script
 .CS
 \fBsubst\fR {abc,[break],def}
 .CE
-returns ``\fBabc,\fR'', not ``\fBabc,,def\fR'' and the script
+returns
+.QW \fBabc,\fR ,
+not
+.QW \fBabc,,def\fR
+and the script
 .CS
 \fBsubst\fR {abc,[continue;expr {1+2}],def}
 .CE
-returns ``\fBabc,,def\fR'', not ``\fBabc,3,def\fR''.
+returns
+.QW \fBabc,,def\fR ,
+not
+.QW \fBabc,3,def\fR .
 .PP
 Other exceptional return codes substitute the returned value
 .CS
 \fBsubst\fR {abc,[return foo;expr {1+2}],def}
 .CE
-returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR'' and
+returns
+.QW \fBabc,foo,def\fR ,
+not
+.QW \fBabc,3,def\fR
+and
 .CS
 \fBsubst\fR {abc,[return -code 10 foo;expr {1+2}],def}
 .CE
-also returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR''.
-
+also returns
+.QW \fBabc,foo,def\fR ,
+not
+.QW \fBabc,3,def\fR .
 .SH "SEE ALSO"
 Tcl(n), eval(n), break(n), continue(n)
-
 .SH KEYWORDS
 backslash substitution, command substitution, variable substitution