Blame man/sgml2latex.1

Packit 9741aa
.\" Process this file with
Packit 9741aa
.\" groff -man -Tascii sgml2latex.1
Packit 9741aa
.\"
Packit 9741aa
.TH SGML2LATEX 1 "18 May 2000"
Packit 9741aa
.SH NAME
Packit 9741aa
sgml2latex \- create LaTeX, DVI, PostScript or PDF output from a LinuxDoc DTD
Packit 9741aa
SGML source file 
Packit 9741aa
.SH SYNOPSIS
Packit 9741aa
.B sgml2latex [generic-option...] 
Packit 9741aa
.BI [--output= tex | dvi | ps | pdf]
Packit 9741aa
.B [--bibtex] [--makeindex] 
Packit 9741aa
.BI [--pagenumber= n ]
Packit 9741aa
.B --quick
Packit 9741aa
.BI [--latex= hlatexp | platex]
Packit 9741aa
.BI [--dvips= dvips | dvi2ps]
Packit 9741aa
.IR file [.sgml]
Packit 9741aa
.SH DESCRIPTION
Packit 9741aa
.B sgml2latex
Packit 9741aa
is an old and obsoleted form of the latex converter command
Packit 9741aa
of LinuxDoc-Tools.  It is recommended to switch the new form
Packit 9741aa
.B linuxdoc -B latex
Packit 9741aa
now.
Packit 9741aa
It converts a LinuxDoc DTD SGML source file to LaTeX output, using the
Packit 9741aa
.BR nsgmls (1)
Packit 9741aa
or 
Packit 9741aa
.BR onsgmls (1)
Packit 9741aa
parser, and the
Packit 9741aa
.BR sgmlsasp (1)
Packit 9741aa
translator.  Using the LaTeX output, and the
Packit 9741aa
.BR latex (1)
Packit 9741aa
text formatter, you can then create DVI output, and PostScript output
Packit 9741aa
using the 
Packit 9741aa
.BR dvips (1)
Packit 9741aa
converter. Output will appear in
Packit 9741aa
.I file.tex
Packit 9741aa
for LaTeX output, 
Packit 9741aa
.I file.dvi
Packit 9741aa
for DVI output, or
Packit 9741aa
.I file.ps
Packit 9741aa
for PostScript output,
Packit 9741aa
where 
Packit 9741aa
.I file
Packit 9741aa
is the name of the SGML source file.
Packit 9741aa
.LP
Packit 9741aa
Using  the LaTeX output, and the
Packit 9741aa
.BR pdflatex (1)
Packit 9741aa
text formatter, you can then create a nice PDF output, suitable for
Packit 9741aa
viewing with PDF viewers as
Packit 9741aa
.BR xpdf (1),
Packit 9741aa
.BR acroread (1)
Packit 9741aa
or
Packit 9741aa
.BR ghostview (1).
Packit 9741aa
.LP
Packit 9741aa
The attribute/value pair "output=latex2e" is set for conditionals.
Packit 9741aa
.SH OPTIONS
Packit 9741aa
.B sgml2latex
Packit 9741aa
accepts all the generic options described in
Packit 9741aa
.BR linuxdoc (1), 
Packit 9741aa
and the following specific options:
Packit 9741aa
.IP "--output=\fIfmt\fR, -o"
Packit 9741aa
Specify the desired output format.  The specifier 
Packit 9741aa
.I fmt
Packit 9741aa
may be ``tex'', ``dvi'', ``ps'', or ``pdf''. 
Packit 9741aa
.PP
Packit 9741aa
Note: This version does not overwrite/remove the intermediate
Packit 9741aa
files: tex file for dvi output, or tex/dvi files for ps output.
Packit 9741aa
This is different behavior from the original SGML-Tools 1.0.9, 
Packit 9741aa
so you are warned here.
Packit 9741aa
.IP "--bibtex, -b"
Packit 9741aa
Process the generated TeX with 
Packit 9741aa
.BR bibtex (1).
Packit 9741aa
.IP "--makeindex, -m"
Packit 9741aa
Generate a TeX index file suitable for processing with 
Packit 9741aa
.BR makeindex (1)
Packit 9741aa
from and <idx> and <cdx> tags present in the SGML source.
Packit 9741aa
.IP "--pagenumber, -n"
Packit 9741aa
Set the starting page number in the output DVI or PS file.
Packit 9741aa
.IP "--quick, -q"
Packit 9741aa
Do only one pass of LaTeX formatting.  This is often not sufficient 
Packit 9741aa
to produce final output (because of references, etc.) but is useful
Packit 9741aa
for spotting TeX errors and justification problems.
Packit 9741aa
.IP "--pass, -P"
Packit 9741aa
The argument of the pass option is inserted just after the LaTeX 
Packit 9741aa
preamble generated by the document-type tag.
Packit 9741aa
Specify the desired output format.  The specifier 
Packit 9741aa
.I fmt
Packit 9741aa
may be ``tex'', ``dvi'', ``ps'', or ``pdf''. 
Packit 9741aa
.IP "--latex=\fIalternate_latex_command\fR, -x"
Packit 9741aa
This option is currently for Korean and Japanese.
Packit 9741aa
The
Packit 9741aa
.I alternate_latex_command
Packit 9741aa
can be ``latex'' (default), ``hlatexp'' (for Korean), ``platex''
Packit 9741aa
or ``jlatex'' (for Japanese). 
Packit 9741aa
This option can be used to render Korean document using HLaTeXp,
Packit 9741aa
or to render Japanese document using pLaTeX/jLaTeX.
Packit 9741aa
If not, HLaTeX should be installed to render Korean document.
Packit 9741aa
On the other hand, Japanese document can be rendered with jLaTeX
Packit 9741aa
 (which is the default when ``\-c nippon'' is specified), so if you 
Packit 9741aa
already have jLaTeX, you may not need to install the pLaTeX.
Packit 9741aa
.IP "--dvips=\fIalternate_dvips_command\fR, -s"
Packit 9741aa
This option is currently for Japanese.
Packit 9741aa
The
Packit 9741aa
.I alternate_dvips_command
Packit 9741aa
can be ``dvips'' or ``dvi2ps''.  If you don't know this, then
Packit 9741aa
you may not need this.
Packit 9741aa
.IP file
Packit 9741aa
The SGML source file, named either 
Packit 9741aa
.I file
Packit 9741aa
or 
Packit 9741aa
.I file.sgml
Packit 9741aa
.SH FILES
Packit 9741aa
Many files and executables in $LINUXDOCLIB and $LINUXDOCBIN are used. 
Packit 9741aa
.SH BUGS
Packit 9741aa
None known.
Packit 9741aa
.SH AUTHOR
Packit 9741aa
Originally written by
Packit 9741aa
Greg Hankins <greg.hankins@cc.gatech.edu>, based on scripts by Tom Gordon and
Packit 9741aa
Alexander Horz. Later rewritten by Cees de Groot <cg@cdegroot.com>.
Packit 9741aa
PDF patches by Juan Jose Amor <jjamor@hispalinux.es>.
Packit 9741aa
Currently maintained by Taketoshi Sano <sano@debian.org> for Linuxdoc-Tools.
Packit 9741aa
.SH "SEE ALSO"
Packit 9741aa
.BR linuxdoc (1),
Packit 9741aa
.BR sgml2html (1),
Packit 9741aa
.BR sgml2info (1),
Packit 9741aa
.BR sgml2lyx (1), 
Packit 9741aa
.BR sgml2rtf (1), 
Packit 9741aa
.BR sgml2txt (1),
Packit 9741aa
.BR sgmlcheck (1).