doc/man.macros

   1 '\" The definitions below are for supplemental macros used in Tcl/Tk
   2 '\" 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
  46 '\"     Start of list of standard options for a Tk widget.  The
  47 '\"     options follow on successive lines, in four columns separated
  48 '\"     by tabs.
  49 '\"
  50 '\" .SE
  51 '\"     End of list of standard options for a Tk widget.
  52 '\"
  53 '\" .OP cmdName dbName dbClass
  54 '\"     Start of description of a specific option.  cmdName gives the
  55 '\"     option's name as specified in the class command, dbName gives
  56 '\"     the option's name in the option database, and dbClass gives
  57 '\"     the option's class in the option database.
  58 '\"
  59 '\" .UL arg1 arg2
  60 '\"     Print arg1 underlined, then print arg2 normally.
  61 '\"
  62 '\" RCS: @(#) $Id$
  63 '\"
  64 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  65 .if t .wh -1.3i ^B
  66 .nr ^l \n(.l
  67 .ad b
  68 '\"     # Start an argument description
  69 .de AP
  70 .ie !"\\$4"" .TP \\$4
  71 .el \{\
  72 .   ie !"\\$2"" .TP \\n()Cu
  73 .   el          .TP 15
  74 .\}
  75 .ta \\n()Au \\n()Bu
  76 .ie !"\\$3"" \{\
  77 \&\\$1  \\fI\\$2\\fP    (\\$3)
  78 .\".b
  79 .\}
  80 .el \{\
  81 .br
  82 .ie !"\\$2"" \{\
  83 \&\\$1  \\fI\\$2\\fP
  84 .\}
  85 .el \{\
  86 \&\\fI\\$1\\fP
  87 .\}
  88 .\}
  89 ..
  90 '\"     # define tabbing values for .AP
  91 .de AS
  92 .nr )A 10n
  93 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  94 .nr )B \\n()Au+15n
  95 .\"
  96 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  97 .nr )C \\n()Bu+\\w'(in/out)'u+2n
  98 ..
  99 .AS Tcl_Interp Tcl_CreateInterp in/out
 100 '\"     # BS - start boxed text
 101 '\"     # ^y = starting y location
 102 '\"     # ^b = 1
 103 .de BS
 104 .br
 105 .mk ^y
 106 .nr ^b 1u
 107 .if n .nf
 108 .if n .ti 0
 109 .if n \l'\\n(.lu\(ul'
 110 .if n .fi
 111 ..
 112 '\"     # BE - end boxed text (draw box now)
 113 .de BE
 114 .nf
 115 .ti 0
 116 .mk ^t
 117 .ie n \l'\\n(^lu\(ul'
 118 .el \{\
 119 .\"     Draw four-sided box normally, but don't draw top of
 120 .\"     box if the box started on an earlier page.
 121 .ie !\\n(^b-1 \{\
 122 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 123 .\}
 124 .el \}\
 125 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 126 .\}
 127 .\}
 128 .fi
 129 .br
 130 .nr ^b 0
 131 ..
 132 '\"     # VS - start vertical sidebar
 133 '\"     # ^Y = starting y location
 134 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 135 .de VS
 136 .if !"\\$2"" .br
 137 .mk ^Y
 138 .ie n 'mc \s12\(br\s0
 139 .el .nr ^v 1u
 140 ..
 141 '\"     # VE - end of vertical sidebar
 142 .de VE
 143 .ie n 'mc
 144 .el \{\
 145 .ev 2
 146 .nf
 147 .ti 0
 148 .mk ^t
 149 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 150 .sp -1
 151 .fi
 152 .ev
 153 .\}
 154 .nr ^v 0
 155 ..
 156 '\"     # Special macro to handle page bottom:  finish off current
 157 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 158 '\"     # page bottom macro.
 159 .de ^B
 160 .ev 2
 161 'ti 0
 162 'nf
 163 .mk ^t
 164 .if \\n(^b \{\
 165 .\"     Draw three-sided box if this is the box's first page,
 166 .\"     draw two sides but no top otherwise.
 167 .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
 168 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 169 .\}
 170 .if \\n(^v \{\
 171 .nr ^x \\n(^tu+1v-\\n(^Yu
 172 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 173 .\}
 174 .bp
 175 'fi
 176 .ev
 177 .if \\n(^b \{\
 178 .mk ^y
 179 .nr ^b 2
 180 .\}
 181 .if \\n(^v \{\
 182 .mk ^Y
 183 .\}
 184 ..
 185 '\"     # DS - begin display
 186 .de DS
 187 .RS
 188 .nf
 189 .sp
 190 ..
 191 '\"     # DE - end display
 192 .de DE
 193 .fi
 194 .RE
 195 .sp
 196 ..
 197 '\"     # SO - start of list of standard options
 198 .de SO
 199 .SH "STANDARD OPTIONS"
 200 .LP
 201 .nf
 202 .ta 4c 8c 12c
 203 .ft B
 204 ..
 205 '\"     # SE - end of list of standard options
 206 .de SE
 207 .fi
 208 .ft R
 209 .LP
 210 See the \\fBoptions\\fR manual entry for details on the standard options.
 211 ..
 212 '\"     # OP - start of full description for a single option
 213 .de OP
 214 .LP
 215 .nf
 216 .ta 4c
 217 Command-Line Name:      \\fB\\$1\\fR
 218 Database Name:  \\fB\\$2\\fR
 219 Database Class: \\fB\\$3\\fR
 220 .fi
 221 .IP
 222 ..
 223 '\"     # CS - begin code excerpt
 224 .de CS
 225 .RS
 226 .nf
 227 .ta .25i .5i .75i 1i
 228 ..
 229 '\"     # CE - end code excerpt
 230 .de CE
 231 .fi
 232 .RE
 233 ..
 234 .de UL
 235 \\$1\l'|0\(ul'\\$2
 236 ..