[25] | 1 | .\" The -*- nroff -*- definitions below are for supplemental macros used |
---|
| 2 | .\" in Tcl/Tk manual entries. |
---|
| 3 | .\" |
---|
| 4 | .\" .AP type name in/out ?indent? |
---|
| 5 | .\" Start paragraph describing an argument to a library procedure. |
---|
| 6 | .\" type is type of argument (int, etc.), in/out is either "in", "out", |
---|
| 7 | .\" or "in/out" to describe whether procedure reads or modifies arg, |
---|
| 8 | .\" and indent is equivalent to second arg of .IP (shouldn't ever be |
---|
| 9 | .\" needed; use .AS below instead) |
---|
| 10 | .\" |
---|
| 11 | .\" .AS ?type? ?name? |
---|
| 12 | .\" Give maximum sizes of arguments for setting tab stops. Type and |
---|
| 13 | .\" name are examples of largest possible arguments that will be passed |
---|
| 14 | .\" to .AP later. If args are omitted, default tab stops are used. |
---|
| 15 | .\" |
---|
| 16 | .\" .BS |
---|
| 17 | .\" Start box enclosure. From here until next .BE, everything will be |
---|
| 18 | .\" enclosed in one large box. |
---|
| 19 | .\" |
---|
| 20 | .\" .BE |
---|
| 21 | .\" End of box enclosure. |
---|
| 22 | .\" |
---|
| 23 | .\" .CS |
---|
| 24 | .\" Begin code excerpt. |
---|
| 25 | .\" |
---|
| 26 | .\" .CE |
---|
| 27 | .\" End code excerpt. |
---|
| 28 | .\" |
---|
| 29 | .\" .VS ?version? ?br? |
---|
| 30 | .\" Begin vertical sidebar, for use in marking newly-changed parts |
---|
| 31 | .\" of man pages. The first argument is ignored and used for recording |
---|
| 32 | .\" the version when the .VS was added, so that the sidebars can be |
---|
| 33 | .\" found and removed when they reach a certain age. If another argument |
---|
| 34 | .\" is present, then a line break is forced before starting the sidebar. |
---|
| 35 | .\" |
---|
| 36 | .\" .VE |
---|
| 37 | .\" End of vertical sidebar. |
---|
| 38 | .\" |
---|
| 39 | .\" .DS |
---|
| 40 | .\" Begin an indented unfilled display. |
---|
| 41 | .\" |
---|
| 42 | .\" .DE |
---|
| 43 | .\" End of indented unfilled display. |
---|
| 44 | .\" |
---|
| 45 | .\" .SO ?manpage? |
---|
| 46 | .\" Start of list of standard options for a Tk widget. The manpage |
---|
| 47 | .\" argument defines where to look up the standard options; if |
---|
| 48 | .\" omitted, defaults to "options". The options follow on successive |
---|
| 49 | .\" lines, in three columns separated by tabs. |
---|
| 50 | .\" |
---|
| 51 | .\" .SE |
---|
| 52 | .\" End of list of standard options for a Tk widget. |
---|
| 53 | .\" |
---|
| 54 | .\" .OP cmdName dbName dbClass |
---|
| 55 | .\" Start of description of a specific option. cmdName gives the |
---|
| 56 | .\" option's name as specified in the class command, dbName gives |
---|
| 57 | .\" the option's name in the option database, and dbClass gives |
---|
| 58 | .\" the option's class in the option database. |
---|
| 59 | .\" |
---|
| 60 | .\" .UL arg1 arg2 |
---|
| 61 | .\" Print arg1 underlined, then print arg2 normally. |
---|
| 62 | .\" |
---|
| 63 | .\" .QW arg1 ?arg2? |
---|
| 64 | .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). |
---|
| 65 | .\" |
---|
| 66 | .\" .PQ arg1 ?arg2? |
---|
| 67 | .\" Print an open parenthesis, arg1 in quotes, then arg2 normally |
---|
| 68 | .\" (for trailing punctuation) and then a closing parenthesis. |
---|
| 69 | .\" |
---|
| 70 | .\" RCS: @(#) $Id: man.macros,v 1.9 2008/01/29 15:32:33 dkf Exp $ |
---|
| 71 | .\" |
---|
| 72 | .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
---|
| 73 | .if t .wh -1.3i ^B |
---|
| 74 | .nr ^l \n(.l |
---|
| 75 | .ad b |
---|
| 76 | .\" # Start an argument description |
---|
| 77 | .de AP |
---|
| 78 | .ie !"\\$4"" .TP \\$4 |
---|
| 79 | .el \{\ |
---|
| 80 | . ie !"\\$2"" .TP \\n()Cu |
---|
| 81 | . el .TP 15 |
---|
| 82 | .\} |
---|
| 83 | .ta \\n()Au \\n()Bu |
---|
| 84 | .ie !"\\$3"" \{\ |
---|
| 85 | \&\\$1 \\fI\\$2\\fP (\\$3) |
---|
| 86 | .\".b |
---|
| 87 | .\} |
---|
| 88 | .el \{\ |
---|
| 89 | .br |
---|
| 90 | .ie !"\\$2"" \{\ |
---|
| 91 | \&\\$1 \\fI\\$2\\fP |
---|
| 92 | .\} |
---|
| 93 | .el \{\ |
---|
| 94 | \&\\fI\\$1\\fP |
---|
| 95 | .\} |
---|
| 96 | .\} |
---|
| 97 | .. |
---|
| 98 | .\" # define tabbing values for .AP |
---|
| 99 | .de AS |
---|
| 100 | .nr )A 10n |
---|
| 101 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
---|
| 102 | .nr )B \\n()Au+15n |
---|
| 103 | .\" |
---|
| 104 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
---|
| 105 | .nr )C \\n()Bu+\\w'(in/out)'u+2n |
---|
| 106 | .. |
---|
| 107 | .AS Tcl_Interp Tcl_CreateInterp in/out |
---|
| 108 | .\" # BS - start boxed text |
---|
| 109 | .\" # ^y = starting y location |
---|
| 110 | .\" # ^b = 1 |
---|
| 111 | .de BS |
---|
| 112 | .br |
---|
| 113 | .mk ^y |
---|
| 114 | .nr ^b 1u |
---|
| 115 | .if n .nf |
---|
| 116 | .if n .ti 0 |
---|
| 117 | .if n \l'\\n(.lu\(ul' |
---|
| 118 | .if n .fi |
---|
| 119 | .. |
---|
| 120 | .\" # BE - end boxed text (draw box now) |
---|
| 121 | .de BE |
---|
| 122 | .nf |
---|
| 123 | .ti 0 |
---|
| 124 | .mk ^t |
---|
| 125 | .ie n \l'\\n(^lu\(ul' |
---|
| 126 | .el \{\ |
---|
| 127 | .\" Draw four-sided box normally, but don't draw top of |
---|
| 128 | .\" box if the box started on an earlier page. |
---|
| 129 | .ie !\\n(^b-1 \{\ |
---|
| 130 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
---|
| 131 | .\} |
---|
| 132 | .el \}\ |
---|
| 133 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
---|
| 134 | .\} |
---|
| 135 | .\} |
---|
| 136 | .fi |
---|
| 137 | .br |
---|
| 138 | .nr ^b 0 |
---|
| 139 | .. |
---|
| 140 | .\" # VS - start vertical sidebar |
---|
| 141 | .\" # ^Y = starting y location |
---|
| 142 | .\" # ^v = 1 (for troff; for nroff this doesn't matter) |
---|
| 143 | .de VS |
---|
| 144 | .if !"\\$2"" .br |
---|
| 145 | .mk ^Y |
---|
| 146 | .ie n 'mc \s12\(br\s0 |
---|
| 147 | .el .nr ^v 1u |
---|
| 148 | .. |
---|
| 149 | .\" # VE - end of vertical sidebar |
---|
| 150 | .de VE |
---|
| 151 | .ie n 'mc |
---|
| 152 | .el \{\ |
---|
| 153 | .ev 2 |
---|
| 154 | .nf |
---|
| 155 | .ti 0 |
---|
| 156 | .mk ^t |
---|
| 157 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
---|
| 158 | .sp -1 |
---|
| 159 | .fi |
---|
| 160 | .ev |
---|
| 161 | .\} |
---|
| 162 | .nr ^v 0 |
---|
| 163 | .. |
---|
| 164 | .\" # Special macro to handle page bottom: finish off current |
---|
| 165 | .\" # box/sidebar if in box/sidebar mode, then invoked standard |
---|
| 166 | .\" # page bottom macro. |
---|
| 167 | .de ^B |
---|
| 168 | .ev 2 |
---|
| 169 | 'ti 0 |
---|
| 170 | 'nf |
---|
| 171 | .mk ^t |
---|
| 172 | .if \\n(^b \{\ |
---|
| 173 | .\" Draw three-sided box if this is the box's first page, |
---|
| 174 | .\" draw two sides but no top otherwise. |
---|
| 175 | .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 |
---|
| 176 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
---|
| 177 | .\} |
---|
| 178 | .if \\n(^v \{\ |
---|
| 179 | .nr ^x \\n(^tu+1v-\\n(^Yu |
---|
| 180 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
---|
| 181 | .\} |
---|
| 182 | .bp |
---|
| 183 | 'fi |
---|
| 184 | .ev |
---|
| 185 | .if \\n(^b \{\ |
---|
| 186 | .mk ^y |
---|
| 187 | .nr ^b 2 |
---|
| 188 | .\} |
---|
| 189 | .if \\n(^v \{\ |
---|
| 190 | .mk ^Y |
---|
| 191 | .\} |
---|
| 192 | .. |
---|
| 193 | .\" # DS - begin display |
---|
| 194 | .de DS |
---|
| 195 | .RS |
---|
| 196 | .nf |
---|
| 197 | .sp |
---|
| 198 | .. |
---|
| 199 | .\" # DE - end display |
---|
| 200 | .de DE |
---|
| 201 | .fi |
---|
| 202 | .RE |
---|
| 203 | .sp |
---|
| 204 | .. |
---|
| 205 | .\" # SO - start of list of standard options |
---|
| 206 | .de SO |
---|
| 207 | 'ie '\\$1'' .ds So \\fBoptions\\fR |
---|
| 208 | 'el .ds So \\fB\\$1\\fR |
---|
| 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 \\*(So 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 | .\" # UL - underline word |
---|
| 245 | .de UL |
---|
| 246 | \\$1\l'|0\(ul'\\$2 |
---|
| 247 | .. |
---|
| 248 | .\" # QW - apply quotation marks to word |
---|
| 249 | .de QW |
---|
| 250 | .ie '\\*(lq'"' ``\\$1''\\$2 |
---|
| 251 | .\"" fix emacs highlighting |
---|
| 252 | .el \\*(lq\\$1\\*(rq\\$2 |
---|
| 253 | .. |
---|
| 254 | .\" # PQ - apply parens and quotation marks to word |
---|
| 255 | .de PQ |
---|
| 256 | .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 |
---|
| 257 | .\"" fix emacs highlighting |
---|
| 258 | .el (\\*(lq\\$1\\*(rq\\$2)\\$3 |
---|
| 259 | .. |
---|
| 260 | .\" # QR - quoted range |
---|
| 261 | .de QR |
---|
| 262 | .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 |
---|
| 263 | .\"" fix emacs highlighting |
---|
| 264 | .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 |
---|
| 265 | .. |
---|
| 266 | .\" # MT - "empty" string |
---|
| 267 | .de MT |
---|
| 268 | .QW "" |
---|
| 269 | .. |
---|