Viewing File: /usr/share/doc/texinfo/html/_0040exampleindent.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>@exampleindent (GNU Texinfo 6.7)</title>

<meta name="description" content="@exampleindent (GNU Texinfo 6.7)">
<meta name="keywords" content="@exampleindent (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Global-Document-Commands.html" rel="up" title="Global Document Commands">
<link href="Ending-a-File.html" rel="next" title="Ending a File">
<link href="_0040firstparagraphindent.html" rel="prev" title="@firstparagraphindent">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="g_t_0040exampleindent"></span><div class="header">
<p>
Previous: <a href="_0040firstparagraphindent.html" accesskey="p" rel="prev"><code>@firstparagraphindent</code></a>, Up: <a href="Global-Document-Commands.html" accesskey="u" rel="up">Global Document Commands</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="g_t_0040exampleindent_003a-Environment-Indenting"></span><h4 class="subsection">3.7.6 <code>@exampleindent</code>: Environment Indenting</h4>

<span id="exampleindent"></span><span id="index-exampleindent"></span>
<span id="index-Indenting-environments"></span>
<span id="index-Environment-indentation"></span>
<span id="index-Example-indentation"></span>

<p>The Texinfo processors indent each line of <code>@example</code> and similar
environments.  You can use the <code>@exampleindent</code> command to specify
this indentation.  Write an <code>@exampleindent</code> command at the
beginning of a line followed by either &lsquo;<samp>asis</samp>&rsquo; or a number:
</p>
<div class="example">
<pre class="example">@exampleindent <var>indent</var>
</pre></div>

<p>The indentation is according to the value of <var>indent</var>:
</p>
<dl compact="compact">
<dt><code>asis</code></dt>
<dd><p>Do not change the existing indentation (not implemented in TeX).
</p>
</dd>
<dt>0</dt>
<dd><p>Omit all indentation.
</p>
</dd>
<dt><var>n</var></dt>
<dd><p>Indent environments by <var>n</var> space characters in Info output, by
<var>n</var> ems in TeX.
</p>
</dd>
</dl>

<p>The default value of <var>indent</var> is 5 spaces in Info, and 0.4in
in TeX, which is somewhat less.  (The reduction is to help TeX
fit more characters onto physical lines.)
</p>
<p>It is best to write the <code>@exampleindent</code> command before the
end-of-header line at the beginning of a Texinfo file, so the region
formatting commands indent paragraphs as specified.  See <a href="Start-of-Header.html">Start of Header</a>.
</p>




</body>
</html>
Back to Directory File Manager