Viewing File: /usr/share/doc/texinfo/html/texinfo_002dformat-commands.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>texinfo-format commands (GNU Texinfo 6.7)</title>

<meta name="description" content="texinfo-format commands (GNU Texinfo 6.7)">
<meta name="keywords" content="texinfo-format commands (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="Creating-an-Info-File.html" rel="up" title="Creating an Info File">
<link href="Batch-Formatting.html" rel="next" title="Batch Formatting">
<link href="makeinfo-in-Emacs.html" rel="prev" title="makeinfo in Emacs">
<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="texinfo_002dformat-commands"></span><div class="header">
<p>
Next: <a href="Batch-Formatting.html" accesskey="n" rel="next">Batch Formatting</a>, Previous: <a href="makeinfo-in-Emacs.html" accesskey="p" rel="prev"><code>makeinfo</code> in Emacs</a>, Up: <a href="Creating-an-Info-File.html" accesskey="u" rel="up">Creating an Info File</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="The-texinfo_002dformat_2026-Commands"></span><h4 class="subsection">21.1.3 The <code>texinfo-format&hellip;</code> Commands</h4>


<p>In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo
file with the <code>texinfo-format-region</code> command.  This formats the
current region and displays the formatted text in a temporary buffer
called &lsquo;<samp>*Info Region*</samp>&rsquo;.
</p>
<p>Similarly, you can format a buffer with the
<code>texinfo-format-buffer</code> command.  This command creates a new
buffer and generates the Info file in it.  Typing <kbd>C-x C-s</kbd> will
save the Info file under the name specified by the
<code>@setfilename</code> line which must be near the beginning of the
Texinfo file.
</p>
<dl compact="compact">
<dt><kbd>C-c C-e C-r</kbd></dt>
<dt><kbd><code>texinfo-format-region</code></kbd></dt>
<dd><span id="index-texinfo_002dformat_002dregion"></span>
<p>Format the current region for Info.
</p>
</dd>
<dt><kbd>C-c C-e C-b</kbd></dt>
<dt><kbd><code>texinfo-format-buffer</code></kbd></dt>
<dd><span id="index-texinfo_002dformat_002dbuffer"></span>
<p>Format the current buffer for Info.
</p></dd>
</dl>

<p>The <code>texinfo-format-region</code> and <code>texinfo-format-buffer</code>
commands provide you with some error checking, and other functions can
provide you with further help in finding formatting errors.  These
procedures are described in an appendix; see <a href="Catching-Mistakes.html">Catching Mistakes</a>.
However, the <code>makeinfo</code> program provides better error checking
(see <a href="makeinfo-in-Emacs.html"><code>makeinfo</code> in Emacs</a>).
</p>
<p>A peculiarity of the <code>texinfo-format-buffer</code> and
<code>texinfo-format-region</code> commands is that they do not indent (nor
fill) paragraphs that contain <code>@w</code> or <code>@*</code> commands.
</p>




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