[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / mann / subst.n

'\"
'\" Copyright (c) 1994 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\" Copyright (c) 2001 Donal K. Fellows
'\"
'\" 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.5.2.1 2004/10/27 14:23:58 dkf Exp $
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH subst n 7.4 Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
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,
and backslash substitutions on its \fIstring\fR argument and
returns the fully-substituted result.
The substitutions are performed in exactly the same way as for
Tcl commands.
As a result, the \fIstring\fR argument is actually substituted twice,
once by the Tcl parser in the usual fashion for Tcl commands, and
again by the \fIsubst\fR command.
.PP
If any of the \fB\-nobackslashes\fR, \fB\-nocommands\fR, or
\fB\-novariables\fR are specified, then the corresponding substitutions
are not performed.
For example, if \fB\-nocommands\fR is specified, command substitution
is not performed:  open and close brackets are treated as ordinary characters
with no special interpretation.
.PP
.VS 8.4
Note that the substitution of one kind can include substitution of 
other kinds.  For example, even when the \fB-novariables\fR option
is specified, command substitution is performed without restriction.
This means that any variable substitution necessary to complete the
command substitution will still take place.  Likewise, any command
substitution necessary to complete a variable substitution will
take place, even when \fB-nocommands\fR is specified.  See the
EXAMPLES below.
.PP
If an error occurs during substitution, then \fBsubst\fR will return
that error.  If a break exception occurs during command or variable
substitution, the result of the whole substitution will be the
string (as substituted) up to the start of the substitution that
raised the exception.  If a continue exception occurs during the
evaluation of a command or variable substitution, an empty string
will be substituted for that entire command or variable substitution
(as long as it is well-formed Tcl.)  If a return exception occurs,
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
itself will either return an error, or will complete successfully.
.VE
.SH EXAMPLES
.PP
When it performs its substitutions, \fIsubst\fR does not give any
special treatment to double quotes or curly braces (except within
command substitutions) so the script
.CS
set a 44
\fBsubst\fR {xyz {$a}}
.CE
returns ``\fBxyz {44}\fR'', not ``\fBxyz {$a}\fR''
.VS 8.4
and the script
.CS
set a "p\\} q \\{r"
\fBsubst\fR {xyz {$a}}
.CE
return ``\fBxyz {p} q {r}\fR'', not ``\fBxyz {p\\} q \\{r}\fR''.
.PP
When command substitution is performed, it includes any variable
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
variable substitution is performed, it includes any command
substitution necessary to retrieve the value of the variable.
.CS
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''.
.PP
The continue and break exceptions allow command substitutions to
prevent substitution of the rest of the command substitution and the
rest of \fIstring\fR respectively, giving script authors more options
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
.CS
\fBsubst\fR {abc,[continue;expr 1+2],def}
.CE
returns ``\fBabc,,def\fR'', not ``\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
.CS
\fBsubst\fR {abc,[return -code 10 foo;expr 1+2],def}
.CE
also returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR''.
.VE

.SH "SEE ALSO"
Tcl(n), eval(n), break(n), continue(n)

.SH KEYWORDS
backslash substitution, command substitution, variable substitution
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 1994 The Regents of the University of California.
	3	'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
	4	'\" Copyright (c) 2001 Donal K. Fellows
	5	'\"
	6	'\" See the file "license.terms" for information on usage and redistribution
	7	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	8	'\"
	9	'\" RCS: @(#) $Id: subst.n,v 1.5.2.1 2004/10/27 14:23:58 dkf Exp $
	10	'\"
	11	'\" The definitions below are for supplemental macros used in Tcl/Tk
	12	'\" manual entries.
	13	'\"
	14	'\" .AP type name in/out ?indent?
	15	'\" Start paragraph describing an argument to a library procedure.
	16	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	17	'\" or "in/out" to describe whether procedure reads or modifies arg,
	18	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	19	'\" needed; use .AS below instead)
	20	'\"
	21	'\" .AS ?type? ?name?
	22	'\" Give maximum sizes of arguments for setting tab stops. Type and
	23	'\" name are examples of largest possible arguments that will be passed
	24	'\" to .AP later. If args are omitted, default tab stops are used.
	25	'\"
	26	'\" .BS
	27	'\" Start box enclosure. From here until next .BE, everything will be
	28	'\" enclosed in one large box.
	29	'\"
	30	'\" .BE
	31	'\" End of box enclosure.
	32	'\"
	33	'\" .CS
	34	'\" Begin code excerpt.
	35	'\"
	36	'\" .CE
	37	'\" End code excerpt.
	38	'\"
	39	'\" .VS ?version? ?br?
	40	'\" Begin vertical sidebar, for use in marking newly-changed parts
	41	'\" of man pages. The first argument is ignored and used for recording
	42	'\" the version when the .VS was added, so that the sidebars can be
	43	'\" found and removed when they reach a certain age. If another argument
	44	'\" is present, then a line break is forced before starting the sidebar.
	45	'\"
	46	'\" .VE
	47	'\" End of vertical sidebar.
	48	'\"
	49	'\" .DS
	50	'\" Begin an indented unfilled display.
	51	'\"
	52	'\" .DE
	53	'\" End of indented unfilled display.
	54	'\"
	55	'\" .SO
	56	'\" Start of list of standard options for a Tk widget. The
	57	'\" options follow on successive lines, in four columns separated
	58	'\" by tabs.
	59	'\"
	60	'\" .SE
	61	'\" End of list of standard options for a Tk widget.
	62	'\"
	63	'\" .OP cmdName dbName dbClass
	64	'\" Start of description of a specific option. cmdName gives the
65	'\" option's name as specified in the class command, dbName gives
66	'\" the option's name in the option database, and dbClass gives
67	'\" the option's class in the option database.
68	'\"
69	'\" .UL arg1 arg2
70	'\" Print arg1 underlined, then print arg2 normally.
71	'\"
72	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73	'\"
74	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
75	.if t .wh -1.3i ^B
76	.nr ^l \n(.l
77	.ad b
78	'\" # Start an argument description
79	.de AP
80	.ie !"\\$4"" .TP \\$4
81	.el \{\
82	. ie !"\\$2"" .TP \\n()Cu
83	. el .TP 15
84	.\}
85	.ta \\n()Au \\n()Bu
86	.ie !"\\$3"" \{\
87	\&\\$1 \\fI\\$2\\fP (\\$3)
88	.\".b
89	.\}
90	.el \{\
91	.br
92	.ie !"\\$2"" \{\
93	\&\\$1 \\fI\\$2\\fP
94	.\}
95	.el \{\
96	\&\\fI\\$1\\fP
97	.\}
98	.\}
99	..
100	'\" # define tabbing values for .AP
101	.de AS
102	.nr )A 10n
103	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
104	.nr )B \\n()Au+15n
105	.\"
106	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
107	.nr )C \\n()Bu+\\w'(in/out)'u+2n
108	..
109	.AS Tcl_Interp Tcl_CreateInterp in/out
110	'\" # BS - start boxed text
111	'\" # ^y = starting y location
112	'\" # ^b = 1
113	.de BS
114	.br
115	.mk ^y
116	.nr ^b 1u
117	.if n .nf
118	.if n .ti 0
119	.if n \l'\\n(.lu\(ul'
120	.if n .fi
121	..
122	'\" # BE - end boxed text (draw box now)
123	.de BE
124	.nf
125	.ti 0
126	.mk ^t
127	.ie n \l'\\n(^lu\(ul'
128	.el \{\
129	.\" Draw four-sided box normally, but don't draw top of
130	.\" box if the box started on an earlier page.
131	.ie !\\n(^b-1 \{\
132	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
133	.\}
134	.el \}\
135	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
136	.\}
137	.\}
138	.fi
139	.br
140	.nr ^b 0
141	..
142	'\" # VS - start vertical sidebar
143	'\" # ^Y = starting y location
144	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
145	.de VS
146	.if !"\\$2"" .br
147	.mk ^Y
148	.ie n 'mc \s12\(br\s0
149	.el .nr ^v 1u
150	..
151	'\" # VE - end of vertical sidebar
152	.de VE
153	.ie n 'mc
154	.el \{\
155	.ev 2
156	.nf
157	.ti 0
158	.mk ^t
159	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
160	.sp -1
161	.fi
162	.ev
163	.\}
164	.nr ^v 0
165	..
166	'\" # Special macro to handle page bottom: finish off current
167	'\" # box/sidebar if in box/sidebar mode, then invoked standard
168	'\" # page bottom macro.
169	.de ^B
170	.ev 2
171	'ti 0
172	'nf
173	.mk ^t
174	.if \\n(^b \{\
175	.\" Draw three-sided box if this is the box's first page,
176	.\" draw two sides but no top otherwise.
177	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
178	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
179	.\}
180	.if \\n(^v \{\
181	.nr ^x \\n(^tu+1v-\\n(^Yu
182	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
183	.\}
184	.bp
185	'fi
186	.ev
187	.if \\n(^b \{\
188	.mk ^y
189	.nr ^b 2
190	.\}
191	.if \\n(^v \{\
192	.mk ^Y
193	.\}
194	..
195	'\" # DS - begin display
196	.de DS
197	.RS
198	.nf
199	.sp
200	..
201	'\" # DE - end display
202	.de DE
203	.fi
204	.RE
205	.sp
206	..
207	'\" # SO - start of list of standard options
208	.de SO
209	.SH "STANDARD OPTIONS"
210	.LP
211	.nf
212	.ta 5.5c 11c
213	.ft B
214	..
215	'\" # SE - end of list of standard options
216	.de SE
217	.fi
218	.ft R
219	.LP
220	See the \\fBoptions\\fR manual entry for details on the standard options.
221	..
222	'\" # OP - start of full description for a single option
223	.de OP
224	.LP
225	.nf
226	.ta 4c
227	Command-Line Name: \\fB\\$1\\fR
228	Database Name: \\fB\\$2\\fR
229	Database Class: \\fB\\$3\\fR
230	.fi
231	.IP
232	..
233	'\" # CS - begin code excerpt
234	.de CS
235	.RS
236	.nf
237	.ta .25i .5i .75i 1i
238	..
239	'\" # CE - end code excerpt
240	.de CE
241	.fi
242	.RE
243	..
244	.de UL
245	\\$1\l'\|0\(ul'\\$2
246	..
247	.TH subst n 7.4 Tcl "Tcl Built-In Commands"
248	.BS
249	'\" Note: do not modify the .SH NAME line immediately below!
250	.SH NAME
251	subst \- Perform backslash, command, and variable substitutions
252	.SH SYNOPSIS
253	\fBsubst \fR?\fB\-nobackslashes\fR? ?\fB\-nocommands\fR? ?\fB\-novariables\fR? \fIstring\fR
254	.BE
255
256	.SH DESCRIPTION
257	.PP
258	This command performs variable substitutions, command substitutions,
259	and backslash substitutions on its \fIstring\fR argument and
260	returns the fully-substituted result.
261	The substitutions are performed in exactly the same way as for
262	Tcl commands.
263	As a result, the \fIstring\fR argument is actually substituted twice,
264	once by the Tcl parser in the usual fashion for Tcl commands, and
265	again by the \fIsubst\fR command.
266	.PP
267	If any of the \fB\-nobackslashes\fR, \fB\-nocommands\fR, or
268	\fB\-novariables\fR are specified, then the corresponding substitutions
269	are not performed.
270	For example, if \fB\-nocommands\fR is specified, command substitution
271	is not performed: open and close brackets are treated as ordinary characters
272	with no special interpretation.
273	.PP
274	.VS 8.4
275	Note that the substitution of one kind can include substitution of
276	other kinds. For example, even when the \fB-novariables\fR option
277	is specified, command substitution is performed without restriction.
278	This means that any variable substitution necessary to complete the
279	command substitution will still take place. Likewise, any command
280	substitution necessary to complete a variable substitution will
281	take place, even when \fB-nocommands\fR is specified. See the
282	EXAMPLES below.
283	.PP
284	If an error occurs during substitution, then \fBsubst\fR will return
285	that error. If a break exception occurs during command or variable
286	substitution, the result of the whole substitution will be the
287	string (as substituted) up to the start of the substitution that
288	raised the exception. If a continue exception occurs during the
289	evaluation of a command or variable substitution, an empty string
290	will be substituted for that entire command or variable substitution
291	(as long as it is well-formed Tcl.) If a return exception occurs,
292	or any other return code is returned during command or variable
293	substitution, then the returned value is substituted for that
294	substitution. See the EXAMPLES below. In this way, all exceptional
295	return codes are ``caught'' by \fBsubst\fR. The \fBsubst\fR command
296	itself will either return an error, or will complete successfully.
297	.VE
298	.SH EXAMPLES
299	.PP
300	When it performs its substitutions, \fIsubst\fR does not give any
301	special treatment to double quotes or curly braces (except within
302	command substitutions) so the script
303	.CS
304	set a 44
305	\fBsubst\fR {xyz {$a}}
306	.CE
307	returns ``\fBxyz {44}\fR'', not ``\fBxyz {$a}\fR''
308	.VS 8.4
309	and the script
310	.CS
311	set a "p\\} q \\{r"
312	\fBsubst\fR {xyz {$a}}
313	.CE
314	return ``\fBxyz {p} q {r}\fR'', not ``\fBxyz {p\\} q \\{r}\fR''.
315	.PP
316	When command substitution is performed, it includes any variable
317	substitution necessary to evaluate the script.
318	.CS
319	set a 44
320	\fBsubst\fR -novariables {$a [format $a]}
321	.CE
322	returns ``\fB$a 44\fR'', not ``\fB$a $a\fR''. Similarly, when
323	variable substitution is performed, it includes any command
324	substitution necessary to retrieve the value of the variable.
325	.CS
326	proc b {} {return c}
327	array set a {c c [b] tricky}
328	\fBsubst\fR -nocommands {[b] $a([b])}
329	.CE
330	returns ``\fB[b] c\fR'', not ``\fB[b] tricky\fR''.
331	.PP
332	The continue and break exceptions allow command substitutions to
333	prevent substitution of the rest of the command substitution and the
334	rest of \fIstring\fR respectively, giving script authors more options
335	when processing text using \fIsubst\fR. For example, the script
336	.CS
337	\fBsubst\fR {abc,[break],def}
338	.CE
339	returns ``\fBabc,\fR'', not ``\fBabc,,def\fR'' and the script
340	.CS
341	\fBsubst\fR {abc,[continue;expr 1+2],def}
342	.CE
343	returns ``\fBabc,,def\fR'', not ``\fBabc,3,def\fR''.
344	.PP
345	Other exceptional return codes substitute the returned value
346	.CS
347	\fBsubst\fR {abc,[return foo;expr 1+2],def}
348	.CE
349	returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR'' and
350	.CS
351	\fBsubst\fR {abc,[return -code 10 foo;expr 1+2],def}
352	.CE
353	also returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR''.
354	.VE
355
356	.SH "SEE ALSO"
357	Tcl(n), eval(n), break(n), continue(n)
358
359	.SH KEYWORDS
360	backslash substitution, command substitution, variable substitution