blob: b2bbf0917e3cdb61f96f73fb99a52ce819e93e1a [file] [log] [blame]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 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". -->
<title>Info Formatting (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Info Formatting (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Info Formatting (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<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="Texinfo-Mode.html" rel="up" title="Texinfo Mode">
<link href="Printing.html" rel="next" title="Printing">
<link href="Updating-Nodes-and-Menus.html" rel="prev" title="Updating Nodes and Menus">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
kbd.kbd {font-style: oblique}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="Info-Formatting">
<div class="nav-panel">
<p>
Next: <a href="Printing.html" accesskey="n" rel="next">Printing</a>, Previous: <a href="Updating-Nodes-and-Menus.html" accesskey="p" rel="prev">Updating Nodes and Menus</a>, Up: <a href="Texinfo-Mode.html" accesskey="u" rel="up">Using Texinfo Mode</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>
<h3 class="section" id="Formatting-for-Info">D.6 Formatting for Info</h3>
<a class="index-entry-id" id="index-Formatting-for-Info"></a>
<a class="index-entry-id" id="index-Running-an-Info-formatter"></a>
<a class="index-entry-id" id="index-Info-formatting"></a>
<p>Texinfo mode provides several commands for formatting part or all of a
Texinfo file for Info. Often, when you are writing a document, you
want to format only part of a file&mdash;that is, a region.
</p>
<p>You can use either the <code class="code">texinfo-format-region</code> or the
<code class="code">makeinfo-region</code> command to format a region:
</p>
<dl class="table">
<dd><a class="index-entry-id" id="index-texinfo_002dformat_002dregion-1"></a>
</dd>
<dt><kbd class="kbd">C-c C-e C-r</kbd></dt>
<dt><kbd class="kbd">M-x texinfo-format-region</kbd></dt>
<dt><kbd class="kbd">C-c C-m C-r</kbd></dt>
<dt><kbd class="kbd">M-x makeinfo-region</kbd></dt>
<dd><p>Format the current region for Info.
</p></dd>
</dl>
<p>You can use either the <code class="code">texinfo-format-buffer</code> or the
<code class="code">makeinfo-buffer</code> command to format a whole buffer:
</p>
<dl class="table">
<dd><a class="index-entry-id" id="index-texinfo_002dformat_002dbuffer-1"></a>
</dd>
<dt><kbd class="kbd">C-c C-e C-b</kbd></dt>
<dt><kbd class="kbd">M-x texinfo-format-buffer</kbd></dt>
<dt><kbd class="kbd">C-c C-m C-b</kbd></dt>
<dt><kbd class="kbd">M-x makeinfo-buffer</kbd></dt>
<dd><p>Format the current buffer for Info.
</p></dd>
</dl>
<p>For example, after writing a Texinfo file, you can type the following:
</p>
<div class="example">
<pre class="example-preformatted">C-u C-c C-u m
</pre><pre class="exdent">or
</pre><pre class="example-preformatted">C-u M-x texinfo-master-menu
</pre></div>
<p>This updates all the nodes and menus. Then type the following to create
an Info file:
</p>
<div class="example">
<pre class="example-preformatted">C-c C-m C-b
</pre><pre class="exdent">or
</pre><pre class="example-preformatted">M-x makeinfo-buffer
</pre></div>
<p>See <a class="xref" href="Creating-an-Info-File.html">Creating an Info File</a> for details about Info formatting.
</p>
</div>
</body>
</html>