X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/224d010444ff10359e8d1c19e8739476b1e8f0f9..57d713154a86ae733a986dfc0f7e95a3bc7917c3:/mandoc.1 diff --git a/mandoc.1 b/mandoc.1 index b91d086e..cce6f834 100644 --- a/mandoc.1 +++ b/mandoc.1 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.39 2009/10/03 15:08:09 kristaps Exp $ +.\" $Id: mandoc.1,v 1.41 2009/10/03 16:36:06 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -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: .