util/src/TclTk/tcl8.6.12/doc/man.macros

   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 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  71 .if t .wh -1.3i ^B
  72 .nr ^l \n(.l
  73 .ad b
  74 .\"     # Start an argument description
  75 .de AP
  76 .ie !"\\$4"" .TP \\$4
  77 .el \{\
  78 .   ie !"\\$2"" .TP \\n()Cu
  79 .   el          .TP 15
  80 .\}
  81 .ta \\n()Au \\n()Bu
  82 .ie !"\\$3"" \{\
  83 \&\\$1 \\fI\\$2\\fP (\\$3)
  84 .\".b
  85 .\}
  86 .el \{\
  87 .br
  88 .ie !"\\$2"" \{\
  89 \&\\$1  \\fI\\$2\\fP
  90 .\}
  91 .el \{\
  92 \&\\fI\\$1\\fP
  93 .\}
  94 .\}
  95 ..
  96 .\"     # define tabbing values for .AP
  97 .de AS
  98 .nr )A 10n
  99 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 100 .nr )B \\n()Au+15n
 101 .\"
 102 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 103 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 104 ..
 105 .AS Tcl_Interp Tcl_CreateInterp in/out
 106 .\"     # BS - start boxed text
 107 .\"     # ^y = starting y location
 108 .\"     # ^b = 1
 109 .de BS
 110 .br
 111 .mk ^y
 112 .nr ^b 1u
 113 .if n .nf
 114 .if n .ti 0
 115 .if n \l'\\n(.lu\(ul'
 116 .if n .fi
 117 ..
 118 .\"     # BE - end boxed text (draw box now)
 119 .de BE
 120 .nf
 121 .ti 0
 122 .mk ^t
 123 .ie n \l'\\n(^lu\(ul'
 124 .el \{\
 125 .\"     Draw four-sided box normally, but don't draw top of
 126 .\"     box if the box started on an earlier page.
 127 .ie !\\n(^b-1 \{\
 128 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 129 .\}
 130 .el \}\
 131 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 132 .\}
 133 .\}
 134 .fi
 135 .br
 136 .nr ^b 0
 137 ..
 138 .\"     # VS - start vertical sidebar
 139 .\"     # ^Y = starting y location
 140 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 141 .de VS
 142 .if !"\\$2"" .br
 143 .mk ^Y
 144 .ie n 'mc \s12\(br\s0
 145 .el .nr ^v 1u
 146 ..
 147 .\"     # VE - end of vertical sidebar
 148 .de VE
 149 .ie n 'mc
 150 .el \{\
 151 .ev 2
 152 .nf
 153 .ti 0
 154 .mk ^t
 155 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 156 .sp -1
 157 .fi
 158 .ev
 159 .\}
 160 .nr ^v 0
 161 ..
 162 .\"     # Special macro to handle page bottom:  finish off current
 163 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 164 .\"     # page bottom macro.
 165 .de ^B
 166 .ev 2
 167 'ti 0
 168 'nf
 169 .mk ^t
 170 .if \\n(^b \{\
 171 .\"     Draw three-sided box if this is the box's first page,
 172 .\"     draw two sides but no top otherwise.
 173 .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
 174 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 175 .\}
 176 .if \\n(^v \{\
 177 .nr ^x \\n(^tu+1v-\\n(^Yu
 178 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 179 .\}
 180 .bp
 181 'fi
 182 .ev
 183 .if \\n(^b \{\
 184 .mk ^y
 185 .nr ^b 2
 186 .\}
 187 .if \\n(^v \{\
 188 .mk ^Y
 189 .\}
 190 ..
 191 .\"     # DS - begin display
 192 .de DS
 193 .RS
 194 .nf
 195 .sp
 196 ..
 197 .\"     # DE - end display
 198 .de DE
 199 .fi
 200 .RE
 201 .sp
 202 ..
 203 .\"     # SO - start of list of standard options
 204 .de SO
 205 'ie '\\$1'' .ds So \\fBoptions\\fR
 206 'el .ds So \\fB\\$1\\fR
 207 .SH "STANDARD OPTIONS"
 208 .LP
 209 .nf
 210 .ta 5.5c 11c
 211 .ft B
 212 ..
 213 .\"     # SE - end of list of standard options
 214 .de SE
 215 .fi
 216 .ft R
 217 .LP
 218 See the \\*(So manual entry for details on the standard options.
 219 ..
 220 .\"     # OP - start of full description for a single option
 221 .de OP
 222 .LP
 223 .nf
 224 .ta 4c
 225 Command-Line Name:      \\fB\\$1\\fR
 226 Database Name:  \\fB\\$2\\fR
 227 Database Class: \\fB\\$3\\fR
 228 .fi
 229 .IP
 230 ..
 231 .\"     # CS - begin code excerpt
 232 .de CS
 233 .RS
 234 .nf
 235 .ta .25i .5i .75i 1i
 236 ..
 237 .\"     # CE - end code excerpt
 238 .de CE
 239 .fi
 240 .RE
 241 ..
 242 .\"     # UL - underline word
 243 .de UL
 244 \\$1\l'|0\(ul'\\$2
 245 ..
 246 .\"     # QW - apply quotation marks to word
 247 .de QW
 248 .ie '\\*(lq'"' ``\\$1''\\$2
 249 .\"" fix emacs highlighting
 250 .el \\*(lq\\$1\\*(rq\\$2
 251 ..
 252 .\"     # PQ - apply parens and quotation marks to word
 253 .de PQ
 254 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 255 .\"" fix emacs highlighting
 256 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 257 ..
 258 .\"     # QR - quoted range
 259 .de QR
 260 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 261 .\"" fix emacs highlighting
 262 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 263 ..
 264 .\"     # MT - "empty" string
 265 .de MT
 266 .QW ""
 267 ..