Debian Codegraph @

upstream/fedora-44/man1/sgml2latex.1

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