summaryrefslogblamecommitdiffstats
path: root/mdocml.1
blob: 810d47f2d7e935b4f2a802272ba540e308daf280 (plain) (tree)
1
2
3
4
5
6
7
8
9
   
              
            
   
   
        
          
                       
   
            
          

                     
             
   


               

                      

                                                                    
                            
                     









                                                              


                                         
        
                             



               
      
          
   
   





                                                         

           

                                                                  

               



   
    
            
                             
   
                                   
   


                    

            

                 



                       
                                          

           


                                                   
            
.\"
.Dd $Mdocdate$
.Dt mdocml 1
.Os
.\"
.Sh NAME
.Nm mdocml
.Nd mdoc macro compiler
.\"
.Sh SYNOPSIS
.Nm mdocml
.Op Fl v
.Op Fl W Ns Ar err...
.Op Ar infile
.\"
.Sh DESCRIPTION
The
.Nm
utility interfaces the
.Xr mdoc 3
library to scan, parse and validate mdoc-macro documents.  Arguments
follow:
.Bl -tag -width "\-Werr... "
.It Fl W Ns Ar err...
Print warning messages.  May be set to 
.Fl W Ns Ar all
for all warnings, 
.Ar compat
for groff/troff-compatibility warnings, or
.Ar syntax
for syntax warnings.  If
.Fl W Ns Ar error 
is specified, warnings are considered errors and cause utility
termination.  Multiple 
.Fl W
arguments may be comma-separated, such as
.Fl W Ns Ar error,all .
.It Fl v
Print verbose parsing output.
.It Ar infile
Read input from
.Ar infile ,
which may be 
.Dq \-
for stdin.
.El
.Pp
Parsing and validation rules are drawn entirely from the 
.Xr mdoc 7
and
.Xr mdoc.samples 7 
manuals.
.Pp
By default,
.Nm
reads from stdin, writes messages to stdout, and writes errors and
warnings to stderr.
.Pp
.Ex -std mdocml
.Pp
.Nm
is
.Ud
.\" 
.Sh EXAMPLES
To validate this manual page:
.Pp
.D1 % mdocml \-Wall,error mdocml.1 
.\"
.Sh SEE ALSO
.Xr groff 1 ,
.Xr mdoc.samples 7 ,
.Xr mdoc 7 ,
.Xr mdoc 3
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
The
.Nm
utility was written by 
.An Kristaps Dzonsons Aq kristaps@kth.se .
.\"
.Sh CAVEATS
See
.Xr mdoc 3
for a list of bugs, caveats, and incomplete macros.
.\" .Sh BUGS