aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdocml.1
diff options
context:
space:
mode:
Diffstat (limited to 'mdocml.1')
-rw-r--r--mdocml.121
1 files changed, 14 insertions, 7 deletions
diff --git a/mdocml.1 b/mdocml.1
index 6faf032d..910adac4 100644
--- a/mdocml.1
+++ b/mdocml.1
@@ -9,6 +9,7 @@
.\" SECTION
.Sh SYNOPSIS
.Nm mdocml
+.Op Fl f Ns Ar filter
.Op Fl v
.Op Fl W Ns Ar err...
.Op Ar infile
@@ -18,10 +19,20 @@ The
.Nm
utility interfaces the
.Xr mdoc 3
-library to scan, parse and validate mdoc-macro documents. Arguments
-follow:
+library to scan, parse, validate and output mdoc-macro documents.
+Arguments follow:
.Bl -tag -width "\-Werr... "
.\" ITEM
+.It Fl f Ns Ar filter
+Pipe the parsed syntax tree into an output filter. May be either
+.Ar tree
+for the parse tree or
+.Ar term
+for a terminal-encoded, formatted manual page.
+.\" ITEM
+.It Fl v
+Print verbose parsing output.
+.\" ITEM
.It Fl W Ns Ar err...
Print warning messages. May be set to
.Fl W Ns Ar all
@@ -37,9 +48,6 @@ termination. Multiple
arguments may be comma-separated, such as
.Fl W Ns Ar error,all .
.\" ITEM
-.It Fl v
-Print verbose parsing output.
-.\" ITEM
.It Ar infile
Read input from
.Ar infile ,
@@ -58,8 +66,7 @@ manuals.
.Pp
By default,
.Nm
-reads from stdin, writes messages to stdout, and writes errors and
-warnings to stderr.
+reads from stdin and only validates its input.
.\" PARAGRAPH
.Pp
.Ex -std mdocml