Debian Codegraph @

upstream/debian-unstable/man1/sgml2latex.1

raw
1 .\" Process this file with
2 .\" groff -man -Tascii sgml2latex.1
3 .\"
4 .TH SGML2LATEX 1 "2025-04-06"
5 .SH NAME
6 sgml2latex \- create LaTeX, DVI, PostScript or PDF output from a LinuxDoc DTD
7 SGML source file
8 .SH SYNOPSIS
9 .B sgml2latex [generic-option...]
10 .BI [--output= tex | dvi | ps | pdf]
11 .B [--bibtex] [--makeindex]
12 .BI [--pagenumber= n ]
13 .B --quick
14 .BI [--latex= hlatexp | platex]
15 .BI [--dvips= dvips | dvi2ps]
16 .BI [--verbosity=n]
17 .IR file [.sgml]
18 .SH DESCRIPTION
19 .B sgml2latex
20 is an old and obsoleted form of the latex converter command
21 of LinuxDoc-Tools
22 (its name may be misleading, as it is not a tool for any SGML DTD, only
23 supports the SGML LinuxDoc DTD).
24 It is recommended to switch the new form
25 .B linuxdoc -B latex
26 now.
27 It converts a LinuxDoc DTD SGML source file to LaTeX output, using the
28 .BR nsgmls (1)
29 or
30 .BR onsgmls (1)
31 parser, and the
32 .BR sgmlsasp (1)
33 translator. Using the LaTeX output, and the
34 .BR latex (1)
35 text formatter, you can then create DVI output, and PostScript output
36 using the
37 .BR dvips (1)
38 converter. Output will appear in
39 .I file.tex
40 for LaTeX output,
41 .I file.dvi
42 for DVI output, or
43 .I file.ps
44 for PostScript output,
45 where
46 .I file
47 is the name of the SGML source file.
48 .LP
49 Using the LaTeX output, and the
50 .BR pdflatex (1)
51 text formatter, you can then create a nice PDF output, suitable for
52 viewing with PDF viewers as
53 .BR xpdf (1),
54 .BR acroread (1)
55 or
56 .BR ghostview (1).
57 .LP
58 The attribute/value pair "output=latex2e" is set for conditionals.
59 .SH OPTIONS
60 .B sgml2latex
61 accepts all the generic options described in
62 .BR linuxdoc (1),
63 and the following specific options:
64 .IP "--output=\fIfmt\fR, -o"
65 Specify the desired output format. The specifier
66 .I fmt
67 may be ``tex'', ``dvi'', ``ps'', or ``pdf''.
68 .PP
69 Note: This version does not overwrite/remove the intermediate
70 files: tex file for dvi output, or tex/dvi files for ps output.
71 This is different behavior from the original SGML-Tools 1.0.9,
72 so you are warned here.
73 .IP "--bibtex, -b"
74 Process the generated TeX with
75 .BR bibtex (1).
76 .IP "--makeindex, -m"
77 Generate a TeX index file suitable for processing with
78 .BR makeindex (1)
79 from and <idx> and <cdx> tags present in the SGML source.
80 .IP "--pagenumber, -n"
81 Set the starting page number in the output DVI or PS file.
82 .IP "--quick, -q"
83 Do only one pass of LaTeX formatting.
84 This is often not sufficient
85 to produce final output (because of references, etc.) but is useful
86 for spotting TeX errors and justification problems.
87 .IP "--pass, -P"
88 The argument of the pass option is inserted just after the LaTeX
89 preamble generated by the document-type tag.
90 Specify the desired output format.
91 The specifier
92 .I fmt
93 may be ``tex'', ``dvi'', ``ps'', or ``pdf''.
94 .IP "--latex=\fIalternate_latex_command\fR, -x"
95 This option is currently for Korean and Japanese.
96 The
97 .I alternate_latex_command
98 can be ``latex'' (default), ``hlatexp'' (for Korean), ``platex''
99 or ``jlatex'' (for Japanese).
100 This option can be used to render Korean document using HLaTeXp,
101 or to render Japanese document using pLaTeX/jLaTeX.
102 If not, HLaTeX should be installed to render Korean document.
103 On the other hand, Japanese document can be rendered with jLaTeX
104 (which is the default when ``\-c nippon'' is specified), so if you
105 already have jLaTeX, you may not need to install the pLaTeX.
106 .IP "--dvips=\fIalternate_dvips_command\fR, -s"
107 This option is currently for Japanese.
108 The
109 .I alternate_dvips_command
110 can be ``dvips'' or ``dvi2ps''.
111 If you don't know this, then
112 you may not need this.
113 .IP "--verbosity, -V"
114 Set verbosity.
115 \[aq]0\[aq] (default) will show info about LaTeX run only in case of errors.
116 \[aq]1\[aq] will always show info for last run.
117 \[aq]2\[aq] will show info for all runs.
118 .IP file
119 The SGML source file, named either
120 .I file
121 or
122 .I file.sgml
123 .SH FILES
124 Many files and executables in /usr/share/linuxdoc-tools and /usr/bin are used.
125 .SH BUGS
126 None known.
127 .SH AUTHOR
128 Originally written by
129 Greg Hankins <[email protected]>, based on scripts by Tom Gordon and
130 Alexander Horz.
131 Later rewritten by Cees de Groot <[email protected]>.
132 PDF patches by Juan Jose Amor <[email protected]>.
133 Previously maintained by Taketoshi Sano <[email protected]> for Linuxdoc-Tools.
134 Currently maintained by Agustin Martin <agustin6martin AT gmail com>.
135 .SH "SEE ALSO"
136 .BR linuxdoc (1),
137 .BR sgml2html (1),
138 .BR sgml2info (1),
139 .BR sgml2lyx (1),
140 .BR sgml2rtf (1),
141 .BR sgml2txt (1),
142 .BR sgmlcheck (1).