File indexing completed on 2024-11-24 04:34:43
0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 0002 <html> 0003 <!-- This document is an unofficial reference manual for LaTeX, a 0004 document preparation system, version of November 2018. 0005 0006 This manual was originally translated from LATEX.HLP v1.0a in the 0007 VMS Help Library. The pre-translation version was written by 0008 George D. Greenwade of Sam Houston State University. The 0009 LaTeX 2.09 version was written by Stephen Gilmore. The 0010 LaTeX2e version was adapted from this by Torsten Martinsen. Karl 0011 Berry made further updates and additions, and gratefully acknowledges 0012 using Hypertext Help with LaTeX, by Sheldon Green, and 0013 LaTeX Command Summary (for LaTeX 2.09) by 0014 L. Botway and C. Biemesderfer (published by the TeX Users 0015 Group as TeXniques number 10), as reference material. We also 0016 gratefully acknowledge additional material appearing in 0017 latex2e-reference by Martin Herbert Dietze. (From these references no 0018 text was directly copied.) 0019 0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 0021 2014, 2015, 2016, 2017, 2018 Karl Berry. 0022 0023 Copyright 1988, 1994, 2007 Stephen Gilmore. 0024 0025 Copyright 1994, 1995, 1996 Torsten Martinsen. 0026 0027 Permission is granted to make and distribute verbatim copies of 0028 this manual provided the copyright notice and this permission notice 0029 are preserved on all copies. 0030 0031 0032 Permission is granted to copy and distribute modified versions of this 0033 manual under the conditions for verbatim copying, provided that the entire 0034 resulting derived work is distributed under the terms of a permission 0035 notice identical to this one. 0036 0037 Permission is granted to copy and distribute translations of this manual 0038 into another language, under the above conditions for modified versions. --> 0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 0040 <head> 0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 0042 <title>Command line options (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="Command line options (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="Command line options (LaTeX2e unofficial reference manual (November 2018))"> 0046 <meta name="resource-type" content="document"> 0047 <meta name="distribution" content="global"> 0048 <meta name="Generator" content="makeinfo"> 0049 <link href="index.html#Top" rel="start" title="Top"> 0050 <link href="IndexDocument.html#Index" rel="index" title="Index"> 0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 0052 <link href="Command-line.html#Command-line" rel="up" title="Command line"> 0053 <link href="Command-line-input.html#Command-line-input" rel="next" title="Command line input"> 0054 <link href="Command-line.html#Command-line" rel="prev" title="Command line"> 0055 <style type="text/css"> 0056 <!-- 0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $ 0058 Minor css for latexrefman. Public domain. 0059 Originally written by Jim Hefferon and Karl Berry, 2018. */ 0060 0061 /* So you can style for yourself */ 0062 @import url("/css/latexreflocal.css"); 0063 0064 0065 0066 a.summary-letter {text-decoration: none} 0067 blockquote.indentedblock {margin-right: 0em} 0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 0069 blockquote.smallquotation {font-size: smaller} 0070 div.display {margin-left: 3.2em} 0071 div.example {margin-left: 3.2em} 0072 div.lisp {margin-left: 3.2em} 0073 div.smalldisplay {margin-left: 3.2em} 0074 div.smallexample {margin-left: 3.2em} 0075 div.smalllisp {margin-left: 3.2em} 0076 kbd {font-style: oblique} 0077 pre.display {font-family: inherit} 0078 pre.format {font-family: inherit} 0079 pre.menu-comment {font-family: serif} 0080 pre.menu-preformatted {font-family: serif} 0081 pre.smalldisplay {font-family: inherit; font-size: smaller} 0082 pre.smallexample {font-size: smaller} 0083 pre.smallformat {font-family: inherit; font-size: smaller} 0084 pre.smalllisp {font-size: smaller} 0085 span.nolinebreak {white-space: nowrap} 0086 span.roman {font-family: initial; font-weight: normal} 0087 span.sansserif {font-family: sans-serif; font-weight: normal} 0088 ul.no-bullet {list-style: none} 0089 BODY { 0090 margin-top: 1em; 0091 margin-left: 1em; /* auto results in two-digit <ol> lost off left */ 0092 margin-right: 1em; 0093 margin-bottom: 1em; 0094 /* the idea is to use the whole window, unless it is ridiculously 0095 wide, probably with too-small fonts, too. */ 0096 max-width: 64em; 0097 } 0098 0099 /* Because we want @math{... @code ...} to be upright, not slanted, 0100 and Texinfo won't fix it. */ 0101 code {font-style:normal; font-family:monospace; } 0102 0103 /* We put a link to our own home page at the bottom. */ 0104 div.referenceinfo {font-size:small;} 0105 0106 --> 0107 </style> 0108 0109 0110 </head> 0111 0112 <body lang="en"> 0113 <a name="Command-line-options"></a> 0114 <div class="header"> 0115 <p> 0116 Next: <a href="Command-line-input.html#Command-line-input" accesskey="n" rel="next">Command line input</a>, Up: <a href="Command-line.html#Command-line" accesskey="u" rel="up">Command line</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p> 0117 </div> 0118 <hr> 0119 <a name="Command-line-options-1"></a> 0120 <h3 class="section">28.1 Command line options</h3> 0121 0122 <a name="index-options_002c-command-line"></a> 0123 0124 <p>These are the command-line options relevant to ordinary document 0125 authoring. For a full list, try running ‘<samp>latex --help</samp>’ from the 0126 command line. 0127 </p> 0128 <p>With many implementations you can specify command line options by 0129 prefixing them with ‘<samp>-</samp>’ or ‘<samp>--</samp>’. This is the case for 0130 both TeX Live (and MacTeX) and MiKTeX. We will use both 0131 conventions interchangeably. 0132 </p> 0133 <dl compact="compact"> 0134 <dd><a name="index-_002d_002dversion-command_002dline-option"></a> 0135 </dd> 0136 <dt><code>-version</code></dt> 0137 <dd><p>Show the current version, like ‘<samp>pdfTeX 3.14159265-2.6-1.40.16 (TeX 0138 Live 2015/Debian)</samp>’ along with a small amount of additional information, 0139 and exit. 0140 </p> 0141 <a name="index-_002d_002dhelp-command_002dline-option"></a> 0142 </dd> 0143 <dt><code>-help</code></dt> 0144 <dd><p>Give a brief usage message that is useful as a prompt and exit. 0145 </p> 0146 <a name="index-_002d_002dinteraction-command_002dline-option"></a> 0147 </dd> 0148 <dt><code>-interaction=<var>mode</var></code></dt> 0149 <dd><p>TeX compiles a document in one of four interaction modes: 0150 <code>batchmode</code>, <code>nonstopmode</code>, <code>scrollmode</code>, 0151 <code>errorstopmode</code>. In <em>errorstop mode</em> (the default), TeX 0152 stops at each error and asks for user intervention. In <em>batch 0153 mode</em> it prints nothing on the terminal, errors are scrolled as if the 0154 user hit <code><return></code> at every error, and missing files cause the 0155 job to abort. In <em>nonstop mode</em>, diagnostic message appear on the 0156 terminal but as in batch mode there is no user interaction. In 0157 <em>scroll mode</em>, TeX only stops for missing files or keyboard 0158 input. 0159 </p> 0160 <p>For instance, starting LaTeX with this command line 0161 </p> 0162 <div class="example"> 0163 <pre class="example">pdflatex -interaction=batchmode <var>filename</var> 0164 </pre></div> 0165 0166 <p>eliminates most terminal output. 0167 </p> 0168 <a name="index-_002d_002djobname-command_002dline-option"></a> 0169 </dd> 0170 <dt><code>-jobname=<var>string</var></code></dt> 0171 <dd><p>Set the value of TeX’s <code>jobname</code> to the string. The log file 0172 and output file will then be named <samp><var>string</var>.log</samp> and 0173 <samp><var>string</var>.pdf</samp>. 0174 </p> 0175 <p>When you run <code><code>pdflatex</code> <var>options</var> <var>argument</var></code>, if 0176 <var>argument</var> does not start with a backslash then TeX considers it 0177 the name of a file to input. Otherwise it waits for the first 0178 <code>\input</code> instruction and the name of the input file will be the job 0179 name. This is used to name the log file the output file. The 0180 <code>jobname</code> option overrides that process and directly specifies the 0181 name. See <a href="Command-line-input.html#Command-line-input">Command line input</a> for an example of its use. 0182 </p> 0183 <a name="index-_002d_002doutput_002ddirectory-command_002dline-option"></a> 0184 </dd> 0185 <dt><code>-output-directory=<var>directory</var></code></dt> 0186 <dd><p>Write files in the directory <var>directory</var>. It must already exist. 0187 </p> 0188 <a name="index-_002d_002dshell_002descape-command_002dline-option"></a> 0189 <a name="index-_002d_002dno_002dshell_002descape-command_002dline-option"></a> 0190 <a name="index-_002d_002denable_002dwrite18-command_002dline-option"></a> 0191 <a name="index-_002d_002ddisable_002dwrite18-command_002dline-option"></a> 0192 </dd> 0193 <dt><code>--shell-escape</code></dt> 0194 <dt><code>--no-shell-escape</code></dt> 0195 <dt><code>--enable-write18</code></dt> 0196 <dt><code>--disable-write18</code></dt> 0197 <dd><p>Enable or disable <code>\write18{<var>shell_command</var>}</code> 0198 (see <a href="_005cwrite18.html#g_t_005cwrite18">\write18</a>). The first two options are for with TeX Live or 0199 MacTeX while the second two are for MiKTeX. 0200 </p> 0201 <a name="index-package_002c-sagetex"></a> 0202 <a name="index-sagetex-package"></a> 0203 0204 <p>Sometimes you want to run external system commands from inside a 0205 LaTeX file. For instance the package <samp>sagetex</samp> allows you to 0206 have the mathematics software system <i>Sage</i> do calculations or draw 0207 graphs and then incorporate that output in your document. For this 0208 TeX provides the <code>\write18</code> command. 0209 </p> 0210 <p>But with this functionality enabled, security issues could happen if you 0211 compiled a LaTeX file from the Internet. By default <code>\write18</code> 0212 is disabled. (More precisely, by default TeX Live, MacTeX, and 0213 MiKTeX only allow the execution of a limited number of TeX-related 0214 programs, which they distribute.) 0215 </p> 0216 <p>If you invoke LaTeX with the option <code>no-shell-escape</code>, and in 0217 your document you call <code>\write18{ls -l}</code>, then you do not get an 0218 error but the log file says ‘<samp>runsystem(ls -l)...disabled</samp>’. 0219 </p> 0220 <a name="index-_002d_002dhalt_002don_002derror-command_002dline-option"></a> 0221 </dd> 0222 <dt><code>-halt-on-error</code></dt> 0223 <dd><p>Stop processing at the first error. 0224 </p> 0225 <a name="index-_002d_002dfile_002dline_002derror-command_002dline-option"></a> 0226 <a name="index-_002d_002dno_002dfile_002dline_002derror-command_002dline-option"></a> 0227 </dd> 0228 <dt><code>-file-line-error</code></dt> 0229 <dt><code>-no-file-line-error</code></dt> 0230 <dd><p>Enable or disable <code><var>filename</var>:<var>lineno</var>:<var>error</var></code>-style 0231 error messages. These are only available with TeX Live or MacTeX. 0232 </p></dd> 0233 </dl> 0234 0235 0236 0237 0238 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0239 </body> 0240 </html>