MANDOC(1) General Commands Manual MANDOC(1) (NAME) mandoc - (SYNOPSIS) mandoc [-ac] [-I os=name] [-K encoding] [-mdoc | -man] [-O options] [-T output] [-W level] [file ...] (DESCRIPTION) mandoc . mandoc mdoc(7) man(7) (stdin) -T locale . : -a -c man(1) less(1) . -c less(1) . . -a . -I os=name (name) Os mdoc(7) TH man(7) . -K encoding . encoding us-ascii iso-8859-1 utf-8. : 1. (BOM 0xefbbbf) UTF-8 utf-8 . 2. emacs : .\" -*- [...;] coding: encoding; -*- encoding . 3. ASCII UTF-8 utf-8 . 4. iso-8859-1 . -mdoc | -man -mdoc - mdoc(7) . -man - man(7) . : Dd Dt mdoc(7) man(7) . -m . -O options . options . -T output . output ascii html locale man markdown pdf ps tree utf8. -T lint . -W all . -W level (level) . level base style warning error unsupp . base Os -Ios - uname(3) . openbsd netbsd base . all base . mandoc . (EXIT STATUS) (DIAGNOSTICS) . -W stop mandoc . . level stop -W error,stop. file . . mandoc . -fhklw man(1) . -f -k - mandoc -CMmOSs apropos(1) . -fkl . ASCII -T ascii - ASCII ascii(7) locale(1) . (back-spaced) `c' `_\[bs]c' `\[bs]' . `c\[bs]c' . ul(1) . col(1) -b . mandoc_char(7) ASCII . (`single quotes') 0x60 0x27 ASCII () roff(7) ASCII . ASCII ASCII U+0060 . -O : indent=indent mdoc(7) man(7) indent . . . mdoc man(7) mdoc(7) . -O indent=5 . -T man mdoc(7) . tag[=term] term . term section . key=val apropos(1) val . `man -akO tag Ic=ulimit' . width=width width . . (literal) . HTML -T html HTML5 . CSS1 . eqn(7) MathML . /usr/share/misc/mandoc.css . -O style -T html ( ) . ASCII . -O : fragment . style . . includes=fmt fmt ../src/%I.html ( In) . `%I' include . . man=fmt[;fmt] fmt ../html%S/%N.%S.html ( Xr) . `%N' `%S' . . . %N.%S . style=style.css style.css . URI . tag[=term] ASCII. URI file:// . URI : MANPAGER='lynx -force_html' man -T html -O tag=MANPAGER man MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc HTML more(1) less(1) . `MANPAGER=less man -T html -O tag=toc mandoc' less(1) URI file:// . toc . Locale mandoc UTF-8 ASCII locale(1) . LC_ALL LC_CTYPE LANG UTF-8 UTF-8 ASCII . -T locale . Man -T man mdoc(7) man(7) . mdoc(7) . eqn(7) tbl(7) . man(7) . -W (DIAGNOSTICS) . Markdown -T markdown mdoc(7) markdown : http://daringfireball.net/projects/markdown/syntax.text . CommonMark: http://commonmark.org . markdown ASCII . ASCII HTML . (literal) markdown ASCII ASCII . . HTML -T html . man(7) tbl(7) eqn(7) -T markdown . PDF PDF-1.1 -T pdf . -O PostScript . PostScript PostScript "Adobe-3.0" -T ps . letter Times . / . 1.4m . ASCII . -O : paper=name (name) a3 a4 a5 legal letter . NNxNN . letter . UTF-8 -T utf8 UTF-8 locale(1) . -O ASCII . locale UCS-4 mandoc ASCII . (Syntax tree) -T tree . . . mdoc(7) TH man(7) . (tree dump) . . : 1. tbl(7) . eqn(7) . 2. (text elem block head body body- end tail tbl eqn). 3. : - . - . - ( ). - . - ( ). - . - . - BROKEN . - NOSRC . - NOPRT . -O : noval . . . (ENVIRONMENT) LC_CTYPE locale(1). Locale ASCII UTF-8. . MANPAGER MANPAGER less(1) man(1) . -a -l . PAGER MANPAGER . PAGER MANPAGER less(1) . -a -l . (EXIT STATUS) mandoc (level) -W : 0 level . 1 -W base -W style . 2 -W warning level . 3 -W error level . 4 -W unsupp level . 5 . . 6 . mandoc . -T lint -W all . (EXAMPLES) : $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8 HTML /usr/share/misc/mandoc.css : $ mandoc -T html -O style=/usr/share/misc/mandoc.css mdoc.7 > mdoc.7.html : $ mandoc -T lint `find /usr/src -name \*\.[1-9]` PostScript A4: $ mandoc -T ps -O paper=a4 mdoc.7 man.7 > manuals.ps mdoc(7) man(7) mdoc(7) : $ mandoc -T man foo.mdoc > foo.man (DIAGNOSTICS) mandoc : mandoc: file:line:column: level: message: macro arguments (os) file line column . . . level message . macro arguments . (os) . file level . : syserr . . . badarg . . unsupp roff(7) . / GNU troff mandoc . error . warning . . style . . style . style . base . . base style . base style warning error unsupp -W -T lint . base style -W - Os -Ios uname(3) . Mdocdate found (mdoc, NetBSD) Dd CVS Mdocdate NetBSD . "Month dd, yyyy" . Mdocdate missing (mdoc, OpenBSD) Dd CVS Mdocdate OpenBSD . unknown architecture (mdoc, OpenBSD, NetBSD) Dt . operating system explicitly specified (mdoc, OpenBSD, NetBSD) Os . . RCS id missing (OpenBSD, NetBSD) RCS CVS OpenBSD NetBSD . (Style suggestions) legacy man(7) date format (mdoc) Dd man(7) "yyyy-dd-mm" . mdoc(7) "Month dd, yyyy" . normalizing date format to: ... (mdoc, man) Dd TH . . lower case character in document title (mdoc, man) Dt TH . duplicate RCS id RCS . . possible typo in section name (mdoc) Sh . unterminated quoted argument (roff) . . . useless macro (mdoc) Bt Tn Ud . . consider using OS macro (mdoc) Bx Ox Nx Fx Dx . errnos out of order (mdoc, NetBSD) Er Bl . duplicate errno (mdoc, NetBSD) Bl It Er . referenced manual not found (mdoc) Xr . -W base /usr/share/man:/usr/X11R6/man. MANPATH_BASE . -W style man(1) -m -M - MANPATH man.conf(5) /usr/share/man:/usr/X11R6/man:/usr/local/man MANPATH_DEFAULT . trailing delimiter (mdoc) Ex Fo Nd Nm Os Sh Ss St Sx . . . no blank before trailing delimiter (mdoc) . . fill mode already enabled, skipping (man) fi . . fill mode already disabled, skipping (man) nf . . input text line longer than 80 bytes . verbatim "--", maybe consider using \(em (mdoc) ASCII (em-dash) "--" . function name without markup (mdoc) . Fn Xr . whitespace at end of input line (mdoc, man, roff) -- . bad comment style (roff) . mandoc . (Prologue) missing manual title, using UNTITLED (mdoc) Dt Dt . missing manual title, using "" (man) TH . missing manual section, using "" (mdoc, man) Dt TH . unknown manual section (mdoc) Dt . filename/section mismatch (mdoc, man) Dt TH section . section . . missing date, using "" (mdoc, man) mdoc(7) Dd Dd man(7) TH TH . cannot parse date, using it verbatim (mdoc, man) Dd TH . date in the future, using it anyway (mdoc, man) Dd TH time(3) . missing Os macro, using "" (mdoc) . late prologue macro (mdoc) Dd Os . prologue macros out of order (mdoc) Dd Dt Os . . .so is fragile, better use ln(1) (roff) . no document body (mdoc, man) . . content before first section header (mdoc, man) Sh SH . . first section is not NAME (mdoc) Sh `NAME' . makewhatis(8) apropos(1) . NAME section without Nm before Nd (mdoc) NAME Nm Nd . NAME section without description (mdoc) NAME Nd . description not at the end of NAME (mdoc) NAME Nd . bad NAME section content (mdoc) NAME Nm Nd . missing comma before name (mdoc) NAME Nm . missing description line, using "" (mdoc) Nd . . description line outside NAME section (mdoc) Nd NAME . apropos(1) . sections out of conventional order (mdoc) . . duplicate section title (mdoc) . unexpected section (mdoc) . cross reference to self (mdoc) Xr Nm NAME SYNOPSIS Fn Fo SYNOPSIS . Nm Fn Xr . unusual Xr order (mdoc) SEE ALSO Xr Xr . unusual Xr punctuation (mdoc) SEE ALSO Xr Xr . AUTHORS section without An macro (mdoc) AUTHORS An . . obsolete macro (mdoc) mdoc(7) . macro neither callable nor escaped (mdoc) . . `\&' . skipping paragraph macro mdoc(7) : - - - - . man(7) : - P PP LP - IP - br sp SH SS moving paragraph macro out of list (mdoc) Bl . . skipping no-space macro (mdoc) Ns Ns . . blocks badly nested (mdoc) . SGML . "Ao Bo Ac Bc" "Ao Bq Ac". Ac Bo Bq . nested displays are not portable (mdoc) Bd D1 Dl Bd . mandoc . moving content out of list (mdoc) Bl It . . first macro on line Bl -column - Ta . line scope broken (man) . . skipping empty request (roff, eqn) eqn(7) . conditional request controls empty scope (roff) : - `\{' . - . - . . `\' . . el . skipping empty macro (mdoc) . empty block (mdoc, man) Bd Bk Bl D1 Dl MT RS UR . empty argument, using 0n (mdoc) -offset -width Bd Bl . missing display type, using -ragged (mdoc) Bd . list type is not the first argument (mdoc) Bl . mandoc mdoc(7) . missing -width in -tag list, using 8n (mdoc) Bl -tag -width . missing utility name, using "" (mdoc) Ex -std Nm . missing function name, using "" (mdoc) Fo . . empty head in list item (mdoc) -diag - -hang - -inset - -ohang -tag Bl It . . empty list item (mdoc) -bullet - -dash - -enum -hyphen Bl It . . missing argument, using next line (mdoc) It Bd -column . mandoc ( ) . missing font type, using \fR (mdoc) Bf . . unknown font type, using \fR (mdoc) Bf . . nothing follows prefix (mdoc) Pf . . empty reference block (mdoc) Rs Re . . missing section argument (mdoc) Xr . . missing -std argument, adding it (mdoc) Ex Rv -std . mandoc -std . missing option string, using "" (man) OP . . missing resource identifier, using "" (man) MT UR . / . missing eqn box, using "" (eqn) . . duplicate argument (mdoc) Bd Bl -compact - -offset -width . . skipping duplicate argument (mdoc) An -split -nosplit . . skipping duplicate display type (mdoc) Bd . skipping duplicate list type (mdoc) Bl . skipping -width argument (mdoc) -column - -diag - -ohang - -inset -item Bl -width . . wrong number of cells Bl -column - Ta . . unknown AT&T UNIX version (mdoc) At . "AT&T UNIX " . comma in function argument (mdoc) Fa Fn . parenthesis in function name (mdoc) Fc Fn . unknown library name (mdoc, not on OpenBSD) Lb "library "name"" . invalid content in Rs block (mdoc) Rs % . . . invalid Boolean argument (mdoc) Sm on off . . argument contains two font escapes (roff) char . . unknown font, skipping request (man, tbl) ft roff(7) f tbl(7) font . odd number of characters in request (roff) tr . . blank line in fill mode, using .sp (mdoc) : . groff sp . Pp . tab in filled text (mdoc, man) : . . . new sentence, new line (mdoc) . . invalid escape sequence (roff) . \* \n \B `0' \w . . undefined escape, printing literally (roff) . . undefined string, using "" (roff) . . tbl line starts with span (tbl) (`s'). . tbl column starts with span (tbl) (`^'). . skipping vertical bar in tbl layout (tbl) . . non-alphabetic character in tbl options (tbl) . . skipping unknown tbl option (tbl) . . missing tbl option argument (tbl) . . wrong tbl option argument size (tbl) . . empty tbl layout (tbl) . . invalid character in tbl layout (tbl) . . unmatched parenthesis in tbl layout (tbl) . . ignoring excessive spacing in tbl layout (tbl) . 3n . tbl without any data cells (tbl) . . ignoring data in spanned tbl cell (tbl) (`s') (`^') . . ignoring extra tbl data cells (tbl) . . data block open at end of tbl (tbl) T{ T} . . roff mdoc man duplicate prologue macro (mdoc) . . skipping late title macro (mdoc) Dt . . mandoc . . input stack limit exceeded, infinite loop? (roff) : - - - so. . skipping bad character (mdoc, man, roff) ascii(7) . . (`?') . ASCII . skipping unknown macro (mdoc, man, roff) roff(7) mdoc(7) man(7) . . . skipping request outside macro (roff) shift return . skipping insecure request (roff) . . skipping item outside list (mdoc, eqn) It Bl above eqn(7) . . skipping column outside column list (mdoc) Ta Bl -column . . skipping end of block that is not open (mdoc, man, eqn, tbl, roff) . mdoc(7) ME RE UE man(7) eqn(7) roff(7) . . fewer RS blocks open, skipping (man) RE RS . RE . inserting missing end of block (mdoc, tbl) mdoc(7) . . . appending missing end of block (mdoc, man, eqn, tbl, roff) mdoc(7) man(7) MT RS UR roff(7) . . escaped character not allowed in a name (roff) ASCII . . am as de ds nr rr rm . as ds nr . am de rr rm . . . using macro argument outside macro (roff) \$ . argument number is not numeric (roff) \$ . NOT IMPLEMENTED: Bd -file (mdoc) Bd -file . . . skipping display without arguments (mdoc) Bd . . missing list type, using -item (mdoc) Bl . argument is not numeric, using 1 (roff) ce . argument is not a character (roff) char ASCII . . missing manual name, using "" (mdoc) Nm NAME . uname(3) system call failed, using UNKNOWN (mdoc) Os uname(3) . mandoc -DOSNAME="\"string\"" . unknown standard specifier (mdoc) St . skipping request without numeric argument (roff, eqn) it size gsize eqn(7) . . excessive shift (roff) shift . \n(.$ . NOT IMPLEMENTED: .so with absolute path or ".." (roff) mandoc so . . mandoc so . .so request failed (roff) so . mandoc so . skipping all arguments (mdoc, man, eqn, roff) Bt Ed Ef Ek El Lp Pp Re Rs Ud mdoc(7) It LP P PP man(7) EQ EN eqn(7) br fi nf roff(7) `..' . . skipping excess arguments (mdoc, man, roff) : - Fo MT PD RS UR ft sp - An -split -nosplit - RE - OP de - Dt - TH - Bd Bk Bl . input too large (mdoc, man) mandoc 2^31 ( ) . . . unsupported control character (roff) ASCII roff(7) mandoc . . unsupported escape sequence (roff) GNU troff Heirloom troff mandoc . unsupported roff request (roff) roff(7) GNU troff Heirloom troff mandoc . eqn delim option in tbl (eqn, tbl) . . unsupported table layout modifier (tbl) `m' . . ignoring macro in table (tbl, mdoc, man) mdoc(7) man(7) . . skipping tbl in -Tman mode (mdoc, tbl) TS . -T man tbl(7) . skipping eqn in -Tman mode (mdoc, eqn) EQ . -T man eqn(7) . bad command line argument -IKMmOTW file . duplicate command line argument -I . option has a superfluous value -O . missing option value -O . bad option value indent width -O . duplicate option value -O . no such tag -O tag . -Tmarkdown unsupported for man(7) input (man) -T markdown man(7) . . (SEE ALSO) apropos(1), man(1), eqn(7), man(7), mandoc_char(7), mdoc(7), roff(7), tbl(7) (HISTORY) mandoc OpenBSD 4.8 . -I OpenBSD 5.2 -aCcfhKklMSsw OpenBSD 5.7 . (AUTHORS) mandoc Kristaps Dzonsons Ingo Schwarze . Linux 6.12.107+deb13-amd64 August 14, 2021 Linux 6.12.107+deb13-amd64