packages feed

mdoc-0.4.0.0: examples/mandoc.1

.\" vim: ft=nroff.mustache
.Dd $Mdocdate: September 20 2026 $
.Dt MANDOC 1
.Os
.Sh NAME
.Nm mandoc
.Nd format manual pages
.Sh SYNOPSIS
.Nm
.Bk -words
.Op Fl ac
.Op Fl I Ar os=name
.Op Fl K Ar encoding
.Op Fl O Ar options
.Op Fl T Ar output
.Op Fl W Ar level
.Op Fl Fl mdoc | Fl Fl man
.Op Ar file ...
.Ek
.Sh DESCRIPTION
The options are as follows:
.Bl -tag -width indent
.It Fl a
If the standard output is a terminal device and \-c is not specified, use
less(1) to paginate the output, just like man(1) would.
.It Fl c
Copy the formatted manual pages to the standard output without using less(1) to
paginate them. This is the default. It can be specified to override \-a.
.It Fl I Ar os=name
Override the default operating system name for the mdoc(7) Os and for the man(7)
TH macro.
.It Fl K Ar encoding
Specify the input encoding. The supported encoding arguments are us\-ascii,
iso\-8859\-1, and utf\-8. If not specified, autodetection uses the first match
in the following list:
.It Fl O Ar options
Comma\-separated output options. See the descriptions of the individual output
formats for supported options.
.It Fl T Ar output
Select the output format. Supported values for the output argument are ascii,
html, the default of locale, man, markdown, tree, and utf8.
.It Fl W Ar level
Specify the minimum message level to be reported on the standard error output
and to affect the exit status.
.It Fl Fl man
With \-man, all input files are interpreted as man(7).
.It Fl Fl mdoc
With \-mdoc, all input files are interpreted as mdoc(7).
.It Ar file
Read from the given input file. If multiple files are specified, they are
processed in the given order. If unspecified, mandoc reads from standard input.
.El
.Sh EXIT STATUS
.Ex -std