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>\DeclareGraphicsRule (LaTeX2e unofficial reference manual (November 2018))</title>
0043 
0044 <meta name="description" content="\DeclareGraphicsRule (LaTeX2e unofficial reference manual (November 2018))">
0045 <meta name="keywords" content="\DeclareGraphicsRule (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="Graphics-package-configuration.html#Graphics-package-configuration" rel="up" title="Graphics package configuration">
0053 <link href="Commands-for-graphics.html#Commands-for-graphics" rel="next" title="Commands for graphics">
0054 <link href="_005cDeclareGraphicsExtensions.html#g_t_005cDeclareGraphicsExtensions" rel="prev" title="\DeclareGraphicsExtensions">
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="g_t_005cDeclareGraphicsRule"></a>
0114 <div class="header">
0115 <p>
0116 Previous: <a href="_005cDeclareGraphicsExtensions.html#g_t_005cDeclareGraphicsExtensions" accesskey="p" rel="prev">\DeclareGraphicsExtensions</a>, Up: <a href="Graphics-package-configuration.html#Graphics-package-configuration" accesskey="u" rel="up">Graphics package configuration</a> &nbsp; [<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="g_t_005cDeclareGraphicsRule-1"></a>
0120 <h4 class="subsection">22.2.3 <code>\DeclareGraphicsRule</code></h4>
0121 
0122 <a name="index-_005cDeclareGraphicsRule"></a>
0123 
0124 <p>Synopsis:
0125 </p>
0126 <div class="example">
0127 <pre class="example">\DeclareGraphicsRule{<var>extension</var>}{<var>type</var>}{<var>size-file extension</var>}{<var>command</var>}
0128 </pre></div>
0129 
0130 <p>Declare how to handle graphic files whose names end in <var>extension</var>.
0131 </p>
0132 <p>This example declares that all files with names have the form
0133 <samp>filename-without-dot.mps</samp> will be treated as output from MetaPost,
0134 meaning that the printer driver will use its MetaPost-handling code to
0135 input the file.
0136 </p>
0137 <div class="example">
0138 <pre class="example">\DeclareGraphicsRule{.mps}{mps}{.mps}{}
0139 </pre></div>
0140 
0141 <p>This
0142 </p>
0143 <div class="example">
0144 <pre class="example">\DeclareGraphicsRule{*}{mps}{*}{}
0145 </pre></div>
0146 
0147 <p>tells LaTeX that it should handle as MetaPost output any file with an
0148 extension not covered by another rule, so it covers <samp>filename.1</samp>,
0149 <samp>filename.2</samp>, etc.
0150 </p>
0151 <p>This describes the four arguments.
0152 </p>
0153 <dl compact="compact">
0154 <dt><var>extension</var></dt>
0155 <dd><p>The file extension to which this rule applies. The extension is anything
0156 after and including the first dot in the filename.  Use the Kleene star,
0157 <code>*</code>, to denote the default behaviour for all undeclared extensions.
0158 </p>
0159 </dd>
0160 <dt><var>type</var></dt>
0161 <dd><p>The type of file involved.  This type is a string that must be defined
0162 in the printer driver. For instance, files with extensions <samp>.ps</samp>,
0163 <samp>.eps</samp>, or <samp>.ps.gz</samp> may all be classed as type <code>eps</code>.
0164 All files of the same type will be input with the same internal command
0165 by the printer driver. For example, the file types that <samp>pdftex</samp>
0166 recognizes are: <code>jpg</code>, <code>jbig2</code>, <code>mps</code>, <code>pdf</code>,
0167 <code>png</code>, <code>tif</code>.
0168 </p>
0169 </dd>
0170 <dt><var>size-file extension</var></dt>
0171 <dd><p>The extension of the file to be read to determine the size of the
0172 graphic, if there is such a file. It may be the same as <var>extension</var>
0173 but it may be different.
0174 </p>
0175 <p>As an example, consider a PostScript graphic.  To make it smaller, it
0176 might be compressed into a <samp>.ps.gz</samp> file.  Compressed files are not
0177 easily read by LaTeX so you can put the bounding box information in a
0178 separate file. If <var>size-file extension</var> is empty then you must
0179 specify size information in the arguments of <code>\includegraphics</code>.
0180 </p>
0181 <p>If the driver file has a procedure for reading size files for
0182 <code>type</code> then that will be used, otherwise it will use the procedure
0183 for reading <samp>.eps</samp> files.  (Thus you may specify the size of bitmap
0184 files in a file with a PostScript style <code>%%BoundingBox</code> line if no
0185 other format is available.)
0186 </p>
0187 </dd>
0188 <dt><var>command</var></dt>
0189 <dd><p>A command that will be applied to the
0190 file. This is very often left blank. This command must start with a
0191 single backward quote.  Thus,
0192 <code>\DeclareGraphicsRule{.eps.gz}{eps}{.eps.bb}{`gunzip -c
0193 #1}</code> specifies that any file with the extension <samp>.eps.gz</samp> should
0194 be treated as an <code>eps</code> file, with the BoundingBox information
0195 stored in the file with extension <samp>.eps.bb</samp>, and that the command
0196 <code>gunzip -c</code> will run on your platform to decompresses the file.
0197 </p>
0198 <p>Such a command is specific to your platform.  In addition, your TeX
0199 system must allow you to run external commands; as a security measure
0200 modern systems restrict running commands unless you explicitly allow it.
0201 See the documentation for your TeX distribution.
0202 </p>
0203 </dd>
0204 </dl>
0205 
0206 
0207 
0208 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div>
0209 </body>
0210 </html>