summaryrefslogtreecommitdiffstats
path: root/mandoc.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-10-03 15:08:09 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-10-03 15:08:09 +0000
commit54bada649de2dc93dd974dabdb3c9a3c732571f5 (patch)
treec6232a3224f4c599fc64f935d85a38c77758952c /mandoc.1
parent30fcd4b7eb064dd0029d7fc6e60afc9b973015cb (diff)
downloadmandoc-54bada649de2dc93dd974dabdb3c9a3c732571f5.tar.gz
Element tag buffer is now part of struct html.
buffmt() can be called in sequence. Noted BUFSIZ-sized buffer in CAVEATS (attribute length for link formats). Added -oman=FMT -Thtml option for `Xr' manual links. Removed -obase=URI -Thtml option (obsolete).
Diffstat (limited to 'mandoc.1')
-rw-r--r--mandoc.125
1 files changed, 18 insertions, 7 deletions
diff --git a/mandoc.1 b/mandoc.1
index fc5086aa..b3e945a2 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -260,13 +260,15 @@ 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 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.
+macro). The default is
+.Ar %N.%S.html .
.El
.
.Sh EXAMPLES
@@ -361,9 +363,18 @@ Sentences are unilaterally monospaced.
.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 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 .