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: list.n,v 1.7 2001/12/05 22:26:43 dgp 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 list n "" Tcl "Tcl Built-In Commands"
249 '\" Note: do not modify the .SH NAME line immediately below!
251 list \- Create a list
253 \fBlist \fR?\fIarg arg ...\fR?
258 This command returns a list comprised of all the \fIarg\fRs,
259 or an empty string if no \fIarg\fRs are specified.
260 Braces and backslashes get added as necessary, so that the \fBlindex\fR command
261 may be used on the result to re-extract the original arguments, and also
262 so that \fBeval\fR may be used to execute the resulting list, with
263 \fIarg1\fR comprising the command's name and the other \fIarg\fRs comprising
264 its arguments. \fBList\fR produces slightly different results than
265 \fBconcat\fR: \fBconcat\fR removes one level of grouping before forming
266 the list, while \fBlist\fR works directly from the original arguments.
267 For example, the command
269 \fBlist a b {c d e} {f {g h}}\fR
273 \fBa b {c d e} {f {g h}}\fR
275 while \fBconcat\fR with the same arguments will return
277 \fBa b c d e f {g h}\fR
281 lappend(n), lindex(n), linsert(n), llength(n), lsearch(n),
286 lrange(n), lreplace(n)