MANDOC(1)
๐ MANDOC(1) ๐
okay so bestie, this is mandoc from the General Commands Manual, and she is literally the main character of manual pages. let's get into it ๐
โจ NAME โจ
mandoc โ format manual pages ๐
๐ธ SYNOPSIS ๐ธ
mandoc [-ac] [-I os=name] [-K encoding] [-mdoc | -man] [-O options]
[-T output] [-W level] [file ...]
๐ฆ DESCRIPTION ๐ฆ
The mandoc utility formats manual pages for display. that's her job. that's what she does. ๐
By default, mandoc reads mdoc(7) or man(7) text from stdin and produces -T locale output. no flags, no drama, just vibes.
The options are as follows:
-aโ if the standard output is a terminal device and-cis not specified, useless(1)to paginate the output, just likeman(1)would. so she pages it for you, iconic behavior.-cโ copy the formatted manual pages to the standard output without usingless(1)to paginate them. this is the default. it can be specified to override-a. so if-awas being extra,-cis the "no bestie, just print it" flag.-I os=nameโ override the default operating system name for themdoc(7)Osand for theman(7)THmacro. fake it till you make it, OS edition ๐-K encodingโ specify the input encoding. the supported encoding arguments areus-ascii,iso-8859-1, andutf-8. if not specified, autodetection uses the first match in the following list:- if the first three bytes of the input file are the UTF-8 byte order mark (BOM,
0xefbbbf), input is interpreted asutf-8. - if the first or second line of the input file matches the emacs mode line format
- if the first three bytes of the input file are the UTF-8 byte order mark (BOM,
.\" -*- [...;] coding: encoding; -*-
then input is interpreted according to encoding.
- if the first non-ASCII byte in the file introduces a valid UTF-8 sequence, input is interpreted as
utf-8. - otherwise, input is interpreted as
iso-8859-1.
-mdoc|-manโ with-mdoc, all input files are interpreted asmdoc(7). with-man, all input files are interpreted asman(7). by default, the input language is automatically detected for each file: if the first macro isDdorDt, themdoc(7)parser is used; otherwise, theman(7)parser is used. with other arguments,-mis silently ignored (she's not mad, she's just ignoring you ๐).-O optionsโ comma-separated output options. see the descriptions of the individual output formats for supported options. details live downstairs โจ-T outputโ select the output format. supported values for the output argument areascii,html, the default oflocale,man,markdown,pdf,ps,tree, andutf8.
the special -T lint mode only parses the input and produces no output. it implies -W all and redirects parser messages, which usually appear on standard error output, to standard output. it's giving "no thoughts, just diagnostics" ๐
-W levelโ specify the minimum message level to be reported on the standard error output and to affect the exit status. the level can bebase,style,warning,error, orunsupp. thebaselevel automatically derives the operating system from the contents of theOsmacro, from the-Ioscommand line option, or from theuname(3)return value. the levelsopenbsdandnetbsdare variants ofbasethat bypass autodetection and request validation of base system conventions for a particular operating system. the levelallis an alias forbase. by default,mandocis silent. see โEXIT STATUSโ and โDIAGNOSTICSโ for details.
the special option -W stop tells mandoc to exit after parsing a file that causes warnings or errors of at least the requested level. no formatted output will be produced from that file. if both a level and stop are requested, they can be joined with a comma, for example -W error,stop.
fileโ read from the given input file. if multiple files are specified, they are processed in the given order. if unspecified,mandocreads from standard input.
The options -fhklw are also supported and are documented in man(1). in -f and -k mode, mandoc also supports the options -CMmOSs described in the apropos(1) manual. the options -fkl are mutually exclusive and override each other. pick a lane, bestie ๐ซถ
๐ ASCII Output ๐
Use -T ascii to force text output in 7-bit ASCII character encoding documented in the ascii(7) manual page, ignoring the locale(1) set in the environment. she doesn't care what your locale thinks, she's ASCII now.
Font styles are applied by using back-spaced encoding such that an underlined character โcโ is rendered as โ_[bs]cโ, where โ[bs]โ is the back-space character number 8. emboldened characters are rendered as โc[bs]cโ. this markup is typically converted to appropriate terminal sequences by the pager or ul(1). to remove the markup, pipe the output to col(1) -b instead. lowkey a glow-up move โจ
The special characters documented in mandoc_char(7) are rendered best-effort in an ASCII equivalent. in particular, opening and closing โsingle quotesโ are represented as characters number 0x60 and 0x27, respectively, which agrees with all ASCII standards from 1965 to the latest revision (2012) and which matches the traditional way in which roff(7) formatters represent single quotes in ASCII output. this correct ASCII rendering may look strange with modern Unicode-compatible fonts because contrary to ASCII, Unicode uses the code point U+0060 for the grave accent only, never for an opening quote. so if it looks weird, it's correct. she said what she said ๐
The following -O arguments are accepted:
indent=indentโ the left margin for normal text is set to indent blank characters instead of the default of five. increasing this is not recommended; it may result in degraded formatting, for example overfull lines or ugly line breaks. when output is to a pager on a terminal that is less than 66 columns wide, the default is reduced to three columns. trust her on the margin, okay? don't fight it.tag[=term]โ if the formatted manual page is opened in a pager, go to the definition of the term rather than showing the manual page from the beginning. if no term is specified, reuse the first command line argument that is not a section number. if that argument is inapropos(1)key=valformat, only the val is used rather than the argument as a whole. this is useful for commands like โman -akO tag Ic=ulimitโ to search for a keyword and jump right to its definition in the matching manual pages. chef's kiss, no notes ๐width=widthโ the output width is set to width instead of the default of 78. when output is to a pager on a terminal that is less than 79 columns wide, the default is reduced to one less than the terminal width. in any case, lines that are output in literal mode are never wrapped and may exceed the output width. literal lines said "I do what I want" ๐
๐ HTML Output ๐
Output produced by -T html conforms to HTML5 using optional self-closing tags. equations rendered from eqn(7) blocks use MathML. non-ASCII characters are rendered as hexadecimal Unicode character references. very demure, very standards-compliant โจ
The following -O arguments are accepted:
fragmentโ omit the<!DOCTYPE>declaration and the<html>,<head>, and<body>elements and only emit the subtree below the<body>element. thestyleargument will be ignored. this is useful when embedding manual content within existing documents. she's a fragment, she's lowkey humble ๐includes=fmtโ the string fmt, for example,../src/%I.html, is used as a template for linked header files (usually via theInmacro). instances of โ%Iโ are replaced with the include filename. the default is not to present a hyperlink.man=fmt[;fmt]โ the string fmt, for example,../html%S/%N.%S.html, is used as a template for linked manuals (usually via theXrmacro). instances of โ%Nโ and โ%Sโ are replaced with the linked manual's name and section, respectively. if no section is included, section 1 is assumed. the default is not to present a hyperlink. if two formats are given and a file%N.%Sexists in the current directory, the first format is used; otherwise, the second format is used. she checks the directory first, she's thorough like that.style=style.cssโ the filestyle.cssis used as an external stylesheet. this must be a valid absolute or relative URI.
using the file mandoc.css that is distributed with mandoc is recommended. it provides an appearance similar to terminal output with some additional features specific to mandoc HTML output, in particular making anchor locations that support deep linking stand out visually by putting a dotted line under them, providing tooltips showing the semantic function of elements (macro names), providing some simple aspects of responsive web design, and providing simple support for users who prefer a dark color scheme. dark mode besties rise ๐
using a custom CSS file is possible, but writing it requires proficiency in all of the languages HTML 5, CSS 4, and mdoc(7) and familiarity with the mandoc-specific classes used in mandoc.css. besides, while the file mandoc.css is always adapted to the HTML output generated by the mandoc version it is distributed with, maintaining a custom CSS file usually requires adaptations each time mandoc is upgraded to a new version. so like, you could, but bestie, why ๐ญ
if a stylesheet is not specified with -O style, -T html embeds a minimal stylesheet into the HTML output, mostly to select adequate font-style and font-weight attributes for various macros. the result is readable in any graphical or text-based web browser, but does not aim for looking similar to terminal output. instead, formatting is mostly left to browser defaults and to user settings in the browser configuration. she's not gonna fight your browser, that's a you problem ๐ซถ
tag[=term]โ same syntax and semantics as for โASCII Outputโ. this is implemented by passing afile://URI ending in a fragment identifier to the pager rather than passing merely a file name. when using this argument, use a pager supporting such URIs, for example
MANPAGER='lynx -force_html' man -T html -O tag=MANPAGER man
MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc
consequently, for HTML output, this argument does not work with more(1) or less(1). for example, โMANPAGER=less man -T html -O tag=toc mandocโ does not work because less(1) does not support file:// URIs. sorry bestie, less said no ๐
tocโ if an input file contains at least two non-standard sections, print a table of contents near the beginning of the output. yes queen, give us the table of contents ๐โจ
๐ Locale Output ๐
okay so by default, mandoc is lowkey picking UTF-8 or ASCII output based on the current locale(1). The way it works: if any of the environment variables LC_ALL, LC_CTYPE, or LANG are set, and the first one that is set selects the UTF-8 character encoding, you get โUTF-8 Outputโ; otherwise, it falls back to โASCII Outputโ. You can also force this vibe explicitly with -T locale. ๐
๐งโ๐ป Man Output ๐งโ๐ป
Use -T man to translate mdoc(7) input into man(7) output format. This is iconic for distributing manual sources to legacy systems lacking mdoc(7) formatters. Heads up bestie: embedded eqn(7) and tbl(7) code is not supported. ๐ซถ
If the input format of a file is man(7), the input is copied to the output. The parser is also run, and as usual, the -W level controls which โDIAGNOSTICSโ are displayed before copying the input to the output. iykyk.
๐ช Markdown Output ๐ช
Use -T markdown to translate mdoc(7) input into the markdown format conforming to John Gruber's 2004 specification: https://daringfireball.net/projects/markdown/syntax.text. The output also almost conforms to the CommonMark: https://commonmark.org/ specification. close enough, honestly.
The character set used for the markdown output is ASCII. Non-ASCII characters are encoded as HTML entities. Since that is not possible in literal font contexts, because these are rendered as code spans and code blocks in the markdown output, non-ASCII characters are transliterated to ASCII approximations in these contexts.
Markdown is a very weak markup language, so all semantic markup is lost, and even part of the presentational markup may be lost. Do not use this as an intermediate step in converting to HTML; instead, use -T html directly. periodt.
The man(7), tbl(7), and eqn(7) input languages are not supported by -T markdown output mode.
๐ PDF Output ๐
PDF-1.1 output may be generated by -T pdf. See โPostScript Outputโ for -O arguments and defaults.
๐จ๏ธ PostScript Output ๐จ๏ธ
PostScript "Adobe-3.0" Level-2 pages may be generated by -T ps. Output pages default to letter sized and are rendered in the Times font family, 11-point. Margins are calculated as 1/9 the page length and width. Line-height is 1.4m.
Special characters are rendered as in โASCII Outputโ.
The following -O arguments are accepted:
paper=nameโ The paper size name may be one ofa3,a4,a5,legal, orletter. You may also manually specify dimensions asNNxNN, width by height in millimetres. If an unknown value is encountered,letteris used.
๐ UTF-8 Output ๐
Use -T utf8 to force text output in UTF-8 multi-byte character encoding, ignoring the locale(1) settings in the environment. See โASCII Outputโ regarding font styles and -O arguments.
On operating systems lacking locale or wide character support, and on those where the internal character representation is not UCS-4, mandoc always falls back to โASCII Outputโ.
๐ณ Syntax tree output ๐ณ
Use -T tree to show a human readable representation of the syntax tree. It is useful for debugging the source code of manual pages. The exact format is subject to change, so don't write parsers for it.
The first paragraph shows meta data found in the mdoc(7) prologue, on the man(7) TH line, or the fallbacks used.
In the tree dump, each output line shows one syntax tree node. Child nodes are indented with respect to their parent node. The columns are:
- For macro nodes, the macro name; for text and
tbl(7)nodes, the content. There is a special format foreqn(7)nodes. - Node type (
text,elem,block,head,body,body-end,tail,tbl,eqn). - Flags:
- An opening parenthesis if the node is an opening delimiter.
- An asterisk if the node starts a new input line.
- The input line number (starting at one).
- A colon.
- The input column number (starting at one).
- A closing parenthesis if the node is a closing delimiter.
- A full stop if the node ends a sentence.
BROKENif the node is a block broken by another block.NOSRCif the node is not in the input file, but automatically generated from macros.NOPRTif the node is not supposed to generate output for any output format.
The following -O argument is accepted:
novalโ Skip validation and show the unvalidated syntax tree. This can help to find out whether a given behaviour is caused by the parser or by the validator. Meta data is not available in this case.
๐ฟ ENVIRONMENT ๐ฟ
LC_CTYPEโ The character encodinglocale(1). When โLocale Outputโ is selected, it decides whether to use ASCII or UTF-8 output format. It never affects the interpretation of input files.MANPAGERโ Any non-empty value of the environment variableMANPAGERis used instead of the standard pagination program,less(1); seeman(1)for details. Only used if-aor-lis specified.PAGERโ Specifies the pagination program to use whenMANPAGERis not defined. If neitherPAGERnorMANPAGERis defined,less(1)is used. Only used if-aor-lis specified.
๐ฆ EXIT STATUS ๐ฆ
The mandoc utility exits with one of the following values, controlled by the message level associated with the -W option:
0โ No base system convention violations, style suggestions, warnings, or errors occurred, or those that did were ignored because they were lower than the requested level.1โ At least one base system convention violation or style suggestion occurred, but no warning or error, and-W baseor-W stylewas specified.2โ At least one warning occurred, but no error, and-W warningor a lower level was requested.3โ At least one parsing error occurred, but no unsupported feature was encountered, and-W erroror a lower level was requested.4โ At least one unsupported feature was encountered, and-W unsuppor a lower level was requested.5โ Invalid command line arguments were specified. No input files have been read.6โ An operating system error occurred, for example exhaustion of memory, file descriptors, or process table entries. Such errors may causemandocto exit at once, possibly in the middle of parsing or formatting a file.
โ ๏ธ Note that selecting-T lintoutput mode implies-W all.
๐ EXAMPLES ๐
To page manuals to the terminal:
$ mandoc -a mandoc.1 man.1 apropos.1 makewhatis.8
To produce HTML manuals with /usr/share/misc/mandoc.css as the stylesheet:
$ mandoc -T html -O style=/usr/share/misc/mandoc.css mdoc.7 >
mdoc.7.html
To check over a large set of manuals:
$ mandoc -T lint `find /usr/src -name \*\.[1-9]`
To produce a series of PostScript manuals for A4 paper:
$ mandoc -T ps -O paper=a4 mdoc.7 man.7 > manuals.ps
Convert a modern mdoc(7) manual to the older man(7) format, for use on systems lacking an mdoc(7) parser:
$ mandoc -T man foo.mdoc > foo.man
๐ฉบ DIAGNOSTICS ๐ฉบ
Messages displayed by mandoc follow this format:
mandoc: file:line:column: level: message: macro argument ... (os)
The first three fields identify the file name, line number, and column number of the input file where the message was triggered. The line and column numbers start at 1. Both are omitted for messages referring to an input file as a whole. All level and message strings are explained below. The name of the macro triggering the message and its arguments are omitted where meaningless. The os operating system specifier is omitted for messages that are relevant for all operating systems. Fatal messages about invalid command line arguments or operating system errors, for example when memory is exhausted, may also omit the file and level fields.
Message levels have the following meanings:
syserrโ An operating system error occurred. There isn't necessarily anything wrong with the input files. Output may all the same be missing or incomplete.badargโ Invalid command line arguments were specified. No input files have been read and no output is produced.unsuppโ An input file uses unsupported low-levelroff(7)features. The output may be incomplete and/or misformatted, so using GNU troff instead ofmandocto process the file may be preferable.errorโ Indicates a risk of information loss or severe misformatting, in most cases caused by serious syntax errors.warningโ Indicates a risk that the information shown or its formatting may mismatch the author's intent in minor ways. Additionally, syntax errors are classified at least as warnings, even if they do not usually cause misformatting.styleโ An input file uses dubious or discouraged style. This is not a complaint about the syntax, and probably neither formatting nor portability are in danger. While great care is taken to avoid false positives on the higher message levels, the style level tries to reduce the probability that issues go unnoticed, so it may occasionally issue bogus suggestions. Use your judgement to decide whether any particular style suggestion really justifies a change to the input file.baseโ A convention used in the base system of a specific operating system is not adhered to. These are not markup mistakes, and neither the quality of formatting nor portability are in danger. Messages of the base level are printed with the more intuitive style level tag.
Messages of the base, style, warning, error, and unsupp levels are hidden unless their level, or a lower level, is requested using a -W option or -T lint output mode.
As indicated below, all base and some style checks are only performed if a specific operating system name occurs in the arguments of the -W command line option, of the Os macro, of the -Ios command line option, or, if neither are present, in the return value of the uname(3) function.
๐ Conventions for base system manuals ๐
Mdocdate found (mdoc, NetBSD) The Dd macro uses CVS Mdocdate keyword substitution, which is not supported by the NetBSD base system. Consider using the conventional โMonth dd, yyyyโ format instead.
Mdocdate missing (mdoc, OpenBSD) The Dd macro does not use CVS Mdocdate keyword substitution, but using it is conventionally expected in the OpenBSD base system.
unknown architecture (mdoc, OpenBSD, NetBSD) The third argument of the Dt macro does not match any of the architectures this operating system is running on.
- operating system explicitly specified โ (mdoc, OpenBSD, NetBSD) the
Osmacro actually has an argument, bestie. In the base system it's conventionally left blank. ๐ - RCS id missing โ (OpenBSD, NetBSD) your page is missing that comment line with the RCS identifier, the one generated by CVS
OpenBSDorNetBSDkeyword substitution like these operating systems conventionally use. ๐
โจ Style suggestions โจ
- legacy
man(7)date format โ (mdoc) bestie theDdmacro is out here using the legacyman(7)date formatyyyy-mm-dd. Consider switching to the conventionalmdoc(7)date formatMonth dd, yyyyinstead. it's giving glow-up, trust. ๐ - normalizing date format to: ... โ (mdoc, man) the
DdorTHmacro provides an abbreviated month name or a day number with a leading zero. In the formatted output, the month name is written out in full and the leading zero is omitted. slay, but noted. โจ - lower case character in document title โ (mdoc, man) the title is still used as given in the
DtorTHmacro โ no cap, it doesn't get fixed for you. - duplicate RCS id โ one single manual page contains two copies of the RCS identifier for the same operating system. Consider deleting the later instance and moving the first one up to the top of the page. two is not better than one here ๐ซถ
- possible typo in section name โ (mdoc) fuzzy string matching revealed that the argument of an
Shmacro is similar, but not identical to a standard section name. so close and yet so far ๐ญ - unterminated quoted argument โ (roff) macro arguments can be enclosed in double quote characters such that space characters and macro names contained in the quoted argument need not be escaped. The closing quote of the last argument of a macro can be omitted. However, omitting it is not recommended because it makes the code harder to read. fr fr, close your quotes ๐
- useless macro โ (mdoc) a
Bt,Tn, orUdmacro was found. Simply delete it: it serves no useful purpose. it's giving filler episode ๐๏ธ - consider using OS macro โ (mdoc) a string was found in plain text or in a
Bxmacro that could be represented usingOx,Nx,Fx, orDx. upgrade your vibes bestie โญ - errnos out of order โ (mdoc, NetBSD) the
Eritems in aBllist are not in alphabetical order. alphabetize your icons please ๐ฆ - duplicate errno โ (mdoc, NetBSD) a
Bllist contains two consecutiveItentries describing the sameErnumber. we don't need double ๐ - referenced manual not found โ (mdoc) an
Xrmacro references a manual page that was not found. When running with-W base, the search is restricted to the base system, by default to/usr/share/man:/usr/X11R6/man. This path can be configured at compile time using theMANPATH_BASEpreprocessor macro. When running with-W style, the search is done along the full search path as described in theman(1)manual page, respecting the-mand-Mcommand line options, theMANPATHenvironment variable, theman.conf(5)file and falling back to the default of/usr/share/man:/usr/X11R6/man:/usr/local/man, also configurable at compile time using theMANPATH_DEFAULTpreprocessor macro. that page is literally ghosting you ๐ป - trailing delimiter โ (mdoc) the last argument of an
Ex,Fo,Nd,Nm,Os,Sh,Ss,St, orSxmacro ends with a trailing delimiter. This is usually bad style and often indicates typos. Most likely, the delimiter can be removed. bestie the comma is NOT part of the name ๐ - no blank before trailing delimiter โ (mdoc) the last argument of a macro that supports trailing delimiter arguments is longer than one byte and ends with a trailing delimiter. Consider inserting a blank such that the delimiter becomes a separate argument, thus moving it out of the scope of the macro. give it some personal space ๐ซถ
- fill mode already enabled, skipping โ (man) an
firequest occurs even though the document is still in fill mode, or already switched back to fill mode. It has no effect. nothing happened, it's fine ๐ - fill mode already disabled, skipping โ (man) an
nfrequest occurs even though the document already switched to no-fill mode and did not switch back to fill mode yet. It has no effect. also nothing ๐ - input text line longer than 80 bytes โ consider breaking the input text line at one of the blank characters before column 80. it's giving scrollbar energy, wrap it โจ
- verbatim
--, maybe consider using\(emโ (mdoc) even though the ASCII output device renders an em-dash as--, that is not a good way to write it in an input file because it renders poorly on all other output devices. it's giving "works on my machine" ๐ญ - function name without markup โ (mdoc) a word followed by an empty pair of parentheses occurs on a text line. Consider using an
FnorXrmacro. put some respect on that function's name ๐ - whitespace at end of input line โ (mdoc, man, roff) whitespace at the end of input lines is almost never semantically significant โ but in the odd case where it might be, it is extremely confusing when reviewing and maintaining documents. invisible AND confusing, iconic combo ๐
- bad comment style โ (roff) comment lines start with a dot, a backslash, and a double-quote character. The
mandocutility treats the line as a comment line even without the backslash, but leaving out the backslash might not be portable. keep the\bestie, it's load-bearing ๐ง
๐ธ Warnings related to the document prologue ๐ธ
- missing manual title, using UNTITLED โ (mdoc, man) a
DtorTHmacro has no arguments, its first argument is an empty string, or there is noDtmacro before the first non-prologuemdoc(7)macro. so we're just calling itUNTITLEDnow I guess ๐ญ - missing manual title, using "" โ (man) an input document does not contain any
THmacro. nothing. zero. nada. ๐ซ - missing manual section, using "" โ (mdoc, man) a
DtorTHmacro lacks the mandatory section argument. which section? we simply do not know ๐ - unknown manual section โ (mdoc) the section number in a
Dtline is invalid, but still used. bold of it, honestly ๐ฅ - filename/section mismatch โ (mdoc, man) the name of the input file being processed is known and its file name extension starts with a non-zero digit, but the
DtorTHmacro contains a section argument that starts with a different non-zero digit. The section argument is used as provided anyway. Consider checking whether the file name or the argument need a correction. it's giving identity crisis ๐ญ - missing date, using "" โ (mdoc, man) the document was parsed as
mdoc(7)and it has noDdmacro, or theDdmacro has no arguments or only empty arguments; or the document was parsed asman(7)and it has noTHmacro, or theTHmacro has less than three arguments or its third argument is empty. no date, no problem, except there is a problem ๐ - cannot parse date, using it verbatim โ (mdoc, man) the date given in a
DdorTHmacro does not follow the conventional format. we're printing it exactly as you wrote it, bestie, no takebacks ๐ - date in the future, using it anyway โ (mdoc, man) the date given in a
DdorTHmacro is more than a day ahead of the currentsystem time(3). time traveller behaviour, but we respect it โฐโจ - missing
Osmacro, using "" โ (mdoc) the default or current system is not shown in this case. we simply have no idea what system you're on ๐ฆ - late prologue macro โ (mdoc) a
DdorOsmacro occurs after some non-prologue macro, but still takes effect. fashionably late, still counts ๐ - prologue macros out of order โ (mdoc) the prologue macros are not given in the conventional order
Dd,Dt,Os. All three macros are used even when given in another order. chaos order slay, but noted ๐
๐ฆ Warnings regarding document structure ๐ฆ
.sois fragile, better useln(1)โ (roff) including files only works when the parser program runs with the correct current working directory. like, it only works under very specific conditions, ngl ๐ซ- no document body โ (mdoc, man) the document body contains neither text nor macros. An empty document is shown, consisting only of a header and a footer line. just a header and footer, no substance ๐ญ
- content before first section header โ (mdoc, man) some macros or text precede the first
ShorSHsection header. The offending macros and text are parsed and added to the top level of the syntax tree, outside any section block. they're just floating there, unsectioned ๐ - first section is not NAME โ (mdoc) the argument of the first
Shmacro is notNAME. This may confusemakewhatis(8)andapropos(1). bestie the indexers are NOT going to find that ๐จ - NAME section without
NmbeforeNdโ (mdoc) theNAMEsection does not contain anyNmchild macro before the firstNdmacro. who even is this page ๐ง - NAME section without description โ (mdoc) the
NAMEsection lacks the mandatoryNdchild macro. mandatory, bestie. mandatory. ๐ค - description not at the end of NAME โ (mdoc) the
NAMEsection does contain anNdchild macro, but other content follows it. the description is supposed to be the last thing, it's the finale ๐ - bad NAME section content โ (mdoc) the
NAMEsection contains plain text or macros other thanNmandNd. keep it clean, keep it curated โจ - missing comma before name โ (mdoc) the
NAMEsection contains anNmmacro that is neither the first one nor preceded by a comma. comma! please! ๐ - missing description line, using "" โ (mdoc) the
Ndmacro lacks the required argument. The title line of the manual will end after the dash. so it just... trails off โ ๐ญ - description line outside NAME section โ (mdoc) an
Ndmacro appears outside theNAMEsection. The arguments are printed anyway and the following text is used forapropos(1), but none of that behaviour is portable. it works but like... don't rely on it ๐ซถ - sections out of conventional order โ (mdoc) a standard section occurs after another section it usually precedes. All section titles are used as given, and the order of sections is not changed. we're not rearranging your whole page for you, we're just judging gently ๐
- duplicate section title โ (mdoc) the same standard section title occurs more than once. we heard you the first time ๐
- unexpected section โ (mdoc) a standard section header occurs in a section of the manual where it normally isn't useful. it's giving misplaced confidence ๐ฌ
- cross reference to self โ (mdoc, man) an
XrorMRmacro refers to a name and section matching the section of the present manual page and a name mentioned in anNmmacro in theNAMEorSYNOPSISsection, or in anFnorFomacro in theSYNOPSIS. Consider usingNmorFninstead ofXr. stop pointing at yourself bestie, you're already right here ๐ช - unusual Xr order โ (mdoc) in the
SEE ALSOsection, anXrmacro with a lower section number follows one with a higher number, or twoXrmacros referring to the same section are out of alphabetical order. sort by section number, then alphabetically. it's a whole system and it's cute โจ - unusual Xr punctuation โ (mdoc) in the
SEE ALSOsection, punctuation between twoXrmacros differs from a single comma, or there is trailing punctuation after the lastXrmacro. comma, comma, and then NO comma. that's the rule ๐ - AUTHORS section without An macro โ (mdoc) an
AUTHORSsection contains noAnmacros, or only empty ones. Probably, there are author names lacking markup. credits without credits, tragic ๐ญ
๐ Warnings related to macros and nesting ๐
- obsolete macro โ (mdoc) see the
mdoc(7)manual for replacements. it's giving retired, respectfully ๐ซก - macro neither callable nor escaped โ (mdoc) the name of a macro that is not callable appears on a macro line. It is printed verbatim. If the intention is to call it, move it to its own input line; otherwise, escape it by prepending
\&. pick a lane bestie ๐ - skipping paragraph macro โ in
mdoc(7)documents, this happens- at the beginning and end of sections and subsections
- right before non-compact lists and displays
- at the end of items in non-column, non-compact lists
- and for multiple consecutive paragraph macros.
In man(7) documents, it happens
- for empty
P,PP, andLPmacros - for
IPmacros having neither head nor body arguments - for
brorspright afterSHorSS
basically the paragraph macro was unnecessary in that exact spot, so we skipped it ๐
- moving paragraph macro out of list โ (mdoc) a list item in a
Bllist contains a trailing paragraph macro. The paragraph macro is moved after the end of the list. we relocated it for its own good ๐ - skipping no-space macro โ (mdoc) an input line begins with an
Nsmacro, or the next argument after anNsmacro is an isolated closing delimiter. The macro is ignored. nothing to do here, moving on ๐ซ blocks badly nested(mdoc) โ if two blocks intersect, one of them needs to completely contain the other, no crossy business. Otherwise your rendered output is gonna look weird in any output format, and in SGML-based formats it's lowkey gonna be outright wrong, because those languages literally do not support badly nested blocks at all. Classic offenders:Ao Bo Ac BcandAo Bq Ac. In those,AcbreaksBoandBqrespectively. ๐nested displays are not portable(mdoc) โ aBd,D1, orDldisplay is sitting nested inside anotherBddisplay. mandoc handles it fine, but most other implementations just fall over. ๐moving content out of list(mdoc) โ aBllist block has text or macros before the very firstItmacro. The offending children get scooted to before the start of the list. ๐ซถfirst macro on lineโ inside aBl -columnlist, aTamacro shows up as the first macro on a line, which is not portable. โจline scope broken(man) โ while parsing the next-line scope of the previous macro, another macro appears that prematurely terminates the previous one. The previous, interrupted macro gets yeeted from the parse tree. ๐ญ
๐ธ Warnings related to missing arguments ๐ธ
skipping empty request(roff, eqn) โ the macro name is missing from a macro definition request, or aneqn(7)control statement or operation keyword is missing its required argument. ๐conditional request controls empty scope(roff) โ a conditional request only actually does something useful if one of these follows it on the same logical input line:- the
โ\{โkeyword, which opens a multi-line scope. - a request or macro or some text, which gives you a single-line scope.
- the immediate end of the logical line with no intervening whitespace, which gives you next-line scope.
- the
Here, though, the conditional request is followed by trailing whitespace only, and there's no other content on its logical input line. And ngl, it doesn't matter whether that logical line got split across multiple physical input lines using โ\โ line continuation characters. This is one of those rare cases where trailing whitespace is syntactically significant, bestie. The conditional request is controlling a scope that contains whitespace only, so it's unlikely to do anything meaningful โ except it might control a following el clause. ๐ฌ
skipping empty macro(mdoc) โ the indicated macro has no arguments, so it has no effect. ๐คทempty block(mdoc, man) โ aBd,Bk,Bl,D1,Dl, orRSblock has nothing in its body and will produce zero output. ๐ณ๏ธempty argument, using 0n(mdoc) โ the required width is missing afterBdorBl-offsetor-width.missing display type, using -ragged(mdoc) โ theBdmacro got invoked without the required display type.list type is not the first argument(mdoc) โ in aBlmacro, at least one other argument comes before the type argument. mandoc copes with any argument order, but some othermdoc(7)implementations do not. ๐missing -width in -tag list, using 8n(mdoc) โ everyBlmacro that has the-tagargument needs-widthtoo.missing utility name, using ""(mdoc) โ theEx -stdmacro is called without an argument beforeNmhas first been called with an argument.missing function name, using ""(mdoc) โ theFomacro is called without an argument. No function name gets printed.empty head in list item(mdoc) โ in aBl -diag,-hang,-inset,-ohang, or-taglist, anItmacro is missing its required argument. The item head is left empty. ๐ซฅempty list item(mdoc) โ in aBl -bullet,-dash,-enum, or-hyphenlist, anItblock is empty. An empty list item gets shown.missing argument, using next line(mdoc) โ anItmacro in aBd -columnlist has no arguments. mandoc uses the text or macros of the following line (if there are any) for the cell, but other formatters may misformat the list. ๐ตโ๐ซmissing font type, using \fR(mdoc) โ aBfmacro has no argument. It switches to the default font.unknown font type, using \fR(mdoc) โ theBfargument is invalid. The default font is used instead.nothing follows prefix(mdoc) โ aPfmacro has no argument, or only one argument and no macro follows on the same input line. That defeats the whole point of it โ specifically, spacing is not suppressed before the text or macros that follow on the next input line. ๐คempty reference block(mdoc) โ anRsmacro is immediately followed by anRemacro on the next input line. An empty block like that produces no output.missing section argument(mdoc, man) โ anXrorMRmacro is missing its second argument, the section number. The first argument (the name) is printed, but without a section number. And in the case ofXr, the parentheses get omitted too.missing -std argument, adding it(mdoc) โ anExorRvmacro is missing the required-stdargument. mandoc assumes-stdeven when you didn't specify it, but other implementations may not. ๐missing option string, using ""(man) โ theOPmacro is invoked with no argument at all. You get an empty pair of square brackets.missing resource identifier, using ""(man) โ theMTorURmacro is invoked with no argument at all. You get an empty pair of angle brackets.missing eqn box, using ""(eqn) โ a diacritic mark or a binary operator is there, but there's nothing to the left of it. An empty box gets inserted.
๐ Warnings related to bad macro arguments ๐
duplicate argument(mdoc) โ aBdorBlmacro has more than one-compact, more than one-offset, or more than one-widthargument. All but the last of these instances get ignored. ๐๏ธskipping duplicate argument(mdoc) โ anAnmacro has more than one-splitor-nosplitargument. All but the first of these get ignored.skipping duplicate display type(mdoc) โ aBdmacro has more than one type argument; the first one wins.skipping duplicate list type(mdoc) โ aBlmacro has more than one type argument; the first one wins.skipping -width argument(mdoc) โ aBl -column,-diag,-ohang,-inset, or-itemlist has a-widthargument. That does absolutely nothing, bestie. ๐wrong number of cellsโ in a line of aBl -columnlist, the number of tabs orTamacros is less than the number expected from the list header line, or exceeds the expected number by more than one. Missing cells stay empty, and every cell past the column count gets joined into one single cell. ๐ฎโ๐จunknown AT&T UNIX version(mdoc) โ anAtmacro has an invalid argument. It gets used verbatim, with"AT&T UNIX "prefixed onto it.comma in function argument(mdoc) โ an argument of anFaorFnmacro contains a comma; it probably wants to be split into two arguments.parenthesis in function name(mdoc) โ the first argument of anFcorFnmacro contains an opening or closing parenthesis. That's probably wrong โ parentheses get added automatically. ๐unknown library name(mdoc, not on OpenBSD) โ anLbmacro has an unknown name argument and will be rendered aslibrary โnameโ.invalid content in Rs block(mdoc) โ anRsblock contains plain text or non-%macros. The bogus content stays in the syntax tree. Formatting may be poor. ๐ญinvalid Boolean argument(mdoc) โ anSmmacro has an argument other thanonoroff. The invalid argument gets moved out of the macro, which leaves the macro empty and makes it toggle the spacing mode. ๐argument contains two font escapes(roff) โ the second argument of acharrequest contains more than one font escape sequence. A wrong font may stay active after using the character.unknown font, skipping request(man, tbl) โ aroff(7)ftrequest or atbl(7)flayout modifier has an unknown font argument.ignoring distance argument(roff) โ besides the margin character, anmcrequest has a second argument that's supposed to represent a distance, but mandoc's implementation ofmcalways ignores that second argument. ๐คทodd number of characters in request(roff) โ atrrequest contains an odd number of characters. The last character gets mapped to the blank character.
๐ฆ Warnings related to plain text ๐ฆ
blank line in fill mode, using .sp(mdoc, man) โ the meaning of blank input lines is only well-defined in non-fill mode: in fill mode, line breaks of text input lines aren't supposed to be significant. But for compatibility with groff, blank lines in fill mode get formatted likesprequests. So if you want a paragraph break, usePporPPinstead of a blank line. โจtab in filled text(mdoc, man) โ the meaning of tab characters is only well-defined in non-fill mode: in fill mode, whitespace isn't supposed to be significant on text input lines. As an implementation dependent choice, tab characters on text lines get passed through to the formatters in any case. And given that the text before the tab is gonna get filled, it's genuinely hard to predict which tab stop position the tab will advance to. ๐ตnew sentence, new line(mdoc) โ a new sentence starts in the middle of a text line. Start it on a new input line to help formatters produce correct spacing. ๐ซถinvalid escape sequence argument(roff) โ the argument of an escape sequence is in an invalid form. Invalid escape sequences get ignored.undefined escape, printing literally(roff) โ in an escape sequence, the first character right after the leading backslash is invalid. That character gets printed literally, which is equivalent to ignoring the backslash.undefined string, using ""(roff) โ if a string is used without being defined beforehand, its value is implicitly set to the empty string. But defining strings explicitly before you use them keeps the code more readable. ๐
๐ Warnings related to tables ๐
tbl line starts with span(tbl) โ the first cell in a table layout line is a horizontal span (โsโ). Data provided for this cell gets ignored, and nothing is printed in the cell.tbl column starts with span(tbl) โ the first line of a table layout specification requests a vertical span (โ^โ). Data provided for this cell gets ignored, and nothing is printed in the cell.skipping vertical bar in tbl layout(tbl) โ a table layout specification contains more than two consecutive vertical bars. A double bar gets printed, and all the extra bars get discarded. โ๏ธ
๐ Errors related to tables ๐
non-alphabetic character in tbl options(tbl) โ the table options line contains a character other than a letter, blank, or comma where the beginning of an option name is expected. The character gets ignored.skipping unknown tbl option(tbl) โ the table options line contains a string of letters that doesn't match any known option name. The word gets ignored.missing tbl option argument(tbl) โ a table option that requires an argument isn't followed by an opening parenthesis, or the opening parenthesis is immediately followed by a closing parenthesis. The option gets ignored. ๐wrong tbl option argument size(tbl) โ a table option argument has a whack number of characters in it. bestie, it's giving malformed. both the option and the argument get yeeted.empty tbl layout(tbl) โ the table layout spec is literally completely empty, like zero lines and zero columns, nothing. as a fallback it just uses a single left-justified column. slay for the backup plan ig.invalid character in tbl layout(tbl) โ the layout spec has a character that's neither a layout key character nor a layout modifier, or a modifier showed up before the first key. the invalid character gets discarded.unmatched parenthesis in tbl layout(tbl) โ there's an opening parenthesis with no matching closing one. the rest of the input line, starting from that parenthesis, has no effect. it's giving abandoned.ignoring invalid column width in tbl layout(tbl) โ a column width specifier is empty, zero, or not a valid numerical expression. the width specifier is ignored and the column is made wide enough to fit all its data cells. lowkey generous of it.ignoring excessive spacing in tbl layout(tbl) โ a spacing modifier is unreasonably large. the default spacing of3nis used instead. calm down bestie.tbl without any data cells(tbl) โ the table has no data cells at all. it will probably produce no output. it's giving empty.ignoring data in spanned tbl cell(tbl) โ a cell is marked as a horizontal span (s) or vertical span (^) in the layout, but it contains data. the data is ignored. the audacity.ignoring extra tbl data cells(tbl) โ a data line has more cells than the corresponding layout line. the data in the extra cells is ignored.data block open at end of tbl(tbl) โ a data block was opened withT{but never closed with a matchingT}. the remaining data lines of the table all go into one cell, and any remaining cells stay empty. not theT{erasure ๐ญ
๐ Errors related to roff, mdoc, and man code ๐
duplicate prologue macro(mdoc) โ one of the prologue macros occurs more than once. the last instance overrides all the previous ones. last one wins, periodt.skipping late title macro(mdoc) โ theDtmacro appears after the first non-prologue macro. traditional formatters can't handle this because they write the page header before parsing the document body. even though this technical restriction doesn't apply to mandoc, traditional semantics is preserved. the late macro is discarded including its arguments. rip.input stack limit exceeded, infinite loop?(roff) โ explicit recursion limits exist for these features, all so we don't get stuck in infinite loops:- expansion of nested escape sequences including expansion of strings and number registers,
- expansion of nested user-defined macros,
- and so file inclusion.
when a limit is hit, the output is incorrect, typically losing some content, but the parser can continue. so it limps on. iconic honestly.
skipping bad character(mdoc, man, roff) โ the input file contains a byte that's not a printableascii(7)character. the message mentions the character number. the offending byte is replaced with a question mark (?). consider editing the input file to replace the byte with an ASCII transliteration of the intended character. do it for the culture ๐ซถskipping unknown macro(mdoc, man, roff) โ the first identifier on a request or macro line isn't recognized as aroff(7)request, nor as a user-defined macro, nor (respectively) as anmdoc(7)orman(7)macro. it may be mistyped or unsupported. the request or macro is discarded including its arguments. typo era ๐skipping request outside macro(roff) โ ashiftorreturnrequest occurs outside any macro definition and has no effect.skipping insecure request(roff) โ an input file tried to run a shell command or read or write an external file. such attempts are denied for security reasons. not today, malicious input ๐ซskipping item outside list(mdoc, eqn) โ anItmacro occurs outside anyBllist, or aneqn(7)abovedelimiter occurs outside anypile. it's discarded including its arguments.skipping column outside column list(mdoc) โ aTamacro occurs outside anyBl -columnblock. it's discarded including its arguments.skipping end of block that is not open(mdoc, man, eqn, tbl, roff) โ various syntax elements can only be used to explicitly close blocks that were previously opened. anmdoc(7)block closing macro, aman(7)ME,REorUEmacro, aneqn(7)right delimiter or closing brace, or the end of an equation, table, orroff(7)conditional request shows up but there's no matching block open. the offending request or macro is discarded. it's giving closing a tab you never opened.fewer RS blocks open, skipping(man) โ theREmacro is invoked with an argument, but fewer than the specified number ofRSblocks is open. theREmacro is discarded.inserting missing end of block(mdoc, tbl) โ variousmdoc(7)macros as well as tables require explicit closing by dedicated macros. a block that doesn't support bad nesting ends before all its children are properly closed. the open child nodes are closed implicitly. bestie it's fine, we'll clean up for you โจappending missing end of block(mdoc, man, eqn, tbl, roff) โ at the end of the document, an explicitmdoc(7)block, aman(7)next-line scope orMT,RSorURblock, an equation, table, orroff(7)conditional or ignore block is still open. the open block is closed implicitly. leaving things open is so real of it.escaped character not allowed in a name(roff) โ macro, string and register identifiers consist of printable, non-whitespace ASCII characters. escape sequences and characters and strings expressed in terms of them can't form part of a name. the first argument of anam,as,de,ds,nr, orrrrequest, or any argument of anrmrequest, or the name of a request or user defined macro being called, is terminated by an escape sequence. in the cases ofas,ds, andnr, the request has no effect at all. in the cases ofam,de,rr, andrm, whatever was parsed up to this point is used as the arguments to the request, and the rest of the input line is discarded including the escape sequence. when parsing for a request or a user-defined macro name to be called, only the escape sequence is discarded. the characters preceding it are used as the request or macro name, and the characters following it are used as the arguments to the request or macro. okay that's a lot but it's all important, iykyk.using macro argument outside macro(roff) โ the escape sequence\$occurs outside any macro definition and expands to the empty string.argument number is not numeric(roff) โ the argument of the escape sequence\$isn't a digit; the escape sequence expands to the empty string.negative argument, using 0(roff) โ ashiftrequest has a negative argument, or an argument that's negative due to integer overflow. macro argument numbering remains unchanged.NOT IMPLEMENTED: Bd -file(mdoc) โ for security reasons, theBdmacro does not support the-fileargument. by requesting the inclusion of a sensitive file, a malicious document might otherwise trick a privileged user into inadvertently displaying the file on the screen, revealing the file content to bystanders. the argument is ignored including the file name following it. absolutely not, we're not doing that ๐ซskipping display without arguments(mdoc) โ aBdblock macro has no arguments. the block is discarded, and the block content is displayed in whatever mode was active before the block.missing list type, using -item(mdoc) โ aBlmacro fails to specify the list type.argument is not numeric, using 1(roff) โ the argument of acerequest isn't a number.argument is not a character(roff) โ the first argument of acharrequest is neither a single ASCII character nor a single character escape sequence. the request is ignored including all its arguments.skipping unusable escape sequence(roff) โ the first argument of anmcrequest is neither a single ASCII character nor a single character escape sequence. all arguments are ignored and printing of a margin character is disabled.missing manual name, using ""(mdoc, man) โ the first call toNm, or any call in theNAMEsection, lacks the required argument, orMRis called without any argument. nameless era ๐ญuname(3) system call failed, using UNKNOWN(mdoc) โ theOsmacro is called without arguments, and theuname(3)system call failed. as a workaround, mandoc can be compiled with-DOSNAME="\"string\"". keep this exactly as written bestie ๐unknown standard specifier(mdoc) โ anStmacro has an unknown argument and is discarded.skipping request without numeric argument(roff, eqn) โ anitrequest or aneqn(7)sizeorgsizestatement has a non-numeric or negative argument, or no argument at all. the invalid request or statement is ignored.excessive shift(roff) โ the argument of ashiftrequest is larger than the number of arguments of the macro currently being executed. all macro arguments are deleted and\n(.$is set to zero. gone, reduced to atoms.NOT IMPLEMENTED: .so with absolute path or ".."(roff) โ for security reasons, mandoc allowssofile inclusion requests only with relative paths and only without ascending to any parent directory. by requesting the inclusion of a sensitive file, a malicious document might otherwise trick a privileged user into inadvertently displaying the file on the screen, revealing the file content to bystanders. mandoc only shows the path as it appears behindso. hard no ๐ซ.so request failed(roff) โ servicing asorequest requires reading an external file, but the file couldn't be opened. mandoc only shows the path as it appears behindso.skipping all arguments(mdoc, man, eqn, roff) โ anmdoc(7)Bt,Ed,Ef,Ek,El,Lp,Pp,Re,Rs, orUdmacro, anItmacro in a list that don't support item heads, aman(7)LP,P, orPPmacro, aneqn(7)EQorENmacro, or aroff(7)br,fi, ornfrequest or..block closing request is invoked with at least one argument. all arguments are ignored. read the room, arguments.skipping excess arguments(mdoc, man, roff) โ a macro or request is invoked with too many arguments:Fo,MT,PD,RS,UR,ft, orspwith more than one argumentAnwith another argument after-splitor-nosplitREwith more than one argument or with a non-integer argumentOPor a request of thedefamily with more than two argumentsDtorMRwith more than three argumentsTHwith more than five argumentsBd,Bk, orBlwith invalid arguments
the excess arguments are ignored. too much, bestie.
๐ฆ Errors related to escape sequences ๐ฆ
incomplete escape sequence(roff) โ the end of the input line is hit while parsing the argument of an escape sequence. in this case,\*and\nexpand to an empty string,\Bto the digit0, and\wto the length of the incomplete argument. all other incomplete escape sequences are ignored. it ran out of road mid-escape ๐ญinvalid special character(roff) โ so a special character escape sequence is invalid, right? Like a Unicode sequence pointing to a surrogate or beyond the Unicode range, or a\[char...]escape sequence that represents a control character or points beyond the unsigned char range, or an invalid variable-length form of a single-byte character escape sequence โ for example writing\[e]or\[~]instead of\eor\~, respectively. Bestie. The escape sequence is ignored.unknown special character(roff) โ the name you gave in a special character escape sequence? mandoc literally does not know her. The escape sequence is ignored. ๐invalid escape argument delimiter(roff) โ an escape sequence that expects a numerical argument is trying to use one of the characters" %&()*+-./0123456789:<=>as an argument delimiter. Rude. The escape sequence is ignored including the invalid opening delimiter, and the rest of the argument may appear as output text. And like โ various characters can be used as argument delimiters, but using the apostrophe-quote character (โ'โ) is recommended for readability and robustness. iykyk ๐
โจ Unsupported features โจ
input too large(mdoc, man) โ okay so currently, mandoc cannot handle input files larger than its arbitrary size limit of 2^31 bytes (2 Gigabytes). And honestly? Since useful manuals are always small, this is not a problem in practice fr fr. Parsing is aborted as soon as the condition is detected. ๐ซถunsupported control character(roff) โ an ASCII control character that otherroff(7)implementations support but mandoc does not was found in an input file. It gets replaced by a question mark. ๐ฅฒunsupported escape sequence(roff) โ an input file contains an escape sequence supported by GNU troff or Heirloom troff but not by mandoc, and it is likely that this will cause information loss or considerable misformatting. ๐ญunsupported roff request(roff) โ literally the same energy but for aroff(7)request: the input file contains a request supported by GNU troff or Heirloom troff but not by mandoc, and it is likely that this will cause information loss or considerable misformatting. ๐eqn delim option in tbl(eqn, tbl) โ the options line of a table defines equation delimiters. Any equation source code contained in the table will be printed unformatted. ๐unsupported table layout modifier(tbl) โ a table layout specification contains an โmโ modifier. The modifier is discarded. bye ๐ignoring macro in table(tbl, mdoc, man) โ a table contains an invocation of anmdoc(7)orman(7)macro, or of an undefined macro. The macro is ignored, and its arguments are handled as if they were a text line. main character energy denied โจskipping tbl in -Tman mode(mdoc, tbl) โ an input file contains theTSmacro. Heads up: this message is only generated in-T manoutput mode, wheretbl(7)input is not supported. ๐ฆskipping eqn in -Tman mode(mdoc, eqn) โ an input file contains theEQmacro. Again, this message is only generated in-T manoutput mode, whereeqn(7)input is not supported. ๐ฆ
๐ Bad command line arguments ๐
bad command line argumentโ the argument following one of the-IKMmOTWcommand line options is invalid, or a file given as a command line argument cannot be opened. ngl that one stings ๐ญduplicate command line argumentโ the-Icommand line option was specified twice. pick a lane bestie ๐option has a superfluous valueโ an argument to the-Ooption has a value but does not accept one.missing option valueโ an argument to the-Ooption has no argument but requires one.bad option valueโ an argument to the-O indentorwidthoption has an invalid value.duplicate option valueโ the same-Ooption is specified more than once.no such tagโ the-O tagoption was specified but the tag was not found in any of the displayed manual pages. she's not here rn ๐ซ-Tmarkdown unsupported for man(7) input(man) โ the-T markdownoption was specified but an input file uses theman(7)language. No output is produced for that input file. periodt.
๐ SEE ALSO ๐
apropos(1), man(1), eqn(7), man(7), mandoc_char(7), mdoc(7), roff(7), tbl(7)
The whole friend group ๐
๐ HISTORY ๐
The mandoc utility first appeared in OpenBSD 4.8. The option -I appeared in OpenBSD 5.2, and -aCcfhKklMSsw in OpenBSD 5.7. glow-up after glow-up, we love to see it โจ
๐ฆ AUTHORS ๐ฆ
The mandoc utility was written by Kristaps Dzonsons <kristaps@bsd.lv> and is maintained by Ingo Schwarze <schwarze@openbsd.org>. absolute icons, no cap ๐
bestie that's the whole page!! go forth and format your manuals, you're gonna slay ๐ ๐
Okay so this version is from the Debian fam, dated August 22, 2025 โ MANDOC(1), that's the one. mwah ๐๐ง
๐ฆ where this page comes from
- freebsd 14.5: base 14.5
- freebsd 15.1: base 15.1
- Copyright (c) 2012, 2014-2023, 2025 Ingo Schwarze <schwarze@openbsd.org>
- Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms