aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc_html.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2018-04-13 16:28:07 +0000
committerIngo Schwarze <schwarze@openbsd.org>2018-04-13 16:28:07 +0000
commit0c8f9a78c144e759fc8ce4b1b92b1787474385bd (patch)
tree5bd9b378850a798e0f4ab3c4b335909e576d80b0 /mandoc_html.3
parent0fde2fa390d9a4194f8a09e5c0f5d921d8755109 (diff)
downloadmandoc-0c8f9a78c144e759fc8ce4b1b92b1787474385bd.tar.gz
mandoc-0c8f9a78c144e759fc8ce4b1b92b1787474385bd.tar.zst
mandoc-0c8f9a78c144e759fc8ce4b1b92b1787474385bd.zip
preserve comments before .Dd and .TH (typically Copyright and license)
in full HTML output, but not with -Ofragment, e.g. in man.cgi(8); suggested by Thomas Klausner <wiz at NetBSD>
Diffstat (limited to 'mandoc_html.3')
-rw-r--r--mandoc_html.320
1 files changed, 17 insertions, 3 deletions
diff --git a/mandoc_html.3 b/mandoc_html.3
index ba25e0ad..5e7bf607 100644
--- a/mandoc_html.3
+++ b/mandoc_html.3
@@ -1,6 +1,6 @@
-.\" $Id: mandoc_html.3,v 1.10 2017/07/15 17:57:51 schwarze Exp $
+.\" $Id: mandoc_html.3,v 1.11 2018/04/13 16:28:07 schwarze Exp $
.\"
-.\" Copyright (c) 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2014, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -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: July 15 2017 $
+.Dd $Mdocdate: April 13 2018 $
.Dt MANDOC_HTML 3
.Os
.Sh NAME
@@ -25,6 +25,8 @@
.Ft void
.Fn print_gen_decls "struct html *h"
.Ft void
+.Fn print_gen_comment "struct html *h" "struct roff_node *n"
+.Ft void
.Fn print_gen_head "struct html *h"
.Ft struct tag *
.Fo print_otag
@@ -109,6 +111,18 @@ and
declarations required for the current document type.
.Pp
The function
+.Fn print_gen_comment
+prints the leading comments, usually containing a Copyright notice
+and license, as an HTML comment.
+It is intended to be called right after opening the
+.Aq Ic HTML
+element.
+Pass the first
+.Dv ROFFT_COMMENT
+node in
+.Fa n .
+.Pp
+The function
.Fn print_gen_head
prints the opening
.Aq Ic META