manual entries.
.AP type name in/out ?indent?
Start paragraph describing an argument to a library procedure.
type is type of argument (int, etc.), in/out is either "in", "out",
or "in/out" to describe whether procedure reads or modifies arg,
and indent is equivalent to second arg of .IP (shouldn't ever be
needed; use .AS below instead)
.AS ?type? ?name?
Give maximum sizes of arguments for setting tab stops. Type and
name are examples of largest possible arguments that will be passed
to .AP later. If args are omitted, default tab stops are used.
.BS
Start box enclosure. From here until next .BE, everything will be
enclosed in one large box.
.BE
End of box enclosure.
.CS
Begin code excerpt.
.CE
End code excerpt.
.VS ?version? ?br?
Begin vertical sidebar, for use in marking newly-changed parts
of man pages. The first argument is ignored and used for recording
the version when the .VS was added, so that the sidebars can be
found and removed when they reach a certain age. If another argument
is present, then a line break is forced before starting the sidebar.
.VE
End of vertical sidebar.
.DS
Begin an indented unfilled display.
.DE
End of indented unfilled display.
.SO
Start of list of standard options for a Tk widget. The
options follow on successive lines, in four columns separated
by tabs.
.SE
End of list of standard options for a Tk widget.
.OP cmdName dbName dbClass
Start of description of a specific option. cmdName gives the
option's name as specified in the class command, dbName gives
the option's name in the option database, and dbClass gives
the option's class in the option database.
.UL arg1 arg2
Print arg1 underlined, then print arg2 normally.
RCS: @(#) $Id: man.macros,v 1.1 2004/02/18 20:26:21 tkgeomap Exp $
# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.nr ^l \n(.l # Start an argument description
. ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} \\$1 \\\$2\ (\\$3) .b
.\}
\\$1 \\\$2\
.\}
\\\$1\
.\}
.\}
..
# define tabbing values for .AP
.nr )A 10n
.nr )B \\n()Au+15n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
# BS - start boxed text
# ^y = starting y location
# ^b = 1
^y
.nr ^b 1u
..
# BE - end boxed text (draw box now)
^t Draw four-sided box normally, but don't draw top of
box if the box started on an earlier page.
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\}
.nr ^b 0
..
# VS - start vertical sidebar
# ^Y = starting y location
# ^v = 1 (for troff; for nroff this doesn't matter)
^Y
..
# VE - end of vertical sidebar
.ev 2
.ev .\} .nr ^v 0 .. # Special macro to handle page bottom: finish off current^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
# box/sidebar if in box/sidebar mode, then invoked standard
# page bottom macro.
.ev 2 'ti 0 'nf
^t
Draw three-sided box if this is the box's first page,
draw two sides but no top otherwise.
.\}
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
^y .nr ^b 2 .\}
^Y
.\}
..
# DS - begin display
.. # DE - end display
.. # SE - end of list of standard options
See the \options\ manual entry for details on the standard options.
..
# OP - start of full description for a single option
Command-Line Name: \\\$1\ Database Name: \\\$2\ Database Class: \\\$3\.. # CS - begin code excerpt
.. # CE - end code excerpt