Here are the description for each backend drivers:
****************************************************
linuxdoc-Bhtml (sgml2html) converts a LinuxDoc DTD SGML source file to HTML output. Output will
appear in the top level file file.html and file-n.html for each section (default action, but can be
changed by option), where file is the name of the SGML source file and n is the section name.
The attribute/value pair "output=html" is set for conditionals.
linuxdoc-Bhtml accepts the following options: [--split0|1|2][--dosnames][--imagebuttons][--toc0|1|2]
The meanings of them are:
--split, -s
What level to split source documents. 0 = don't split, 1 = split by major sections, 2 = split by
subsections.
--toc, -T
What level to generate toc.
0 = don't generate toc at all,
1 = includes major sections(/chapters/parts),
2 = includes subsections.
--dosnames, -h
Use ".htm" rather than ".html" as the extension of html files.
--imagebuttons, -I
Use the "next", "previous", and "contents" arrow image icons included in /usr/share/linuxdoc-tools
as navigation buttons.
--footer, -F
Use the specified file as the footer in each resulted html file. Default footer is just plain
</BODY>\n </HTML>\n
--header, -H
Use the specified file as the top part of the header in each resulted html file. Note this is not
the full part of the header. (i.e. the title and the links (next,previous,contents) in the de‐
fault header are retained. Default is
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\n
<HTML>\n <HEAD>\n
--rtldirection, -r
Set right-to-left direction in html file.
****************************************************
linuxdoc-Binfo (sgml2info) converts a LinuxDoc DTD SGML source file to GNU info format. Output will
appear in file.info where file is the name of the SGML source file.
The attribute/value pair "output=info" is set for conditionals.
linuxdoc-Binfo has not backend specific options.
****************************************************
linuxdoc-Blatex (sgml2latex) converts a LinuxDoc DTD SGML source file to LaTeX output, using the ns‐gmls(1) or onsgmls(1) parser, and the sgmlsasp(1) translator. Using the LaTeX output, and the latex(1)
text formatter, you can then create DVI output, and PostScript output using the dvips(1) converter. Out‐
put will appear in file.tex for LaTeX output, file.dvi for DVI output, or file.ps for PostScript output,
where file is the name of the SGML source file.
Using the LaTeX output, and the pdflatex(1) text formatter, you can then create a nice PDF output, suit‐
able for viewing with PDF viewers as xpdf(1), acroread(1) or ghostview(1).
The attribute/value pair "output=latex2e" is set for conditionals.
linuxdoc-Blatex accepts following backend specific options: [--output=tex|dvi|ps|pdf][--bibtex][--makeindex][--pagenumber=n]--quick[--latex=latex|hlatexp|platex|jlatex][--dvips=dvips|dvi2ps][--verbosity=n]
The meanings of them are:
--output=fmt, -o
Specify the desired output format. The specifier fmt may be ``tex'', ``dvi'', ``ps'', or ``pdf''.
Note: This version does not overwrite/remove the intermediate files: tex file for dvi output, or tex/dvi
files for ps output. This is different behavior from the original SGML-Tools 1.0.9, so you are warned
here.
--bibtex, -b
Process the generated TeX with bibtex(1).
--makeindex, -m
Generate a TeX index file suitable for processing with makeindex(1) from and <idx> and <cdx> tags
present in the SGML source.
--pagenumber, -n
Set the starting page number in the output DVI or PS file.
--quick, -q
Do only one pass of LaTeX formatting. This is often not sufficient to produce final output (be‐
cause of references, etc.) but is useful for spotting TeX errors and justification problems.
--pass, -P
The argument of the pass option is inserted just after the LaTeX preamble generated by the docu‐
ment-type tag. Specify the desired output format. The specifier fmt may be ``tex'', ``dvi'',
``ps'', or ``pdf''.
--latex=alternate_latex_command, -x
This option is currently for Korean and Japanese. The alternate_latex_command can be ``latex''
(default), ``hlatexp'' (for Korean), ``platex'' or ``jlatex'' (for Japanese). This option can be
used to render Korean document using HLaTeXp, or to render Japanese document using pLaTeX/jLaTeX.
If not, HLaTeX should be installed to render Korean document. On the other hand, Japanese docu‐
ment can be rendered with jLaTeX
(which is the default when ``-c nippon'' is specified), so if you already have jLaTeX, you may
not need to install the pLaTeX.
--dvips=alternate_dvips_command, -s
This option is currently for Japanese. The alternate_dvips_command can be ``dvips'' or
``dvi2ps''. If you don't know this, then you may not need this.
--verbosity, -V
Set verbosity. '0' (default) will show info about LaTeX run only in case of errors. '1' will al‐
ways show info for last run. '2' will show info for all runs.
****************************************************
linuxdoc-Blyx (sgml2lyx) converts a LinuxDoc DTD SGML source file to LyX output. Output will appear
in file.lyx where file is the name of the SGML source file.
The attribute/value pair "output=lyx" is set for conditionals.
linuxdoc-Blyx has not backend specific options.
****************************************************
linuxdoc-Brtf (sgml2rtf) converts a LinuxDoc DTD SGML source file to RTF, the Rich Text Tormat used by
the Microsoft Windows help system. Output will appear in the top level file file.rtf and file-n.rtf for
each section, where file is the name of the SGML source file. The RTF output is tailored for compilation
by the Windows Help Compiler (hc31.exe).
The attribute/value pair "output=rtf" is set for conditionals.
linuxdoc-Brtf accepts [--twosplit] as a backend specific option. Following is the meaning of this op‐
tion:
--twosplit, -2
Splits files both at n. sections and n.m. subsections
****************************************************
linuxdoc-Btxt (sgml2txt) converts a LinuxDoc DTD SGML source file to ASCII, ISO-8859-1, or EUC-JP out‐
put. Output will appear in file.txt where file is the name of the SGML source file.
The attribute/value pair "output=txt" is set for conditionals.
linuxdoc-Btxt accepts following backend-options: [--manpage][--filter][--blanks=n]
The meaning of these options are:
--manpage, -m
Outputs a groff source file, suitable for formatting with groff-man for man pages
--filter, -f
Remove backspace-overstrikes from the intermediate form generated by groff(1).
--pass, -P
The argument of the pass option is added to the command-line options handed to groff(1).
--blanks=n, -b
Set the limit of continuous blank lines for generating the output document. The default limit is
3. if 0 (zero) is specified, the result have many continuous blank lines.
****************************************************
linuxdoc-Bcheck (sgmlcheck) runs an SGML parse on the specified document source. Any errors are re‐
ported to standard output. No formatted version of the source is produced.
Note that linuxdoc-Bcheck preprocesses the LinuxDoc DTD SGML source, doing the conditionalization de‐
scribed by any <#if></#if> and <#unless></#unless> tags. Document sources containing these tags will
confuse a standalone SGML parser. linuxdoc-Bcheck has no backend-specific options.
****************************************************