mdoc-0.2.0.0: examples/mdoc-dump.1

.\" vim: ft=nroff.mustache
.Dd $Mdocdate: September 29 2026 $
.Dt MDOC\-DUMP 1
.Os
.Sh NAME
.Nm mdoc\-dump
.Nd parse and dump an mdoc file
.Sh SYNOPSIS
.Nm
.Bk -words
.Op Fl cv
.Op Fl Fl color= Ns Ar auto|always|never
.Op Fl Fl update\-mdocdate
.Op Ar FILE ...
.Ek
.Sh DESCRIPTION
The options are as follows:
.Bl -tag -width indent
.It Fl c , Fl Fl check
Check that re\-rendering parsed as mdoc matches input
.It Fl v , Fl Fl debug
Log more verbosely
.It Fl Fl color= Ns Ar auto|always|never
When to colorize the output
.It Fl Fl update\-mdocdate
Update any $Mdocdate$ macros in the output
.It Ar FILE
Read from the given file (if specified multiple times, output is concatenated;
if none are specified, stdin is read)
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm :
.Bl -tag -width "MDOC_DUMP_DEBUG"
.It Ev MDOC_DUMP_COLOR
When to colorize the output
.It Ev MDOC_DUMP_DEBUG
Log more verbosely
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr mdoc 7