summaryrefslogtreecommitdiffstats
path: root/man2html/man2html.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2014-09-18 19:44:23 -0700
committerKaz Kylheku <kaz@kylheku.com>2014-09-18 19:44:23 -0700
commite219764e7fff79f53c25ef9d7d9c3bb94c5a2fee (patch)
tree9eaca2b6f9d972ec97b03531a4c49c127c420b2b /man2html/man2html.1
parente9ba652c80e911013ddc3dd5972654d680cc1a7e (diff)
downloadman-e219764e7fff79f53c25ef9d7d9c3bb94c5a2fee.tar.gz
man-e219764e7fff79f53c25ef9d7d9c3bb94c5a2fee.tar.bz2
man-e219764e7fff79f53c25ef9d7d9c3bb94c5a2fee.zip
Implementing M2 register and .M2SS extension.
Updating date of the man page and documenting extensions. Changing .ab request to exit unsuccessfully. Index generation needed to be trivially extended to handle more than two levels.
Diffstat (limited to 'man2html/man2html.1')
-rw-r--r--man2html/man2html.116
1 files changed, 15 insertions, 1 deletions
diff --git a/man2html/man2html.1 b/man2html/man2html.1
index c1c25b3..089edf4 100644
--- a/man2html/man2html.1
+++ b/man2html/man2html.1
@@ -1,8 +1,9 @@
'\" t
.\" Man page for man2html
.\" aeb, 980101
+.\" kk, 140918
.\"
-.TH man2html 1 "1 January 1998"
+.TH man2html 1 "September 2014"
.LO 1
.SH NAME
man2html \- format a manual page in html
@@ -135,6 +136,19 @@ man2html -H $SERVER_NAME
if the variable SERVER_NAME is set. This would allow your machine
to act as a server and export man pages.
+.SH EXTENSIONS
+To test whether troff code is being processed by
+.BR man2html ,
+use the register \f[CO]\en[M2]\f[P]. This is defined and has a nonzero
+value.
+
+The request ".M2SS level tag datum" can be used to emit a custom
+section header which is indexed, where level is the index level of
+the section, tag is the HTML tag without the angle brackets, for instance H4.
+The datum is the heading to be indexed and emitted into the HTML output.
+The standard .SH and .SS requests use levels 0 and 1, respectively,
+and HTML tags H2 and H3, respectively.
+
.SH BUGS
There are many heuristics. The output will not always be perfect.
The lynxcgi method will not work if lynx was compiled without