2 '\" Copyright (c) 1993 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4 '\" Copyright (c) 2001 Kevin B. Kenny. All rights reserved.
6 '\" See the file "license.terms" for information on usage and redistribution
7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
9 '\" RCS: @(#) $Id: lreplace.n,v 1.8 2001/11/14 23:38:39 hobbs Exp $
11 '\" The definitions below are for supplemental macros used in Tcl/Tk
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)
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.
27 '\" Start box enclosure. From here until next .BE, everything will be
28 '\" enclosed in one large box.
31 '\" End of box enclosure.
34 '\" Begin code excerpt.
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.
47 '\" End of vertical sidebar.
50 '\" Begin an indented unfilled display.
53 '\" End of indented unfilled display.
56 '\" Start of list of standard options for a Tk widget. The
57 '\" options follow on successive lines, in four columns separated
61 '\" End of list of standard options for a Tk widget.
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.
70 '\" Print arg1 underlined, then print arg2 normally.
72 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
74 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
78 '\" # Start an argument description
82 . ie !"\\$2"" .TP \\n()Cu
87 \&\\$1 \\fI\\$2\\fP (\\$3)
100 '\" # define tabbing values for .AP
103 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
106 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
107 .nr )C \\n()Bu+\\w'(in/out)'u+2n
109 .AS Tcl_Interp Tcl_CreateInterp in/out
110 '\" # BS - start boxed text
111 '\" # ^y = starting y location
119 .if n \l'\\n(.lu\(ul'
122 '\" # BE - end boxed text (draw box now)
127 .ie n \l'\\n(^lu\(ul'
129 .\" Draw four-sided box normally, but don't draw top of
130 .\" box if the box started on an earlier page.
132 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
135 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
142 '\" # VS - start vertical sidebar
143 '\" # ^Y = starting y location
144 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
148 .ie n 'mc \s12\(br\s0
151 '\" # VE - end of vertical sidebar
159 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
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.
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
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
195 '\" # DS - begin display
201 '\" # DE - end display
207 '\" # SO - start of list of standard options
209 .SH "STANDARD OPTIONS"
215 '\" # SE - end of list of standard options
220 See the \\fBoptions\\fR manual entry for details on the standard options.
222 '\" # OP - start of full description for a single option
227 Command-Line Name: \\fB\\$1\\fR
228 Database Name: \\fB\\$2\\fR
229 Database Class: \\fB\\$3\\fR
233 '\" # CS - begin code excerpt
239 '\" # CE - end code excerpt
247 .TH lreplace n 7.4 Tcl "Tcl Built-In Commands"
249 '\" Note: do not modify the .SH NAME line immediately below!
251 lreplace \- Replace elements in a list with new elements
253 \fBlreplace \fIlist first last \fR?\fIelement element ...\fR?
258 \fBlreplace\fR returns a new list formed by replacing one or more elements of
259 \fIlist\fR with the \fIelement\fR arguments.
260 \fIfirst\fR and \fIlast\fR specify the first and last index of the
261 range of elements to replace. 0 refers to the first element of the
262 list, and \fBend\fR (or any abbreviation of it) may be used to refer
263 to the last element of the list. If \fIlist\fR is empty, then
264 \fIfirst\fR and \fIlast\fR are ignored.
266 If \fIfirst\fR is less than zero, it is considered to refer to the
267 first element of the list. For non-empty lists, the element indicated
268 by \fIfirst\fR must exist.
270 If \fIlast\fR is less than zero but greater than \fIfirst\fR, then any
271 specified elements will be prepended to the list. If \fIlast\fR is
272 less than \fIfirst\fR then no elements are deleted; the new elements
273 are simply inserted before \fIfirst\fR.
275 The \fIelement\fR arguments specify zero or more new arguments to
276 be added to the list in place of those that were deleted.
277 Each \fIelement\fR argument will become a separate element of
278 the list. If no \fIelement\fR arguments are specified, then the elements
279 between \fIfirst\fR and \fIlast\fR are simply deleted. If \fIlist\fR
280 is empty, any \fIelement\fR arguments are added to the end of the list.
284 list(n), lappend(n), lindex(n), linsert(n), llength(n), lsearch(n),
285 lset(n), lrange(n), lsort(n)
289 element, list, replace