=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.39 retrieving revision 1.43 diff -u -p -r1.39 -r1.43 --- mandoc/mandoc.1 2009/10/03 15:08:09 1.39 +++ mandoc/mandoc.1 2009/10/15 02:42:53 1.43 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.39 2009/10/03 15:08:09 kristaps Exp $ +.\" $Id: mandoc.1,v 1.43 2009/10/15 02:42:53 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: October 15 2009 $ .Dt MANDOC 1 .Os . @@ -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. @@ -260,6 +260,17 @@ 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 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 , @@ -267,8 +278,13 @@ 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 +295,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: . @@ -357,6 +373,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