=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.96 retrieving revision 1.100 diff -u -p -r1.96 -r1.100 --- mandoc/mandoc.1 2011/10/06 23:05:55 1.96 +++ mandoc/mandoc.1 2011/12/25 19:35:44 1.100 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.96 2011/10/06 23:05:55 kristaps Exp $ +.\" $Id: mandoc.1,v 1.100 2011/12/25 19:35:44 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: October 6 2011 $ +.Dd $Mdocdate: December 25 2011 $ .Dt MANDOC 1 .Os .Sh NAME @@ -34,6 +34,19 @@ The utility formats .Ux manual pages for display. +.Pp +By default, +.Nm +reads +.Xr mdoc 7 +or +.Xr man 7 +text from stdin, implying +.Fl m Ns Cm andoc , +and produces +.Fl T Ns Cm ascii +output. +.Pp The arguments are as follows: .Bl -tag -width Ds .It Fl m Ns Ar format @@ -96,18 +109,6 @@ If multiple files are specified, .Nm will halt with the first failed parse. .El -.Pp -By default, -.Nm -reads -.Xr mdoc 7 -or -.Xr man 7 -text from stdin, implying -.Fl m Ns Cm andoc , -and produces -.Fl T Ns Cm ascii -output. .Ss Input Formats The .Nm @@ -234,6 +235,15 @@ The following .Fl O arguments are accepted: .Bl -tag -width Ds +.It Cm indent Ns = Ns Ar indent +The left margin for normal text is set to +.Ar indent +blank characters instead of the default of five for +.Xr mdoc 7 +and seven for +.Xr man 7 . +Increasing this is not recommended; it may result in degraded formatting, +for example overfull lines or ugly line breaks. .It Cm width Ns = Ns Ar width The output width is set to .Ar width , @@ -260,10 +270,19 @@ The following arguments are accepted: .Bl -tag -width Ds .It Cm fragment -Do not emit doctype, html, and body elements. +Omit the +.Aq !DOCTYPE +declaration and the +.Aq html , +.Aq head , +and +.Aq body +elements and only emit the subtree below the +.Aq body +element. The .Cm style -argument shall be unused. +argument will be ignored. This is useful when embedding manual content within existing documents. .It Cm includes Ns = Ns Ar fmt The string @@ -323,14 +342,18 @@ formatters. If .Xr mdoc 7 is passed as input, it is translated into -.Xr man 7 ; -if the input format is +.Xr man 7 . +If the input format is .Xr man 7 , -it is parsed and re-outputted. -In either case, the +the input is copied to the output, expanding any .Xr roff 7 .Sq so -macros are processed prior to producing output. +requests. +The parser is also run, and as usual, the +.Fl W +level controls which +.Sx DIAGNOSTICS +are displayed before copying the input to the output. .Ss PDF Output PDF-1.1 output may be generated by .Fl T Ns Cm pdf .