summaryrefslogtreecommitdiffstatshomepage
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
commit224d010444ff10359e8d1c19e8739476b1e8f0f9 (patch)
tree6a6183a1dbc32d1b933007a67f7615cc989226d4 /mandoc.1
parentccb56233c5986fe4875341405f85b15dcb2e946f (diff)
downloadmandoc-224d010444ff10359e8d1c19e8739476b1e8f0f9.tar.gz
mandoc-224d010444ff10359e8d1c19e8739476b1e8f0f9.tar.zst
mandoc-224d010444ff10359e8d1c19e8739476b1e8f0f9.zip
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.129
1 files changed, 20 insertions, 9 deletions
diff --git a/mandoc.1 b/mandoc.1
index 318f0798..b91d086e 100644
--- 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.39 2009/10/03 15:08:09 kristaps Exp $
.\"
.\" 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.
.\"
-.Dd $Mdocdate: September 21 2009 $
+.Dd $Mdocdate: October 3 2009 $
.Dt MANDOC 1
.Os
.
@@ -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 .