=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.39 retrieving revision 1.46 diff -u -p -r1.39 -r1.46 --- mandoc/mandoc.1 2009/10/03 15:08:09 1.39 +++ mandoc/mandoc.1 2009/11/05 10:16:01 1.46 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.39 2009/10/03 15:08:09 kristaps Exp $ +.\" $Id: mandoc.1,v 1.46 2009/11/05 10:16:01 kristaps Exp $ .\" .\" Copyright (c) 2009 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 3 2009 $ +.Dd $Mdocdate: November 5 2009 $ .Dt MANDOC 1 .Os . @@ -28,7 +28,7 @@ .Nm mandoc .Op Fl f Ns Ar option... .Op Fl m Ns Ar format -.Op Fl o Ns Ar option... +.Op Fl O Ns Ar option... .Op Fl T Ns Ar output .Op Fl V .Op Fl W Ns Ar err... @@ -54,7 +54,7 @@ Input format. See for available formats. Defaults to .Fl m Ns Ar andoc . . -.It Fl o Ns Ar format +.It Fl O Ns Ar option... Comma-separated output options. See .Sx Output Options for details. @@ -228,6 +228,11 @@ When rewinding the scope of a block macro, forces the scope violations. This can seriously mangle the resulting tree. .Pq mdoc only . +.It Fl f Ns Ar ign-escape +Ignore invalid escape sequences. +This is the default, but the option can be used to override an earlier +.Fl f Ns Ar strict . +. .It Fl f Ns Ar no-ign-escape Don't ignore invalid escape sequences. . @@ -255,20 +260,36 @@ For the time being, only .Fl T Ns Ar html is the only mode with output options: .Bl -tag -width Ds -.It Fl o Ns Ar style=style.css +.It Fl O Ns Ar style=style.css The file .Ar style.css is used for an external style-sheet. This must be a valid absolute or relative URI. -.It Fl o Ns Ar man=fmt +.It Fl O Ns Ar includes=fmt The string .Ar fmt , for example, +.Ar ../src/%I.html , +is used as a template for linked header files (usually via the +.Sq \&In +macro). Instances of +.Sq \&%I +are replaced with the include filename. The default is not to present a +hyperlink. +.It Fl O Ns Ar man=fmt +The string +.Ar fmt , +for example, .Ar ../html%S/%N.%S.html , is used as a template for linked manuals (usually via the .Sq \&Xr -macro). The default is -.Ar %N.%S.html . +macro). Instances of +.Sq \&%N +and +.Sq %S +are replaced with the linked manual's name and section, respectively. +If no section is included, section 1 is assumed. The default is not to +present a hyperlink. .El . .Sh EXAMPLES @@ -279,11 +300,11 @@ To page manuals to the terminal: .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less . .Pp -To produce HTML manuals with -.Pa http://localhost/ -as the base URI: +To produce HTML manuals with +.Ar style.css +as the style-sheet: .Pp -.D1 % mandoc \-Thtml -obase=http://localhost/ mdoc.7 > mdoc.7.html +.D1 % mandoc \-Thtml -ostyle=style.css mdoc.7 > mdoc.7.html .Pp To check over a large set of manuals: . @@ -358,6 +379,26 @@ retains spaces. .It Sentences are unilaterally monospaced. .El +. +.Ss HTML output +.Bl -bullet -compact +.It +The +.Xr mdoc 7 +.Sq \&Bl \-hang +and +.Sq \&Bl \-tag +list types render similarly (no break following overreached left-hand +side) due to the expressive constraints of HTML. +. +.It +The +.Xr man 7 +.Sq IP +and +.Sq TP +lists render similarly. +.El .\" SECTION .Sh SEE ALSO .Xr mandoc_char 7 , @@ -377,4 +418,15 @@ the maximum size of an element attribute is determined .Dv BUFSIZ , which is usually 1024 bytes. Be aware of this when setting long link formats with -.Fl o Ns Ar man=fmt . +.Fl O Ns Ar man=fmt . +.Pp +The +.Fl T Ns Ar html +utility doesn't support the +.Sq \ef +and +.Sq \es +text decorations documented in +.Xr mdoc 7 +and +.Xr man 7 .