Options of the Tralics program
Tralics knows about many options, that start with a single or
double hyphen. Some options take an argument, that is placed just after the
option, the syntax option=argument, without spaces is allowed. You can also
use spaces (option, space, equals, space, argument). Some options
are marked 'Raweb mode', they are meaningful only for the raweb, and have been
removed in version 2.13.
They are the following, in alphabetic order:
- -all
- [Raweb mode]
Is the same as -xml -xmlfo -xmlhtml -xmltex -xmllint.
- -check
- [Raweb mode]
This checks the syntax, but produces nothing (no XML, no LaTeX).
Does nothing outside Raweb mode.
- -confdir=prefix
- This is a prefix for an alternate location of
tcf, ult, plt, and clt
files. More than one prefix can be given, all will be used (latest first).
Since version 2.11.4, the configuration file .tralics_rc
is searched in this list, if not found in the current directory.
- -config=FILE
- Use FILE instead of default configuration file.
This can be an absolute or relative pathname.
- -configfile=FILE
- Same as -config=FILE.
- -config_file=FILE
- Same as -config=FILE.
- -default_class=CLASS
- . Assume that you compile a file
that has \documentclass{foo}; in this case, Tralics
tries to read the file foo.clt. No error is signaled if the file
cannot be opened. If you call Tralics with option
-default_class=bar, then bar.clt is loaded in the case
foo.clt does not exists; the command \CurrentClass
will hold the name of the document class (here foo), so that bar.clt knows
how it was called.
- -dir=RADIR
- This option is ignored sincer version 2.13.
This explains that RADIR is the directory
containing lots of stuff for the Raweb mode. In particular, it contains
a subdirectory confdir with the configuration file.
If this option is not used, the value of the shell
variable TRALICSDIR will be used instead.
- -distinguish_refer_in_rabib=true/false
-
This indicates whether, for the raweb, the refer bibliography database
should be considered a normal file, or a subfile for the year database.
Values other than yes, no, true, false, are ignored. Default is yes.
Details are explained in section 2.8 Bibliography.
- -doctype=A-B
-
This specifies the DOCTYPE of the
resulting XML document. Here A is the name of the root element, B is the
DTD file, these two names are separated by a space or a dash.
- -entnames=yes/no
-
This tells Tralics to put α
or α in the XML output. If entity names are
used, the resulting XML file can be used only if the DTD explains how they are
defined. Since version 2.9, this option applies only to math characters, that
are described in the MathMM DTD.
- -etex
- This option enables e-TeX extensions.
Options are enabled by default.
- -external_prog=XXX
- [Raweb mode].
In this case XXX will be used instead of `rahandler.pl' as interpreter
for the raweb
actions defined by the xmlXXX switches. The underscore in the name is optional.
- -hacknotitle
- If you give this option, Tralics
may replace \section{} by \section{Introduction}.
This is implied in raweb mode until 2006. The option was withdrawn in 2007:
using it has no effect on the translation.
- -find_words
- The list of all
words of the XML tree will be printed on the file words, after translation
is complete. The underscore in the name is optional.
- -help
- The list of options are printed, and the program stops.
- -input_dir = DIR
- Specifies where source files are to be
found. This is a colon separated list of directories; current directory is
defined by an empty slot, or a single dot. It will be added to the end of
the list, unless present.
- -input_path = DIR
- Same as input-dir
- -input_file = FILE
- This tells Tralics to compile
file FILE (tex suffix added if needed)
- -interactivebib
- Withdrawn option.
- -interactivemath
- Special interactive mode,
in which characters are read from the terminal, instead a file,
and math formulas are printed on the screen.
- -latin1
- This option means that files are by default encoded
in iso-8859-1 mode (if the first line of the file contains `utf8-encoded' it
is read in UTF-8 mode).
- -leftquote=xxx
- Defines translation of left quote (or backquote);
see below under rightquote.
- -log_file = FILE
- This tells Tralics to put all messages
and warnings in
FILE (extension .log added if not given). Uses output_dir
- -math_variant
-
If you say -math_variant then $\mathfrak B$
translates into
<mi mathvariant='fraktur' >B</mi>.
If you say -no_math_variant then $\mathcal A$
translates into <mi>𝒜</mi>
or <mi>𝒜</mi>.
Before version 2.9.4, the result depended on the
font. The default is to use Unicode characters rather than attributes.
- -nobibyearerror
- Useful in Raweb mode only. No error is
signaled if you cite a paper of year X in year Y when X and Y are not the same.
This option has been withdrawn in version 2.13.3.
- -nobibyearmodify
- Useful in Raweb mode only. No modification
done if an entry is in the refer section instead of being in the year section.
Details are explained in section 2.8 Bibliography. This option has been withdrawn in version 2.13.3.
- -noconfig
- No configuration file will be used.
- -noentnames
- This is the same as entnames='no'
This tells Tralics to put α
rather than α in the XML output. See option
entnames above.
- -noetex
- This option disables e-TeX extensions.
Options are enabled by default.
- -no_float_hack
- This option disables the postprocessor for
tables and figures.
- -nomathml
- Math formulas are output à la TeX, rather than using
MathML. This is the same as using \@nomathml=-1
in the document.
- -no_math_variant
-
This is the converse of math_variant
described above.
- -notrivialmath
- Inhibits trivial math hacks; see option
trivialmath below. Sincer version 2.8.5, this is the default.
- -noundefmac
- If you issue this option, all commands will
be magically defined after the first error message saying that the command
is undefined.
- -nostraightquotes
- If you issue this option, the apostrophe
translates into character U+B4, as \textasciiacute. However,
the normal value is used in verbatim mode, when reading a file name, in an
URL, or in a construct like \char`\'.
- -noxmlerror
- This option inhibits creation of
<error/> elements in case of error.
These elements can be useful for
debugging, since they indicate the current position in the tree; on the
other hand, they could generate a second error, of the form: text expected
instead of element.
- -nozerowidthelt
- In order to inhibit ligatures when converting XML
to Pdf some action is required: a special character (zero width space) is
added. This character appears sometimes as a normal-width-space. As a
consequence, the <zws/> is used (and the style
sheet that converts XML to HTML can ignore this element); If this switch is
used, character entity #x200B; is used instead of an
element.
- -nozerowidthspace
- Translation of \verb=--= is
<hi rend='tt'>-​-​</hi>.
The ZeroWidthSpace character (or some element, see above)
is added so that, in case the XML file is
interpreted by a software like TeX, no en-dash ligature is created.
This behavior is inhibited by the switch.
- -oe8, -oe1, -oe8a, -oe1a
- This specifies output encoding, one of
UTF8 or latin1. Interpretation of the XML file is independent of the
encoding. If the letter a is given, then all non-7 bits characters are
printed as character references. Thus, the only difference between
option e8a and oe1a is the XML header line. Defaut encoding is oe1.
- -output_dir = DIR
- Specifies where output files are to be stored
(this concerns the main XML file, the transcript file, and other files).
- -output_file = FILE
- This tells Tralics to put the result in
FILE (extension .xml added if not given). In the case of the raweb,
this option is ignored.
- -param=FOO=BAR
- The effect is the same as if FOO="BAR" were in
the configuration file, after all other values. Syntax is a bit special:
both equal signs can be replaced by a space.
- -ps
- [Raweb mode]
This checks the syntax, creates a TeX file instead of
XML, and calls an external program to convert the TeX into PostScript.
Does nothing outside Raweb mode.
- -radebug
- [Raweb mode]
This option tells the Raweb checker to continue checking after the first
error instead of stopping immediately; note that the translator is not called
if the Raweb checker sees an error.
- -raw-bib
- If this option is givem, Tralics considers all
bibtex entry types alike. Otherwise, it may ignore irrelevant fields
(for instance, editor for a phdthesis).
- -rightquote=xxx
- Defines translation of right quote
(or apostrophe). Characters `(left quote) and ' (right quote) must have
category code 12 (other) otherwise some constructions fail. In verbatim mode,
(as well as in Urls) these characters behave normally; if doubled
translation is U+201C and U+201D (“ and ”). Otherwise
you can change. If you say -leftquote=2018 and
-rightquote=2019 then characters U+2018 and U+2019 are used
(‘ and ’). Only base16 digits are allowed; the value should
be a number between 1 and 2^16 (otherwise default value is used).
- -shell-escape
- If you issue this command,
\write18{pwd} will execute the `pwd' command.
- -silent
- This makes Tralics less verbose (prints the title
of a `div0' instead of `div0' or `div1'; prints less statistics; omits image
info).
- -te8, -te1, -te8a, -te1a
- This specifies encoding used in
transcript files. In the case of te8 or te8a, characters are printed using
UTF-8 format; in the case of te1 ot te1a, characters are printed using latin1
encoding. Characters are printed using the ^^^^abcd notation in case:
the value if greater than 255, and one of -te8a, -te1a is given, or
the character is not in proper range (32-126 plus 160-155) and te1 is given,
the character is smaller then 32. Note: horizontal tabulation, line-feed and
carriage return do not use the ^^ notation.
- -tpa_status=XX
- This flags controls what is to be translated if
the configuration file specifies a titlepage
(see description). If the value is `all', then
the whole document is translated; if the value is `title', only the titlepage
is translated; if the value is `config', action depends on the configuration
file (details can be found
here).
Otherwise, translation stops in case of an error, continues otherwise.
Only the first character of the value is tested. Capital letters are allowed.
- -trivialmath=N
-
This sets the counter notrivialmath to N.
If N is 7, Tralics replaces
$12^{th}$ by 12\textsuperscript{th}, and handles
formulas like $x$ as `trivial math' formulas. Translation is
<formula type='inline'>
<simplemath>x</simplemath> </formula> instead of a more
complicated MathML expression. No MathML expression is created in
the case of $\alpha$ or $_{foo}$.
Default value of the counter is 1.
- -type=FOO
- Uses FOO instead of the \documentclass value
for the document type. If you say `tralics -type ra hello',
this will read the ra.tcf file, and you will
enter Raweb mode, and this is wrong because the name of the file contains
no year. If you say `tralics -type article miaou2003', you are not
in Raweb mode, the preprocessor is not called, and 157 strange errors are
signaled because of different reasons. If you say `tralics -type ra
miaou2007', the compilation will fail because ra.tcf was
designed for year 2006 and ra2007.tcf should be used instead.
If you say `tralics -type ra2007 miaou2003', compilation fails
because the tcf file contains an instruction declaring
\declaretopics to be ignored, and this declaration is declared
illegal by the raweb checker.
- -usequotes
- This option converts double quotes into a pair of
single quotes,
either left quotes, or right quotes.
- -utf8
- This option means that files are by default encoded
in UTF-8 mode (if the first line of the file contains `iso-8859-1' it
is read in latin1 mode).
- -utf8output
- Same as option -oe8 plus -te8.
- -verbose, -v
- This makes Tralics more verbose. In particular,
you will see how Tralics determines the DTD. It executes
\tracingall (in the example of miaou, this prints 9233 lines
instead of 142 in the transcript file).
- -verbose-doc, -V
- The effect of this switch is to execute
\tracingall when \begin{document} is seen; this is
like the verbose switch, but you won't see all details of classes and
packages.
- -version
- Version number is printed; program stops.
- -xml
- [Raweb mode]
This option asks Tralics to convert the TeX
source into an XML result. Is incompatible with options -check or -ps.
Is selected, when compiling the Raweb, if neither -ps nor -check is given.
- -xmlall
- [Raweb mode]
Is the same as -xml -xmlfo -xmlhtml -xmltex -xmllint.
- -xmlfo
- [Raweb mode]
This asks for the creation, via an external program,
of a xsl-fo file. It implies the -xml option. Is meaningful only in Raweb
mode, where an external program is launched.
- -xmlhtml
- [Raweb mode]
This asks for the creation, via an external program, of a set of HTML files.
It implies the -xml option. Is meaningful only in Raweb
mode, where an external program is launched.
- -xmllint
- [Raweb mode]
This checks, via an external program, the validity of the XML against the DTD.
It implies the -xml option. Is meaningful only in Raweb mode, where
an external program is launched.
- -xmltex
- [Raweb mode]
This asks for the conversion, via an external program, of the xsl-fo file to
a Pdf file. Implies -xml and -xmlfo. Is meaningful only in Raweb mode, where
an external program is launched.
- -year=XXXX
-
This sets the RA year to XXXX, and disallows compilation of the Raweb for
other years. Inside the TeX document, you can access to XXXX via the command
ra@year.
If the command is omitted, the RA year is either extracted from the file name
(Raweb case) or a default year is used (for this purpose year 2005 starts at
May, 1st, because people start writing the Raweb2004 in September 2004, and
everything should be finished by March 2005).
back to home page
© INRIA 2004, 2006
Last modified $Date: 2008/12/05 18:35:46 $