Using putchar for single-character prints (noted by Joerg Sonnenberger).

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 318f0798b189dfc08489bcf1ae2291c51c1d7e03..f02219b3fcb17325762583e3701274f497380eee 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.1,v 1.38 2009/09/21 13:44:56 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.45 2009/10/26 15:44:51 kristaps Exp $

 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"


@@ -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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: September 21 2009 $
+.Dd $Mdocdate: October 26 2009 $

 .Dt MANDOC 1
 .Os
 .
 .Dt MANDOC 1
 .Os
 .


@@ -28,7 +28,7 @@
 .Nm mandoc
 .Op Fl f Ns Ar option...
 .Op Fl m Ns Ar format
 .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...
 .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 .
 .
 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.
 Comma-separated output options.  See
 .Sx Output Options
 for details.


@@ -228,6 +228,11 @@ When rewinding the scope of a block macro, forces the compiler to ignore
 scope violations.  This can seriously mangle the resulting tree.
 .Pq mdoc only
 .
 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.
 .
 .It Fl f Ns Ar no-ign-escape
 Don't ignore invalid escape sequences.
 .


@@ -255,18 +260,36 @@ For the time being, only
 .Fl T Ns Ar html
 is the only mode with output options:
 .Bl -tag -width Ds
 .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.
 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 base=http://base/
-The URL
-.Ar http://base/
-is used as a base URL for all relative links.  This is useful when
-linking between documents via the
+.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
 .Sq \&Xr

-macro.
+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
 .El
 .
 .Sh EXAMPLES


@@ -277,11 +300,11 @@ To page manuals to the terminal:
 .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less
 .
 .Pp
 .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
 .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:
 .
 .Pp
 To check over a large set of manuals:
 .


@@ -356,14 +379,43 @@ retains spaces.
 .It
 Sentences are unilaterally monospaced.
 .El
 .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 ,
 .Xr mdoc 7 ,
 .Xr man 7
 .\" SECTION
 .Sh SEE ALSO
 .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,
 .Xr man 7

-.\" SECTION
+.

 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .
 .Sh AUTHORS
 The
 .Nm
 utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .

+.
+.Sh CAVEATS
+In
+.Fl T Ns Ar html ,
+the maximum size of an element attribute is determined by
+.Dv BUFSIZ ,
+which is usually 1024 bytes.  Be aware of this when setting long link
+formats with
+.Fl O Ns Ar man=fmt .