DESCRIPTION

Document about roff macros that are currently supported by mandoc and compatible with both mdoc/man output with examples.

MACROS

(back to top)

als: create alias for request,string, macro, diversion

als newname oldname

am: append to a macro definition

am macroname

as: append to string

as stringname

br: break line

break: break loop

de: define a macro

ds: define user string

ds stringname string

el: else

el body

fi: switch to fill mode

ft: font selection

ft font

ie: if/else if if

if: conditional statement

ig: ignore input

nf: switch to no-fill mode

nr: define a numeric register

nr s 0

po: horizontal page offset

po +/-offset

rj: justify the next N lines to the right

rj N

rm: remove a request, macro or string

rm item

rr: remove a register

rr register

shift: shift macro arguments

shift N

so: source file

so oh_header.7

sp: break output line and emit vertical space

sp height

ta: set tab stop, use without arguments to remove it

ta width

ti: indent the next output line by width

ti +/-width

tr: translate glyph

tr input output

while: while loop

EXAMPLES

(back to top)

.ds string text
.string

This is the \*[string] , shows text.

.as string newtext
.string

.als newstring string
.newstring

.de m
.Em macrodef
..
.m

.de m
.Em macrodef \\$1
..
.m test

.am m
.Em macroappend
..

.ft BI
.text in bold italic
.ft P

.nr r 1

.rr r

.if ( \nr == 1 ) \{\
.Em is 1
.\}
..

.ie ( \nr == 1 ) \{\
.Em nr is 1
.\}
.el .Em nr is 0

.ig
text
..

.rm string

TODO

(back to top)

• pending examples for: while, shift, tr, ti, ta, sp, rj, po, nf, fi, break, br, so
• review and update
• split examples into roff_examples.

SEE ALSO

(back to top)

documentation , openbsd , mdoc , mandoc

- OpenBSD manpages: roff(7)

AUTHORS

(back to top)

ohazot | about | ohazot.com <admin@ohazot.com>