File Manager

Editing File: /usr/share/doc/texinfo/html/Updating-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". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Updating Commands (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<div class="header">

Next: <a href="Updating-Requirements.html" accesskey="n" rel="next">Updating Requirements</a>, Up: <a href="Updating-Nodes-and-Menus.html" accesskey="u" rel="up">Updating Nodes and Menus</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>]
</div>
<hr>
<h4 class="subsection">D.5.1 The Updating Commands</h4>

You can use the updating commands to:

<ul>
<li> insert or update the &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, and &lsquo;Up&rsquo; pointers of a node,

</li><li> insert or update the menu for a section, and

</li><li> create a master menu for a Texinfo source file.
</li></ul>

You can also use the commands to update all the nodes and menus in a
region or in a whole Texinfo file.

The updating commands work only with conventional Texinfo files, which
are structured hierarchically like books. In such files, a structuring
command line must follow closely after each <code>@node</code> line, except
for the &lsquo;Top&rsquo; <code>@node</code> line. (A structuring command line is
a line beginning with <code>@chapter</code>, <code>@section</code>, or other
similar command.)

You can write the structuring command line on the line that follows
immediately after an <code>@node</code> line or else on the line that
follows after a single <code>@comment</code> line or a single
<code>@ifinfo</code> line. You cannot interpose more than one line between
the <code>@node</code> line and the structuring command line; and you may
interpose only a <code>@comment</code> line or an <code>@ifinfo</code> line.

Commands which work on a whole buffer require that the &lsquo;Top&rsquo; node be
followed by a node with a <code>@chapter</code> or equivalent-level command.
The menu updating commands will not create a main or master menu for a
Texinfo file that has only <code>@chapter</code>-level nodes! The menu
updating commands only create menus within nodes for lower level
nodes. To create a menu of chapters, you must provide a &lsquo;Top&rsquo;
node.

The menu updating commands remove menu entries that refer to other Info
files since they do not refer to nodes within the current buffer. This
is a deficiency. Rather than use menu entries, you can use cross
references to refer to other Info files. None of the updating commands
affect cross-references.

Texinfo mode has five updating commands that are used most often: two
are for updating the node pointers or menu of a single node (or a
region); two are for updating every node pointer and menu in a file;
and one, the <code>texinfo-master-menu</code> command, is for creating a
master menu for a complete file, and optionally, for updating every
node and menu in the whole Texinfo file.

The <code>texinfo-master-menu</code> command is the primary command:

<dl compact="compact">
<dt><kbd>C-c C-u m</kbd></dt>
<dt><kbd>M-x texinfo-master-menu</kbd></dt>
<dd>
Create or update a master menu that includes all the other menus
(incorporating the descriptions from pre-existing menus, if
any).

With an argument (prefix argument, <kbd>C-u,</kbd> if interactive), first create or
update all the nodes and all the regular menus in the buffer before
constructing the master menu. (See <a href="The-Top-Node.html">The Top Node and
Master Menu</a>, for more about a master menu.)

For <code>texinfo-master-menu</code> to work, the Texinfo file must have a
&lsquo;Top&rsquo; node and at least one subsequent node.

After extensively editing a Texinfo file, you can type the following:

<div class="example">
<pre class="example">C-u M-x texinfo-master-menu
</pre><pre class="example">or
</pre><pre class="example">C-u C-c C-u m
</pre></div>

This updates all the nodes and menus completely and all at once.
</dd>
</dl>

The other major updating commands do smaller jobs and are designed for
the person who updates nodes and menus as he or she writes a Texinfo
file.

The commands are:

<dl compact="compact">
<dt><kbd>C-c C-u C-n</kbd></dt>
<dt><kbd>M-x texinfo-update-node</kbd></dt>
<dd>
Insert the &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, and &lsquo;Up&rsquo; pointers for the node that point is
within (i.e., for the <code>@node</code> line preceding point). If the
<code>@node</code> line has pre-existing &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, or &lsquo;Up&rsquo;
pointers in it, the old pointers are removed and new ones inserted.
With an argument (prefix argument, <kbd>C-u</kbd>, if interactive), this command
updates all <code>@node</code> lines in the region (which is the text
between point and mark).

</dd>
<dt><kbd>C-c C-u C-m</kbd></dt>
<dt><kbd>M-x texinfo-make-menu</kbd></dt>
<dd>
Create or update the menu in the node that point is within.
With an argument (<kbd>C-u</kbd> as prefix argument, if
interactive), the command makes or updates menus for the
nodes which are either within or a part of the
region.

Whenever <code>texinfo-make-menu</code> updates an existing menu, the
descriptions from that menu are incorporated into the new menu. This
is done by copying descriptions from the existing menu to the entries
in the new menu that have the same node names. If the node names are
different, the descriptions are not copied to the new menu.

</dd>
<dt><kbd>C-c C-u C-e</kbd></dt>
<dt><kbd>M-x texinfo-every-node-update</kbd></dt>
<dd>
Insert or update the &lsquo;Next&rsquo;, &lsquo;Previous&rsquo;, and &lsquo;Up&rsquo; pointers for every
node in the buffer.

</dd>
<dt><kbd>C-c C-u C-a</kbd></dt>
<dt><kbd>M-x texinfo-all-menus-update</kbd></dt>
<dd>
Create or update all the menus in the buffer. With an argument
(<kbd>C-u</kbd> as prefix argument, if interactive), first insert
or update all the node
pointers before working on the menus.

If a master menu exists, the <code>texinfo-all-menus-update</code> command
updates it; but the command does not create a new master menu if none
already exists. (Use the <code>texinfo-master-menu</code> command for
that.)

When working on a document that does not merit a master menu, you can
type the following:

<div class="example">
<pre class="example">C-u C-c C-u C-a
</pre><pre class="example">or
</pre><pre class="example">C-u M-x texinfo-all-menus-update
</pre></div>

This updates all the nodes and menus.
</dd>
</dl>

The <code>texinfo-column-for-description</code> variable specifies the
column to which menu descriptions are indented. By default, the value
is 32 although it can be useful to reduce it to as low as 24. You
can set the variable via customization (see <a href="../emacs/Customization.html#Customization">Customization</a> in <cite>The GNU Emacs Manual</cite>) or with the <kbd>M-x set-variable</kbd>
command (see <a href="../emacs/Examining.html#Examining">Examining and Setting Variables</a> in <cite>The GNU Emacs Manual</cite>).

Also, the <code>texinfo-indent-menu-description</code> command may be used to
indent existing menu descriptions to a specified column. Finally, if
you wish, you can use the <code>texinfo-insert-node-lines</code> command to
insert missing <code>@node</code> lines into a file. (See <a href="Other-Updating-Commands.html">Other Updating Commands</a>, for more information.)

<hr>
<div class="header">

Next: <a href="Updating-Requirements.html" accesskey="n" rel="next">Updating Requirements</a>, Up: <a href="Updating-Nodes-and-Menus.html" accesskey="u" rel="up">Updating Nodes and Menus</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>]
</div>

</body>
</html>

Back to Directory File Manager