=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.88 retrieving revision 1.96 diff -u -p -r1.88 -r1.96 --- mandoc/mandoc.1 2011/05/20 15:51:18 1.88 +++ mandoc/mandoc.1 2011/10/06 23:05:55 1.96 @@ -1,6 +1,6 @@ -.\" $Id: mandoc.1,v 1.88 2011/05/20 15:51:18 kristaps Exp $ +.\" $Id: mandoc.1,v 1.96 2011/10/06 23:05:55 kristaps Exp $ .\" -.\" Copyright (c) 2009, 2010 Kristaps Dzonsons +.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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: May 20 2011 $ +.Dd $Mdocdate: October 6 2011 $ .Dt MANDOC 1 .Os .Sh NAME @@ -27,7 +27,7 @@ .Op Fl O Ns Ar option .Op Fl T Ns Ar output .Op Fl W Ns Ar level -.Op Ar file... +.Op Ar .Sh DESCRIPTION The .Nm @@ -157,16 +157,7 @@ The utility accepts the following .Fl T arguments, which correspond to output modes: -.Bl -tag -width Ds -.It Fl T Ns Cm utf8 -Encode output in the UTF-8 multi-byte format. -See -.Xr UTF-8 Output . -.It Fl T Ns Cm locale -Encode output using the current -.Xr locale 1 . -See -.Sx Locale Output . +.Bl -tag -width "-Tlocale" .It Fl T Ns Cm ascii Produce 7-bit ASCII output. This is the default. @@ -180,6 +171,16 @@ See Parse only: produce no output. Implies .Fl W Ns Cm warning . +.It Fl T Ns Cm locale +Encode output using the current locale. +See +.Sx Locale Output . +.It Fl T Ns Cm man +Produce +.Xr man 7 +format output. +See +.Sx Man Output . .It Fl T Ns Cm pdf Produce PDF output. See @@ -190,6 +191,10 @@ See .Sx PostScript Output . .It Fl T Ns Cm tree Produce an indented parse tree. +.It Fl T Ns Cm utf8 +Encode output in the UTF\-8 multi-byte format. +See +.Sx UTF\-8 Output . .It Fl T Ns Cm xhtml Produce strict CSS1/XHTML-1.0 output. See @@ -198,23 +203,6 @@ See .Pp If multiple input files are specified, these will be processed by the corresponding filter in-order. -.Ss UTF-8 Output -Use -.Fl T Ns Cm utf8 -to force a UTF-8 locale. -See -.Sx Locale Output -for details and options. -.Ss Locale Output -Locale-depending output encoding is triggered with -.Fl T Ns Cm locale . -This option is not available on all systems: systems without locale -support, or those whose internal representation is not natively UCS-4, -will fall back to -.Fl T Ns Cm ascii . -See -.Sx ASCII Output -for font style specification and available command-line arguments. .Ss ASCII Output Output produced by .Fl T Ns Cm ascii , @@ -265,12 +253,18 @@ If a style-sheet is not specified with defaults to simple output readable in any graphical or text-based web browser. .Pp -Special characters are rendered in decimal-encoded UTF-8. +Special characters are rendered in decimal-encoded UTF\-8. .Pp The following .Fl O arguments are accepted: .Bl -tag -width Ds +.It Cm fragment +Do not emit doctype, html, and body elements. +The +.Cm style +argument shall be unused. +This is useful when embedding manual content within existing documents. .It Cm includes Ns = Ns Ar fmt The string .Ar fmt , @@ -307,6 +301,44 @@ is used for an external style-sheet. This must be a valid absolute or relative URI. .El +.Ss Locale Output +Locale-depending output encoding is triggered with +.Fl T Ns Cm locale . +This option is not available on all systems: systems without locale +support, or those whose internal representation is not natively UCS-4, +will fall back to +.Fl T Ns Cm ascii . +See +.Sx ASCII Output +for font style specification and available command-line arguments. +.Ss Man Output +Translate input format into +.Xr man 7 +output format. +This is useful for distributing manual sources to legancy systems +lacking +.Xr mdoc 7 +formatters. +.Pp +If +.Xr mdoc 7 +is passed as input, it is translated into +.Xr man 7 ; +if the input format is +.Xr man 7 , +it is parsed and re-outputted. +In either case, the +.Xr roff 7 +.Sq so +macros are processed prior to producing output. +.Ss PDF Output +PDF-1.1 output may be generated by +.Fl T Ns Cm pdf . +See +.Sx PostScript Output +for +.Fl O +arguments and defaults. .Ss PostScript Output PostScript .Qq Adobe-3.0 @@ -341,14 +373,13 @@ If an unknown value is encountered, .Ar letter is used. .El -.Ss PDF Output -PDF-1.1 output may be generated by -.Fl T Ns Cm pdf . +.Ss UTF\-8 Output +Use +.Fl T Ns Cm utf8 +to force a UTF\-8 locale. See -.Sx PostScript Output -for -.Fl O -arguments and defaults. +.Sx Locale Output +for details and options. .Ss XHTML Output Output produced by .Fl T Ns Cm xhtml @@ -418,6 +449,16 @@ To check over a large set of manuals: To produce a series of PostScript manuals for A4 paper: .Pp .Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps +.Pp +Convert a modern +.Xr mdoc 7 +manual to the older +.Xr man 7 +format, for use on systems lacking an +.Xr mdoc 7 +parser: +.Pp +.Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man .Sh DIAGNOSTICS Standard error messages reporting parsing errors are prefixed by .Pp @@ -573,7 +614,8 @@ lists render similarly. The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@bsd.lv . +.An Kristaps Dzonsons , +.Mt kristaps@bsd.lv . .Sh CAVEATS In .Fl T Ns Cm html