summaryrefslogtreecommitdiff
path: root/web/noweb/src/xdoc/htmltoc.1
diff options
context:
space:
mode:
Diffstat (limited to 'web/noweb/src/xdoc/htmltoc.1')
-rw-r--r--web/noweb/src/xdoc/htmltoc.142
1 files changed, 42 insertions, 0 deletions
diff --git a/web/noweb/src/xdoc/htmltoc.1 b/web/noweb/src/xdoc/htmltoc.1
new file mode 100644
index 0000000000..60bf98a1ce
--- /dev/null
+++ b/web/noweb/src/xdoc/htmltoc.1
@@ -0,0 +1,42 @@
+.TH NOWEB 1 "local 10/40/2008"
+.SH NAME
+htmltoc \- add table of contents to HTML document
+.SH SYNOPSIS
+\fBhtmltoc\fP [\fB\-2345\fP] [file]
+.SH DESCRIPTION
+.I htmltoc
+adds a table of contents to the HTML document named on the command
+line or provided as standard input.
+The table of contents is inserted between
+.B <tableofcontents>
+and
+.B </tableofcontents>,
+which must appear on lines by themselves.
+Any text between those two markers is
+.I discarded.
+These markers are inserted automatically by the
+.IR sl2h (1)
+filter.
+.PP
+The table of contents includes only headers at levels 2, 3, 4, and 5.
+This can be changed by using a command-line
+option, e.g., \fB\-123456789\P to include all possible headers.
+.SH BUGS
+.I htmltoc
+can't cope with a header that is split across multiple lines,
+even though this is legal HTML.
+.SH SEE ALSO
+.IR nowebfilters (7),
+.IR sl2h (1)
+.SH VERSION
+This man page is from
+.I noweb
+version 2.12.
+.SH AUTHOR
+Norman Ramsey, Tufts University.
+Internet address \fBNorman.Ramsey@tufts.edu\fP.
+.br
+Noweb home page at \fBhttp://www.cs.tufts.edu/~nr/noweb\fP.
+
+.PP
+Stephen Parker provided a preliminary version.