Debian Codegraph @

upstream/debian-unstable/man1/sgml2html.1

raw
1 .\" Process this file with
2 .\" groff -man -Tascii sgml2html.1
3 .\"
4 .TH SGML2HTML 1 "2025-04-06"
5 .SH NAME
6 sgml2html \- create HTML output from a LinuxDoc DTD SGML source file
7 .SH SYNOPSIS
8 .B sgml2html [generic-option...] [--split
9 .I 0|1|2
10 .B ] [--toc
11 .I 0|1|2
12 .B ] [--dosnames] [--imagebuttons]
13 .IR file [.sgml]
14 .SH DESCRIPTION
15 .B sgml2html
16 is an old and obsoleted form of the html converter command
17 of LinuxDoc-Tools
18 (its name may be misleading, as it is not a tool for any SGML DTD, only
19 supports the SGML LinuxDoc DTD).
20 It is recommended to switch the new form
21 .B linuxdoc -B html
22 now.
23 This converts a LinuxDoc DTD SGML source file to HTML output.
24 Output will appear in the top level file
25 .I file.html
26 and
27 .I file-n.html
28 for each section, where
29 .I file
30 is the name of the SGML source file and
31 .I n
32 is the section name.
33 .LP
34 The attribute/value pair "output=html" is set for conditionals.
35 .SH OPTIONS
36 .B sgml2html accepts all the generic options described in
37 .BR linuxdoc (1),
38 and the following specific options:
39 .IP "--split, -s"
40 What level to split source documents.
41 0 = don't split, 1 = split by
42 major sections, 2 = split by subsections.
43 .IP "--toc, -T"
44 What level to generate toc.
45 0 = don't generate toc at all,
46 1 = includes major sections(/chapters/parts),
47 2 = includes subsections.
48 .IP "--dosnames, -h"
49 Use ".htm" rather than ".html" as the extension of
50 .IP "--imagebuttons, -I"
51 Use the "next", "previous", and "contents" arrow image icons included
52 in /usr/share/linuxdoc-tools as navigation buttons.
53 .IP "--footer, -F"
54 Use the specified file as the footer in each resulted html file.
55 Default footer is just plain
56
57 .nh
58 .nf
59 .ad l
60 </BODY>\\n </HTML>\\n
61 .hy
62 .fi
63 .IP "--header, -H"
64 Use the specified file as the top part of the header in each resulted
65 html file.
66 Note that this is not the full part of the header,
67 i.e., the title and the links (next,previous,contents) in the default
68 header are retained.
69 Default is
70
71 .nh
72 .nf
73 .ad l
74 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\\n
75 <HTML>\\n <HEAD>\\n
76 .hy
77 .fi
78 .IP file
79 The SGML source file, named either
80 .I file
81 or
82 .IR file.sgml .
83 .SH FILES
84 Many files and executables in /usr/share/linuxdoc-tools and /usr/bin are used.
85 .SH BUGS
86 None known.
87 .SH AUTHOR
88 Originally written by Greg Hankins <[email protected]>, and
89 Cees de Groot <[email protected]> for SGML-Tools (v1) and maintained by
90 Taketoshi Sano <[email protected]> for Linuxdoc-Tools.
91 Currently maintained by Agustin Martin <agustin6martin AT gmail com>.
92 .SH "SEE ALSO"
93 .BR linuxdoc (1),
94 .BR sgml2info (1),
95 .BR sgml2latex (1),
96 .BR sgml2lyx (1),
97 .BR sgml2rtf (1),
98 .BR sgml2txt (1),
99 .BR sgmlcheck (1).