Commands

blank

Generate a blank space. This is usually just a blank space.

bof

Beginning of file command. This is called when a new file is created. There is one argument: the name of the directory.

bop

Beginning of page command. This is called when starting a new manual page.

definition

There is one argument, the one-line description of the routine. Used only by doc2lt.

em

Begin emphasis (or italic) style text. See the command syntax for the discussion of how font modes like this are exited.

em_dash

Generate an em dash (---).

end_par

Generate an end-of-paragraph.

eof

End of file command. This is called just before doctext closes a file.

eop

End of page command. This is called at the end of a man page.

key

There is one argument, the name of the routine that a man page is being generated for. Used only by doc2lt

linebreak

Generate a forced line break.

location

Show the location of the file the generated this man page. The argument is the filename.

mantitle

Generate the man page title. This takes four string arguments. They are, in order

name

Name of the routine

level

Man page section (e.g., 3)

date

Date of last change to file

heading

man section name (from the -heading argument to doctext).

picture

This command takes the name of a file as argument and will be used in future versions of doctext to allow the inclusion of graphics in man pages.

postamble

Used only by doc2lt

preamble

Used only by doc2lt

rm

Change font style to roman.

section

Generate a man page section header. There are two arguments. The string argument is the name of the section; the integer argument is the level of the section. The default section level is two.

synopsis

Generate the Synopsis section of the man page. The argument is the synopsis text. Used only by doc2lt.

tt

Change font style to fixed width.

s_arg

Begin an argument (. format command).

s_defn

Begin the definition of an argument.

s_arg_list

Begin a list of argument (the + format command). This doesn't include the argument itself; that is begun with the s_arg_inlist command.

s_arg_inlist

Begin an argument within an argument list (started with s_arg_list).

s_defn_inlist

Begin the definition of an argument in an argument list.

s_caption

Begin the text for a caption. This is intended for use with the picture command, and is not supported.

s_doctext_verbatim

Begin the single-line verbatim mode (the $ command).

s_synopsis

Begin the synopsis section.

s_verbatim

Begin a multiline verbatim section (.vb).