[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6526] make Texinfo Mode an appendix
|
From: |
Gavin D. Smith |
|
Subject: |
[6526] make Texinfo Mode an appendix |
|
Date: |
Fri, 14 Aug 2015 10:42:24 +0000 |
Revision: 6526
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6526
Author: gavin
Date: 2015-08-14 10:42:23 +0000 (Fri, 14 Aug 2015)
Log Message:
-----------
make Texinfo Mode an appendix
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-08-13 21:03:51 UTC (rev 6525)
+++ trunk/ChangeLog 2015-08-14 10:42:23 UTC (rev 6526)
@@ -1,7 +1,11 @@
+2015-08-14 Gavin Smith <address@hidden>
+
+ * doc/texinfo.texi (Texinfo Mode): Move to an appendix.
+
2015-08-13 Gavin Smith <address@hidden>
- * doc/texinfo.tex (@ftable @vtable): Mention that @itemx as well
- as @item creates an index eentry.
+ * doc/texinfo.texi (@ftable @vtable): Mention that @itemx as
+ well as @item creates an index entry.
2015-08-13 Gavin Smith <address@hidden>
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-08-13 21:03:51 UTC (rev 6525)
+++ trunk/doc/texinfo.texi 2015-08-14 10:42:23 UTC (rev 6526)
@@ -132,7 +132,6 @@
@menu
* Copying Conditions:: Your rights.
* Overview:: Texinfo in brief.
-* Texinfo Mode:: Using the GNU Emacs Texinfo mode.
* Beginning and Ending a File:: Beginning and end of a Texinfo file.
* Chapter Structuring:: Creating chapters, sections, appendices, etc.
* Nodes:: Writing nodes, the basic unit of Texinfo.
@@ -163,6 +162,7 @@
* Command List:: All the Texinfo @@-commands.
* Tips:: Hints on how to write a Texinfo document.
* Sample Texinfo Files:: Complete examples, including full texts.
+* Texinfo Mode:: Using the GNU Emacs Texinfo mode.
* Headings:: How to write page headings and footings.
* Catching Mistakes:: How to find mistakes in formatting.
* Info Format Specification:: Technical details of the Info file format.
@@ -190,27 +190,6 @@
* Short Sample:: A short sample Texinfo file.
* History:: Acknowledgements, contributors and genesis.
-Using Texinfo Mode
-
-* Texinfo Mode Overview:: How Texinfo mode can help you.
-* Emacs Editing:: Texinfo mode adds to GNU Emacs' general
- purpose editing features.
-* Inserting:: How to insert frequently used @@-commands.
-* Showing the Structure:: How to show the structure of a file.
-* Updating Nodes and Menus:: How to update or create new nodes and menus.
-* Info Formatting:: How to format for Info.
-* Printing:: How to format and print part or all of a file.
-* Texinfo Mode Summary:: Summary of all the Texinfo mode commands.
-
-Updating Nodes and Menus
-
-* Updating Commands:: Five major updating commands.
-* Updating Requirements:: How to structure a Texinfo file for
- using the updating command.
-* Other Updating Commands:: How to indent descriptions, insert
- missing nodes lines, and update
- nodes in sequence.
-
Beginning and Ending a Texinfo File
* Sample Beginning:: A sample beginning for a Texinfo file.
@@ -674,6 +653,27 @@
* Verbatim Copying License::
* All-permissive Copying License::
+Using Texinfo Mode
+
+* Texinfo Mode Overview:: How Texinfo mode can help you.
+* Emacs Editing:: Texinfo mode adds to GNU Emacs' general
+ purpose editing features.
+* Inserting:: How to insert frequently used @@-commands.
+* Showing the Structure:: How to show the structure of a file.
+* Updating Nodes and Menus:: How to update or create new nodes and menus.
+* Info Formatting:: How to format for Info.
+* Printing:: How to format and print part or all of a file.
+* Texinfo Mode Summary:: Summary of all the Texinfo mode commands.
+
+Updating Nodes and Menus
+
+* Updating Commands:: Five major updating commands.
+* Updating Requirements:: How to structure a Texinfo file for
+ using the updating command.
+* Other Updating Commands:: How to indent descriptions, insert
+ missing nodes lines, and update
+ nodes in sequence.
+
Page Headings
* Headings Introduced:: Conventions for using page headings.
@@ -1866,950 +1866,6 @@
role of @command{texi2any}.
address@hidden Texinfo Mode
address@hidden Using Texinfo Mode
address@hidden Texinfo mode
address@hidden Mode, using Texinfo
address@hidden GNU Emacs
address@hidden Emacs
-
-You may edit a Texinfo file with any text editor you choose. A Texinfo
-file is no different from any other ASCII file. However, GNU Emacs
-comes with a special mode, called Texinfo mode, that provides Emacs
-commands and tools to help ease your work.
-
-This chapter describes features of GNU Emacs' Texinfo mode but not any
-features of the Texinfo formatting language. So if you are reading this
-manual straight through from the beginning, you may want to skim through
-this chapter briefly and come back to it after reading succeeding
-chapters which describe the Texinfo formatting language in detail.
-
address@hidden
-* Texinfo Mode Overview:: How Texinfo mode can help you.
-* Emacs Editing:: Texinfo mode adds to GNU Emacs' general
- purpose editing features.
-* Inserting:: How to insert frequently used @@-commands.
-* Showing the Structure:: How to show the structure of a file.
-* Updating Nodes and Menus:: How to update or create new nodes and menus.
-* Info Formatting:: How to format for Info.
-* Printing:: How to format and print part or all of a file.
-* Texinfo Mode Summary:: Summary of all the Texinfo mode commands.
address@hidden menu
-
address@hidden Texinfo Mode Overview
address@hidden Texinfo Mode Overview
-
-Texinfo mode provides special features for working with Texinfo files.
-You can:
-
address@hidden @bullet
address@hidden
-Insert frequently used @@-commands.
-
address@hidden
-Automatically create @code{@@node} lines.
-
address@hidden
-Show the structure of a Texinfo source file.
-
address@hidden
-Automatically create or update the `Next',
-`Previous', and `Up' pointers of a node.
-
address@hidden
-Automatically create or update menus.
-
address@hidden
-Automatically create a master menu.
-
address@hidden
-Format a part or all of a file for Info.
-
address@hidden
-Typeset and print part or all of a file.
address@hidden itemize
-
-Perhaps the two most helpful features are those for inserting frequently
-used @@-commands and for creating node pointers and menus.
-
address@hidden Emacs Editing
address@hidden The Usual GNU Emacs Editing Commands
-
-In most cases, the usual Text mode commands work the same in Texinfo
-mode as they do in Text mode. Texinfo mode adds new editing commands
-and tools to GNU Emacs' general purpose editing features. The major
-difference concerns filling. In Texinfo mode, the paragraph
-separation variable and syntax table are redefined so that Texinfo
-commands that should be on lines of their own are not inadvertently
-included in paragraphs. Thus, the @kbd{M-q} (@code{fill-paragraph})
-command will refill a paragraph but not mix an indexing command on a
-line adjacent to it into the paragraph.
-
-In addition, Texinfo mode sets the @code{page-delimiter} variable to
-the value of @code{texinfo-chapter-level-regexp}; by default, this is
-a regular expression matching the commands for chapters and their
-equivalents, such as appendices. With this value for the page
-delimiter, you can jump from chapter title to chapter title with the
address@hidden ]} (@code{forward-page}) and @kbd{C-x [}
-(@code{backward-page}) commands and narrow to a chapter with the
address@hidden n p} (@code{narrow-to-page}) command. (@xref{Pages, , ,emacs,
-The GNU Emacs Manual}, for details about the page commands.)
-
-You may name a Texinfo file however you wish, but the convention is to
-end a Texinfo file name with one of the extensions
address@hidden, @file{.texi}, @file{.txi}, or @file{.tex}. A longer
-extension is preferred, since it is explicit, but a shorter extension
-may be necessary for operating systems that limit the length of file
-names. GNU Emacs automatically enters Texinfo mode when you visit a
-file with a @file{.texinfo}, @file{.texi} or @file{.txi}
-extension. Also, Emacs switches to Texinfo mode
-when you visit a
-file that has @samp{-*-texinfo-*-} in its first line. If ever you are
-in another mode and wish to switch to Texinfo mode, type @code{M-x
-texinfo-mode}.
-
-Like all other Emacs features, you can customize or enhance Texinfo
-mode as you wish. In particular, the keybindings are very easy to
-change. The keybindings described here are the default or standard
-ones.
-
address@hidden Inserting
address@hidden Inserting Frequently Used Commands
address@hidden Inserting frequently used commands
address@hidden Frequently used commands, inserting
address@hidden Commands, inserting them
-
-Texinfo mode provides commands to insert various frequently used
-@@-commands into the buffer. You can use these commands to save
-keystrokes.
-
-The insert commands are invoked by typing @kbd{C-c} twice and then the
-first letter of the @@-command:
-
address@hidden @kbd
address@hidden C-c C-c c
address@hidden M-x texinfo-insert-@@code
address@hidden texinfo-insert-@@code
-Insert @code{@@address@hidden@}} and put the
-cursor between the braces.
-
address@hidden C-c C-c d
address@hidden M-x texinfo-insert-@@dfn
address@hidden texinfo-insert-@@dfn
-Insert @code{@@address@hidden@}} and put the
-cursor between the braces.
-
address@hidden C-c C-c e
address@hidden M-x texinfo-insert-@@end
address@hidden texinfo-insert-@@end
-Insert @code{@@end} and attempt to insert the correct following word,
-such as @samp{example} or @samp{table}. (This command does not handle
-nested lists correctly, but inserts the word appropriate to the
-immediately preceding list.)
-
address@hidden C-c C-c i
address@hidden M-x texinfo-insert-@@item
address@hidden texinfo-insert-@@item
-Insert @code{@@item} and put the
-cursor at the beginning of the next line.
-
address@hidden C-c C-c k
address@hidden M-x texinfo-insert-@@kbd
address@hidden texinfo-insert-@@kbd
-Insert @code{@@address@hidden@}} and put the
-cursor between the braces.
-
address@hidden C-c C-c n
address@hidden M-x texinfo-insert-@@node
address@hidden texinfo-insert-@@node
-Insert @code{@@node} and a comment line
-listing the sequence for the `Next',
-`Previous', and `Up' nodes.
-Leave point after the @code{@@node}.
-
address@hidden C-c C-c o
address@hidden M-x texinfo-insert-@@noindent
address@hidden texinfo-insert-@@noindent
-Insert @code{@@noindent} and put the
-cursor at the beginning of the next line.
-
address@hidden C-c C-c s
address@hidden M-x texinfo-insert-@@samp
address@hidden texinfo-insert-@@samp
-Insert @code{@@address@hidden@}} and put the
-cursor between the braces.
-
address@hidden C-c C-c t
address@hidden M-x texinfo-insert-@@table
address@hidden texinfo-insert-@@table
-Insert @code{@@table} followed by a @key{SPC}
-and leave the cursor after the @key{SPC}.
-
address@hidden C-c C-c v
address@hidden M-x texinfo-insert-@@var
address@hidden texinfo-insert-@@var
-Insert @code{@@address@hidden@}} and put the
-cursor between the braces.
-
address@hidden C-c C-c x
address@hidden M-x texinfo-insert-@@example
address@hidden texinfo-insert-@@example
-Insert @code{@@example} and put the
-cursor at the beginning of the next line.
-
address@hidden address@hidden was the binding for texinfo-insert-braces;
address@hidden in Emacs 19, backward-paragraph will take this binding.
address@hidden C-c C-c @{
address@hidden M-x texinfo-insert-braces
address@hidden texinfo-insert-braces
-Insert @address@hidden@}} and put the cursor between the braces.
-
address@hidden C-c @}
address@hidden C-c ]
address@hidden M-x up-list
address@hidden up-list
-Move from between a pair of braces forward past the closing brace.
-Typing @kbd{C-c ]} is easier than typing @kbd{C-c @}}, which
-is, however, more mnemonic; hence the two keybindings. (Also, you can
-move out from between braces by typing @kbd{C-f}.)
address@hidden table
-
-To put a command such as @address@hidden@@address@hidden@address@hidden around
an
address@hidden word, position the cursor in front of the word and type
address@hidden 1 C-c C-c c}. This makes it easy to edit existing plain text.
-The value of the prefix argument tells Emacs how many words following
-point to include between address@hidden for one word, @samp{2} for
-two words, and so on. Use a negative argument to enclose the previous
-word or words. If you do not specify a prefix argument, Emacs inserts
-the @@-command string and positions the cursor between the braces. This
-feature works only for those @@-commands that operate on a word or words
-within one line, such as @code{@@kbd} and @code{@@var}.
-
-This set of insert commands was created after analyzing the frequency
-with which different @@-commands are used in the @cite{GNU Emacs
-Manual} and the @cite{GDB Manual}. If you wish to add your own insert
-commands, you can bind a keyboard macro to a key, use abbreviations,
-or extend the code in @file{texinfo.el}.
-
address@hidden texinfo-start-menu-description
address@hidden Menu description, start
address@hidden Description for menu, start
address@hidden C-c C-d} (@code{texinfo-start-menu-description}) is an insert
-command that works differently from the other insert commands. It
-inserts a node's section or chapter title in the space for the
-description in a menu entry line. (A menu entry has three parts, the
-entry name, the node name, and the description. Only the node name is
-required, but a description helps explain what the node is about.
address@hidden Parts, , The Parts of a Menu}.)
-
-To use @code{texinfo-start-menu-description}, position point in a menu
-entry line and type @kbd{C-c C-c C-d}. The command looks for and copies
-the title that goes with the node name, and inserts the title as a
-description; it positions point at beginning of the inserted text so you
-can edit it. The function does not insert the title if the menu entry
-line already contains a description.
-
-This command is only an aid to writing descriptions; it does not do the
-whole job. You must edit the inserted text since a title tends to use
-the same words as a node name but a useful description uses different
-words.
-
address@hidden Showing the Structure
address@hidden Showing the Sectioning Structure of a File
address@hidden Showing the sectioning structure of a file
address@hidden Sectioning structure of a file, showing
address@hidden Structure of a file, showing
address@hidden Outline of file structure, showing
address@hidden Contents-like outline of file structure
address@hidden File sectioning structure, showing
address@hidden Texinfo file sectioning structure, showing
-
-You can show the sectioning structure of a Texinfo file by using the
address@hidden C-s} command (@code{texinfo-show-structure}). This command
-lists the lines that begin with the @@-commands for @code{@@chapter},
address@hidden@@section}, and the like. It constructs what amounts to a table
-of contents. These lines are displayed in another buffer called the
address@hidden buffer. In that buffer, you can position the cursor
-over one of the lines and use the @kbd{C-c C-c} command
-(@code{occur-mode-goto-occurrence}), to jump to the corresponding spot
-in the Texinfo file.
-
address@hidden @kbd
address@hidden C-c C-s
address@hidden M-x texinfo-show-structure
address@hidden texinfo-show-structure
-Show the @code{@@chapter}, @code{@@section}, and such lines of a
-Texinfo file.
-
address@hidden C-c C-c
address@hidden M-x occur-mode-goto-occurrence
address@hidden occur-mode-goto-occurrence
-Go to the line in the Texinfo file corresponding to the line under the
-cursor in the @file{*Occur*} buffer.
address@hidden table
-
-If you call @code{texinfo-show-structure} with a prefix argument by
-typing @address@hidden C-c C-s}}, it will list not only those lines with the
-@@-commands for @code{@@chapter}, @code{@@section}, and the like, but
-also the @code{@@node} lines. You can use @code{texinfo-show-structure}
-with a prefix argument to check whether the `Next', `Previous', and `Up'
-pointers of an @code{@@node} line are correct.
-
-Often, when you are working on a manual, you will be interested only
-in the structure of the current chapter. In this case, you can mark
-off the region of the buffer that you are interested in by using the
address@hidden n n} (@code{narrow-to-region}) command and
address@hidden will work on only that region. To see
-the whole buffer again, use @address@hidden n w}} (@code{widen}).
-(@xref{Narrowing, , , emacs, The GNU Emacs Manual}, for more
-information about the narrowing commands.)
-
address@hidden page-delimiter
address@hidden Page delimiter in Texinfo mode
-In addition to providing the @code{texinfo-show-structure} command,
-Texinfo mode sets the value of the page delimiter variable to match
-the chapter-level @@-commands. This enables you to use the @kbd{C-x
-]} (@code{forward-page}) and @kbd{C-x [} (@code{backward-page})
-commands to move forward and backward by chapter, and to use the
address@hidden n p} (@code{narrow-to-page}) command to narrow to a chapter.
address@hidden, , , emacs, The GNU Emacs Manual}, for more information
-about the page commands.
-
-
address@hidden Updating Nodes and Menus
address@hidden Updating Nodes and Menus
-
address@hidden Updating nodes and menus
address@hidden Create nodes, menus automatically
address@hidden Insert nodes, menus automatically
address@hidden Automatically insert nodes, menus
-
-Texinfo mode provides commands for automatically creating or updating
-menus and node pointers. The commands are called ``update'' commands
-because their most frequent use is for updating a Texinfo file after you
-have worked on it; but you can use them to insert the `Next',
-`Previous', and `Up' pointers into an @code{@@node} line that has none
-and to create menus in a file that has none.
-
-If you do not use any updating commands, you need to write menus by
-hand, which is a tedious task.
-
address@hidden
-* Updating Commands:: Five major updating commands.
-* Updating Requirements:: How to structure a Texinfo file for
- using the updating command.
-* Other Updating Commands:: How to indent descriptions, insert
- missing nodes lines, and update
- nodes in sequence.
address@hidden menu
-
address@hidden Updating Commands
address@hidden The Updating Commands
-
-You can use the updating commands to:
-
address@hidden @bullet
address@hidden
-insert or update the `Next', `Previous', and `Up' pointers of a node,
-
address@hidden
-insert or update the menu for a section, and
-
address@hidden
-create a master menu for a Texinfo source file.
address@hidden itemize
-
-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} line, except
-for the `Top' @code{@@node} line. (A @dfn{structuring command line} is
-a line beginning with @code{@@chapter}, @code{@@section}, or other
-similar command.)
-
-You can write the structuring command line on the line that follows
-immediately after an @code{@@node} line or else on the line that
-follows after a single @code{@@comment} line or a single
address@hidden@@ifinfo} line. You cannot interpose more than one line between
-the @code{@@node} line and the structuring command line; and you may
-interpose only a @code{@@comment} line or an @code{@@ifinfo} line.
-
-Commands which work on a whole buffer require that the `Top' node be
-followed by a node with a @code{@@chapter} 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}-level nodes! The menu
-updating commands only create menus @emph{within} nodes for lower level
-nodes. To create a menu of chapters, you must provide a `Top'
-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} 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} command is the primary command:
-
address@hidden @kbd
address@hidden C-c C-u m
address@hidden M-x texinfo-master-menu
address@hidden texinfo-master-menu
-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,} if interactive), first create or
-update all the nodes and all the regular menus in the buffer before
-constructing the master menu. (@xref{The Top Node, , The Top Node and
-Master Menu}, for more about a master menu.)
-
-For @code{texinfo-master-menu} to work, the Texinfo file must have a
-`Top' node and at least one subsequent node.
-
-After extensively editing a Texinfo file, you can type the following:
-
address@hidden
-C-u M-x texinfo-master-menu
address@hidden or
-C-u C-c C-u m
address@hidden example
-
address@hidden
-This updates all the nodes and menus completely and all at once.
address@hidden table
-
-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.
-
address@hidden 1000
-The commands are:
-
address@hidden @kbd
address@hidden C-c C-u C-n
address@hidden M-x texinfo-update-node
address@hidden texinfo-update-node
-Insert the `Next', `Previous', and `Up' pointers for the node that point is
-within (i.e., for the @code{@@node} line preceding point). If the
address@hidden@@node} line has pre-existing `Next', `Previous', or `Up'
-pointers in it, the old pointers are removed and new ones inserted.
-With an argument (prefix argument, @kbd{C-u}, if interactive), this command
-updates all @code{@@node} lines in the region (which is the text
-between point and mark).
-
address@hidden C-c C-u C-m
address@hidden M-x texinfo-make-menu
address@hidden texinfo-make-menu
-Create or update the menu in the node that point is within.
-With an argument (@kbd{C-u} 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} 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.
-
address@hidden C-c C-u C-e
address@hidden M-x texinfo-every-node-update
address@hidden texinfo-every-node-update
-Insert or update the `Next', `Previous', and `Up' pointers for every
-node in the buffer.
-
address@hidden C-c C-u C-a
address@hidden M-x texinfo-all-menus-update
address@hidden texinfo-all-menus-update
-Create or update all the menus in the buffer. With an argument
-(@kbd{C-u} 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} command
-updates it; but the command does not create a new master menu if none
-already exists. (Use the @code{texinfo-master-menu} command for
-that.)
-
-When working on a document that does not merit a master menu, you can
-type the following:
-
address@hidden
-C-u C-c C-u C-a
address@hidden or
-C-u M-x texinfo-all-menus-update
address@hidden example
-
address@hidden
-This updates all the nodes and menus.
address@hidden table
-
-The @code{texinfo-column-for-description} 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 (@pxref{Customization,,,
-emacs, The GNU Emacs Manual}) or with the @kbd{M-x set-variable}
-command (@pxref{Examining, , Examining and Setting Variables, emacs,
-The GNU Emacs Manual}).
-
-Also, the @code{texinfo-indent-menu-description} 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} command to
-insert missing @code{@@node} lines into a file. (@xref{Other Updating
-Commands}, for more information.)
-
address@hidden Updating Requirements
address@hidden Updating Requirements
address@hidden Updating requirements
address@hidden Requirements for updating commands
-
-To use the updating commands, you must organize the Texinfo file
-hierarchically with chapters, sections, subsections, and the like.
-When you construct the hierarchy of the manual, do not `jump down'
-more than one level at a time: you can follow the `Top' node with a
-chapter, but not with a section; you can follow a chapter with a
-section, but not with a subsection. However, you may `jump up' any
-number of levels at one time---for example, from a subsection to a
-chapter.
-
-Each @code{@@node} line, with the exception of the line for the `Top'
-node, must be followed by a line with a structuring command such as
address@hidden@@chapter}, @code{@@section}, or
address@hidden@@unnumberedsubsec}.
-
-Each @code{@@node} line/structuring-command line combination
-must look either like this:
-
address@hidden
address@hidden
-@@node Comments, Minimum, Conventions, Overview
-@@comment node-name, next, previous, up
-@@section Comments
address@hidden group
address@hidden example
-
-or like this (without the @code{@@comment} line):
-
address@hidden
address@hidden
-@@node Comments, Minimum, Conventions, Overview
-@@section Comments
address@hidden group
address@hidden example
-
-or like this (without the explicit node pointers):
-
address@hidden
address@hidden
-@@node Comments
-@@section Comments
address@hidden group
address@hidden example
-
address@hidden
-In this example, `Comments' is the name of both the node and the
-section. The next node is called `Minimum' and the previous node is
-called `Conventions'. The `Comments' section is within the `Overview'
-node, which is specified by the `Up' pointer. (Instead of an
address@hidden@@comment} line, you may also write an @code{@@ifinfo} line.)
-
-If a file has a `Top' node, it must be called @samp{top} or @samp{Top}
-and be the first node in the file.
-
-The menu updating commands create a menu of sections within a chapter,
-a menu of subsections within a section, and so on. This means that
-you must have a `Top' node if you want a menu of chapters.
-
-Incidentally, the @code{makeinfo} command will create an Info file for a
-hierarchically organized Texinfo file that lacks `Next', `Previous' and
-`Up' pointers. Thus, if you can be sure that your Texinfo file will be
-formatted with @code{makeinfo}, you have no need for the update node
-commands. (@xref{Creating an Info File}, for more information about
address@hidden)
-
-
address@hidden Other Updating Commands
address@hidden Other Updating Commands
-
-In addition to the five major updating commands, Texinfo mode
-possesses several less frequently used updating commands:
-
address@hidden @kbd
address@hidden M-x texinfo-insert-node-lines
address@hidden texinfo-insert-node-lines
-Insert @code{@@node} lines before the @code{@@chapter},
address@hidden@@section}, and other sectioning commands wherever they are
-missing throughout a region in a Texinfo file.
-
-With an argument (@kbd{C-u} as prefix argument, if interactive), the
-command @code{texinfo-insert-node-lines} not only inserts
address@hidden@@node} lines but also inserts the chapter or section titles as
-the names of the corresponding nodes. In addition, it inserts the
-titles as node names in pre-existing @code{@@node} lines that lack
-names. Since node names should be more concise than section or
-chapter titles, you must manually edit node names so inserted.
-
-For example, the following marks a whole buffer as a region and inserts
address@hidden@@node} lines and titles throughout:
-
address@hidden
-C-x h C-u M-x texinfo-insert-node-lines
address@hidden example
-
-This command inserts titles as node names in @code{@@node} lines; the
address@hidden command (@pxref{Inserting,
-Inserting Frequently Used Commands}) inserts titles as descriptions in
-menu entries, a different action. However, in both cases, you need to
-edit the inserted text.
-
address@hidden M-x texinfo-multiple-files-update
address@hidden texinfo-multiple-files-update @r{(in brief)}
-Update nodes and menus in a document built from several separate files.
-With @kbd{C-u} as a prefix argument, create and insert a master menu in
-the outer file. With a numeric prefix argument, such as @kbd{C-u 2}, first
-update all the menus and all the `Next', `Previous', and `Up' pointers
-of all the included files before creating and inserting a master menu in
-the outer file. The @code{texinfo-multiple-files-update} command is
-described in the appendix on @code{@@include} files.
address@hidden@code{texinfo-multiple-files-update}}.
-
address@hidden M-x texinfo-indent-menu-description
address@hidden texinfo-indent-menu-description
-Indent every description in the menu following point to the specified
-column. You can use this command to give yourself more space for
-descriptions. With an argument (@kbd{C-u} as prefix argument, if
-interactive), the @code{texinfo-indent-menu-description} command indents
-every description in every menu in the region. However, this command
-does not indent the second and subsequent lines of a multi-line
-description.
-
address@hidden M-x texinfo-sequential-node-update
address@hidden texinfo-sequential-node-update
-Insert the names of the nodes immediately following and preceding the
-current node as the `Next' or `Previous' pointers regardless of those
-nodes' hierarchical level. This means that the `Next' node of a
-subsection may well be the next chapter. Sequentially ordered nodes are
-useful for novels and other documents that you read through
-sequentially. (However, in Info, the @kbd{g *} command lets
-you look through the file sequentially, so sequentially ordered nodes
-are not strictly necessary.) With an argument (prefix argument, if
-interactive), the @code{texinfo-sequential-node-update} command
-sequentially updates all the nodes in the region.
address@hidden table
-
address@hidden Info Formatting
address@hidden Formatting for Info
address@hidden Formatting for Info
address@hidden Running an Info formatter
address@hidden Info formatting
-
-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---that is, a region.
-
-You can use either the @code{texinfo-format-region} or the
address@hidden command to format a region:
-
address@hidden @kbd
address@hidden texinfo-format-region
address@hidden C-c C-e C-r
address@hidden M-x texinfo-format-region
address@hidden C-c C-m C-r
address@hidden M-x makeinfo-region
-Format the current region for Info.
address@hidden table
-
-You can use either the @code{texinfo-format-buffer} or the
address@hidden command to format a whole buffer:
-
address@hidden @kbd
address@hidden texinfo-format-buffer
address@hidden C-c C-e C-b
address@hidden M-x texinfo-format-buffer
address@hidden C-c C-m C-b
address@hidden M-x makeinfo-buffer
-Format the current buffer for Info.
address@hidden table
-
address@hidden 1000
-For example, after writing a Texinfo file, you can type the following:
-
address@hidden
-C-u C-c C-u m
address@hidden or
-C-u M-x texinfo-master-menu
address@hidden example
-
address@hidden
-This updates all the nodes and menus. Then type the following to create
-an Info file:
-
address@hidden
-C-c C-m C-b
address@hidden or
-M-x makeinfo-buffer
address@hidden example
-
-For @TeX{} or the Info formatting commands to work, the file @emph{must}
-include a line that has @code{@@setfilename} in its header.
-
address@hidden an Info File}, for details about Info formatting.
-
address@hidden Printing
address@hidden node-name, next, previous, up
address@hidden Printing
address@hidden Formatting for printing
address@hidden Printing a region or buffer
address@hidden Region formatting and printing
address@hidden Buffer formatting and printing
address@hidden Part of file formatting and printing
-
-Typesetting and printing a Texinfo file is a multi-step process in
-which you first create a file for printing (called a DVI file), and
-then print the file. Optionally, you may also create indices. To do
-this, you must run the @code{texindex} command after first running the
address@hidden typesetting command; and then you must run the @code{tex}
-command again. Or else run the @code{texi2dvi} command which
-automatically creates indices as needed (@pxref{Format with
address@hidden).
-
-Often, when you are writing a document, you want to typeset and print
-only part of a file to see what it will look like. You can use the
address@hidden and related commands for this purpose. Use
-the @code{texinfo-tex-buffer} command to format all of a
-buffer.
-
address@hidden @kbd
address@hidden C-c C-t C-b
address@hidden M-x texinfo-tex-buffer
address@hidden texinfo-tex-buffer
-Run @code{texi2dvi} on the buffer. In addition to running @TeX{} on the
-buffer, this command automatically creates or updates indices as
-needed.
-
address@hidden C-c C-t C-r
address@hidden M-x texinfo-tex-region
address@hidden texinfo-tex-region
-Run @TeX{} on the region.
-
address@hidden C-c C-t C-i
address@hidden M-x texinfo-texindex
-Run @code{texindex} to sort the indices of a Texinfo file formatted with
address@hidden The @code{texinfo-tex-region} command does
-not run @code{texindex} automatically; it only runs the @code{tex}
-typesetting command. You must run the @code{texinfo-tex-region} command
-a second time after sorting the raw index files with the @code{texindex}
-command. (Usually, you do not format an index when you format a region,
-only when you format a buffer. Now that the @code{texi2dvi} command
-exists, there is little or no need for this command.)
-
address@hidden C-c C-t C-p
address@hidden M-x texinfo-tex-print
address@hidden texinfo-tex-print
-Print the file (or the part of the file) previously formatted with
address@hidden or @code{texinfo-tex-region}.
address@hidden table
-
-For @code{texinfo-tex-region} or @code{texinfo-tex-buffer} to work, the
-file @emph{must} start with a @samp{\input texinfo} line and must
-include a @code{@@settitle} line. The file must end with @code{@@bye}
-on a line by itself. (When you use @code{texinfo-tex-region}, you must
-surround the @code{@@settitle} line with start-of-header and
-end-of-header lines.)
-
address@hidden, for a description of the other @TeX{} related
-commands, such as @code{tex-show-print-queue}.
-
address@hidden Texinfo Mode Summary
address@hidden Texinfo Mode Summary
-
-In Texinfo mode, each set of commands has default keybindings that
-begin with the same keys. All the commands that are custom-created
-for Texinfo mode begin with @kbd{C-c}. The keys are somewhat
-mnemonic.
-
address@hidden Insert Commands
-
-The insert commands are invoked by typing @kbd{C-c} twice and then the
-first letter of the @@-command to be inserted. (It might make more
-sense mnemonically to use @kbd{C-c C-i}, for `custom insert', but
address@hidden C-c} is quick to type.)
-
address@hidden
-C-c C-c c @r{Insert} @samp{@@code}.
-C-c C-c d @r{Insert} @samp{@@dfn}.
-C-c C-c e @r{Insert} @samp{@@end}.
-C-c C-c i @r{Insert} @samp{@@item}.
-C-c C-c n @r{Insert} @samp{@@node}.
-C-c C-c s @r{Insert} @samp{@@samp}.
-C-c C-c v @r{Insert} @samp{@@var}.
-C-c @{ @r{Insert braces.}
-C-c ]
-C-c @} @r{Move out of enclosing braces.}
-
address@hidden
-C-c C-c C-d @r{Insert a node's section title}
- @r{in the space for the description}
- @r{in a menu entry line.}
address@hidden group
address@hidden example
-
address@hidden Show Structure
-
-The @code{texinfo-show-structure} command is often used within a
-narrowed region.
-
address@hidden
-C-c C-s @r{List all the headings.}
address@hidden example
-
address@hidden The Master Update Command
-
-The @code{texinfo-master-menu} command creates a master menu; and can
-be used to update every node and menu in a file as well.
-
address@hidden Probably should use @tables in this section.
address@hidden
address@hidden
-C-c C-u m
-M-x texinfo-master-menu
- @r{Create or update a master menu.}
address@hidden group
-
address@hidden
-C-u C-c C-u m @r{With @kbd{C-u} as a prefix argument, first}
- @r{create or update all nodes and regular}
- @r{menus, and then create a master menu.}
address@hidden group
address@hidden example
-
address@hidden Update Pointers
-
-The update pointer commands are invoked by typing @kbd{C-c C-u} and
-then either @kbd{C-n} for @code{texinfo-update-node} or @kbd{C-e} for
address@hidden
-
address@hidden
-C-c C-u C-n @r{Update a node.}
-C-c C-u C-e @r{Update every node in the buffer.}
address@hidden example
-
address@hidden Update Menus
-
-Invoke the update menu commands by typing @kbd{C-c C-u}
-and then either @kbd{C-m} for @code{texinfo-make-menu} or
address@hidden for @code{texinfo-all-menus-update}. To update
-both nodes and menus at the same time, precede @kbd{C-c C-u
-C-a} with @kbd{C-u}.
-
address@hidden
-C-c C-u C-m @r{Make or update a menu.}
-
address@hidden
-C-c C-u C-a @r{Make or update all}
- @r{menus in a buffer.}
address@hidden group
-
address@hidden
-C-u C-c C-u C-a @r{With @kbd{C-u} as a prefix argument,}
- @r{first create or update all nodes and}
- @r{then create or update all menus.}
address@hidden group
address@hidden example
-
address@hidden Format for Info
-
-The Info formatting commands that are written in Emacs Lisp are
-invoked by typing @kbd{C-c C-e} and then either @kbd{C-r} for a region
-or @kbd{C-b} for the whole buffer.
-
-The Info formatting commands that are written in C and based on the
address@hidden program are invoked by typing @kbd{C-c C-m} and then
-either @kbd{C-r} for a region or @kbd{C-b} for the whole buffer.
-
address@hidden 800
address@hidden
-Use the @address@hidden commands:
-
address@hidden
address@hidden
-C-c C-e C-r @r{Format the region.}
-C-c C-e C-b @r{Format the buffer.}
address@hidden group
address@hidden example
-
address@hidden 750
address@hidden
-Use @code{makeinfo}:
-
address@hidden
-C-c C-m C-r @r{Format the region.}
-C-c C-m C-b @r{Format the buffer.}
-C-c C-m C-l @r{Recenter the @code{makeinfo} output buffer.}
-C-c C-m C-k @r{Kill the @code{makeinfo} formatting job.}
address@hidden example
-
address@hidden Typeset and Print
-
-The @TeX{} typesetting and printing commands are invoked by typing
address@hidden C-t} and then another control command: @kbd{C-r} for
address@hidden, @kbd{C-b} for @code{texinfo-tex-buffer},
-and so on.
-
address@hidden
-C-c C-t C-r @r{Run @TeX{} on the region.}
-C-c C-t C-b @r{Run} @code{texi2dvi} @r{on the buffer.}
-C-c C-t C-i @r{Run} @code{texindex}.
-C-c C-t C-p @r{Print the DVI file.}
-C-c C-t C-q @r{Show the print queue.}
-C-c C-t C-d @r{Delete a job from the print queue.}
-C-c C-t C-k @r{Kill the current @TeX{} formatting job.}
-C-c C-t C-x @r{Quit a currently stopped @TeX{} formatting job.}
-C-c C-t C-l @r{Recenter the output buffer.}
address@hidden example
-
address@hidden Other Updating Commands
-
-The remaining updating commands do not have standard keybindings because
-they are rarely used.
-
address@hidden
address@hidden
-M-x texinfo-insert-node-lines
- @r{Insert missing @code{@@node} lines in region.}
- @r{With @kbd{C-u} as a prefix argument,}
- @r{use section titles as node names.}
address@hidden group
-
address@hidden
-M-x texinfo-multiple-files-update
- @r{Update a multi-file document.}
- @r{With @kbd{C-u 2} as a prefix argument,}
- @r{create or update all nodes and menus}
- @r{in all included files first.}
address@hidden group
-
address@hidden
-M-x texinfo-indent-menu-description
- @r{Indent descriptions.}
address@hidden group
-
address@hidden
-M-x texinfo-sequential-node-update
- @r{Insert node pointers in strict sequence.}
address@hidden group
address@hidden example
-
-
@node Beginning and Ending a File
@anchor{Beginning a File} @c old name
@chapter Beginning and Ending a Texinfo File
@@ -22914,6 +21970,944 @@
@end example
address@hidden Texinfo Mode
address@hidden Using Texinfo Mode
address@hidden Texinfo mode
address@hidden Mode, using Texinfo
address@hidden GNU Emacs
address@hidden Emacs
+
+You may edit a Texinfo file with any text editor you choose. A Texinfo
+file is no different from any other ASCII file. However, GNU Emacs
+comes with a special mode, called Texinfo mode, that provides Emacs
+commands and tools to help ease your work.
+
address@hidden
+* Texinfo Mode Overview:: How Texinfo mode can help you.
+* Emacs Editing:: Texinfo mode adds to GNU Emacs' general
+ purpose editing features.
+* Inserting:: How to insert frequently used @@-commands.
+* Showing the Structure:: How to show the structure of a file.
+* Updating Nodes and Menus:: How to update or create new nodes and menus.
+* Info Formatting:: How to format for Info.
+* Printing:: How to format and print part or all of a file.
+* Texinfo Mode Summary:: Summary of all the Texinfo mode commands.
address@hidden menu
+
address@hidden Texinfo Mode Overview
address@hidden Texinfo Mode Overview
+
+Texinfo mode provides special features for working with Texinfo files.
+You can:
+
address@hidden @bullet
address@hidden
+Insert frequently used @@-commands.
+
address@hidden
+Automatically create @code{@@node} lines.
+
address@hidden
+Show the structure of a Texinfo source file.
+
address@hidden
+Automatically create or update the `Next',
+`Previous', and `Up' pointers of a node.
+
address@hidden
+Automatically create or update menus.
+
address@hidden
+Automatically create a master menu.
+
address@hidden
+Format a part or all of a file for Info.
+
address@hidden
+Typeset and print part or all of a file.
address@hidden itemize
+
+Perhaps the two most helpful features are those for inserting frequently
+used @@-commands and for creating node pointers and menus.
+
address@hidden Emacs Editing
address@hidden The Usual GNU Emacs Editing Commands
+
+In most cases, the usual Text mode commands work the same in Texinfo
+mode as they do in Text mode. Texinfo mode adds new editing commands
+and tools to GNU Emacs' general purpose editing features. The major
+difference concerns filling. In Texinfo mode, the paragraph
+separation variable and syntax table are redefined so that Texinfo
+commands that should be on lines of their own are not inadvertently
+included in paragraphs. Thus, the @kbd{M-q} (@code{fill-paragraph})
+command will refill a paragraph but not mix an indexing command on a
+line adjacent to it into the paragraph.
+
+In addition, Texinfo mode sets the @code{page-delimiter} variable to
+the value of @code{texinfo-chapter-level-regexp}; by default, this is
+a regular expression matching the commands for chapters and their
+equivalents, such as appendices. With this value for the page
+delimiter, you can jump from chapter title to chapter title with the
address@hidden ]} (@code{forward-page}) and @kbd{C-x [}
+(@code{backward-page}) commands and narrow to a chapter with the
address@hidden n p} (@code{narrow-to-page}) command. (@xref{Pages, , ,emacs,
+The GNU Emacs Manual}, for details about the page commands.)
+
+You may name a Texinfo file however you wish, but the convention is to
+end a Texinfo file name with one of the extensions
address@hidden, @file{.texi}, @file{.txi}, or @file{.tex}. A longer
+extension is preferred, since it is explicit, but a shorter extension
+may be necessary for operating systems that limit the length of file
+names. GNU Emacs automatically enters Texinfo mode when you visit a
+file with a @file{.texinfo}, @file{.texi} or @file{.txi}
+extension. Also, Emacs switches to Texinfo mode
+when you visit a
+file that has @samp{-*-texinfo-*-} in its first line. If ever you are
+in another mode and wish to switch to Texinfo mode, type @code{M-x
+texinfo-mode}.
+
+Like all other Emacs features, you can customize or enhance Texinfo
+mode as you wish. In particular, the keybindings are very easy to
+change. The keybindings described here are the default or standard
+ones.
+
address@hidden Inserting
address@hidden Inserting Frequently Used Commands
address@hidden Inserting frequently used commands
address@hidden Frequently used commands, inserting
address@hidden Commands, inserting them
+
+Texinfo mode provides commands to insert various frequently used
+@@-commands into the buffer. You can use these commands to save
+keystrokes.
+
+The insert commands are invoked by typing @kbd{C-c} twice and then the
+first letter of the @@-command:
+
address@hidden @kbd
address@hidden C-c C-c c
address@hidden M-x texinfo-insert-@@code
address@hidden texinfo-insert-@@code
+Insert @code{@@address@hidden@}} and put the
+cursor between the braces.
+
address@hidden C-c C-c d
address@hidden M-x texinfo-insert-@@dfn
address@hidden texinfo-insert-@@dfn
+Insert @code{@@address@hidden@}} and put the
+cursor between the braces.
+
address@hidden C-c C-c e
address@hidden M-x texinfo-insert-@@end
address@hidden texinfo-insert-@@end
+Insert @code{@@end} and attempt to insert the correct following word,
+such as @samp{example} or @samp{table}. (This command does not handle
+nested lists correctly, but inserts the word appropriate to the
+immediately preceding list.)
+
address@hidden C-c C-c i
address@hidden M-x texinfo-insert-@@item
address@hidden texinfo-insert-@@item
+Insert @code{@@item} and put the
+cursor at the beginning of the next line.
+
address@hidden C-c C-c k
address@hidden M-x texinfo-insert-@@kbd
address@hidden texinfo-insert-@@kbd
+Insert @code{@@address@hidden@}} and put the
+cursor between the braces.
+
address@hidden C-c C-c n
address@hidden M-x texinfo-insert-@@node
address@hidden texinfo-insert-@@node
+Insert @code{@@node} and a comment line
+listing the sequence for the `Next',
+`Previous', and `Up' nodes.
+Leave point after the @code{@@node}.
+
address@hidden C-c C-c o
address@hidden M-x texinfo-insert-@@noindent
address@hidden texinfo-insert-@@noindent
+Insert @code{@@noindent} and put the
+cursor at the beginning of the next line.
+
address@hidden C-c C-c s
address@hidden M-x texinfo-insert-@@samp
address@hidden texinfo-insert-@@samp
+Insert @code{@@address@hidden@}} and put the
+cursor between the braces.
+
address@hidden C-c C-c t
address@hidden M-x texinfo-insert-@@table
address@hidden texinfo-insert-@@table
+Insert @code{@@table} followed by a @key{SPC}
+and leave the cursor after the @key{SPC}.
+
address@hidden C-c C-c v
address@hidden M-x texinfo-insert-@@var
address@hidden texinfo-insert-@@var
+Insert @code{@@address@hidden@}} and put the
+cursor between the braces.
+
address@hidden C-c C-c x
address@hidden M-x texinfo-insert-@@example
address@hidden texinfo-insert-@@example
+Insert @code{@@example} and put the
+cursor at the beginning of the next line.
+
address@hidden address@hidden was the binding for texinfo-insert-braces;
address@hidden in Emacs 19, backward-paragraph will take this binding.
address@hidden C-c C-c @{
address@hidden M-x texinfo-insert-braces
address@hidden texinfo-insert-braces
+Insert @address@hidden@}} and put the cursor between the braces.
+
address@hidden C-c @}
address@hidden C-c ]
address@hidden M-x up-list
address@hidden up-list
+Move from between a pair of braces forward past the closing brace.
+Typing @kbd{C-c ]} is easier than typing @kbd{C-c @}}, which
+is, however, more mnemonic; hence the two keybindings. (Also, you can
+move out from between braces by typing @kbd{C-f}.)
address@hidden table
+
+To put a command such as @address@hidden@@address@hidden@address@hidden around
an
address@hidden word, position the cursor in front of the word and type
address@hidden 1 C-c C-c c}. This makes it easy to edit existing plain text.
+The value of the prefix argument tells Emacs how many words following
+point to include between address@hidden for one word, @samp{2} for
+two words, and so on. Use a negative argument to enclose the previous
+word or words. If you do not specify a prefix argument, Emacs inserts
+the @@-command string and positions the cursor between the braces. This
+feature works only for those @@-commands that operate on a word or words
+within one line, such as @code{@@kbd} and @code{@@var}.
+
+This set of insert commands was created after analyzing the frequency
+with which different @@-commands are used in the @cite{GNU Emacs
+Manual} and the @cite{GDB Manual}. If you wish to add your own insert
+commands, you can bind a keyboard macro to a key, use abbreviations,
+or extend the code in @file{texinfo.el}.
+
address@hidden texinfo-start-menu-description
address@hidden Menu description, start
address@hidden Description for menu, start
address@hidden C-c C-d} (@code{texinfo-start-menu-description}) is an insert
+command that works differently from the other insert commands. It
+inserts a node's section or chapter title in the space for the
+description in a menu entry line. (A menu entry has three parts, the
+entry name, the node name, and the description. Only the node name is
+required, but a description helps explain what the node is about.
address@hidden Parts, , The Parts of a Menu}.)
+
+To use @code{texinfo-start-menu-description}, position point in a menu
+entry line and type @kbd{C-c C-c C-d}. The command looks for and copies
+the title that goes with the node name, and inserts the title as a
+description; it positions point at beginning of the inserted text so you
+can edit it. The function does not insert the title if the menu entry
+line already contains a description.
+
+This command is only an aid to writing descriptions; it does not do the
+whole job. You must edit the inserted text since a title tends to use
+the same words as a node name but a useful description uses different
+words.
+
address@hidden Showing the Structure
address@hidden Showing the Sectioning Structure of a File
address@hidden Showing the sectioning structure of a file
address@hidden Sectioning structure of a file, showing
address@hidden Structure of a file, showing
address@hidden Outline of file structure, showing
address@hidden Contents-like outline of file structure
address@hidden File sectioning structure, showing
address@hidden Texinfo file sectioning structure, showing
+
+You can show the sectioning structure of a Texinfo file by using the
address@hidden C-s} command (@code{texinfo-show-structure}). This command
+lists the lines that begin with the @@-commands for @code{@@chapter},
address@hidden@@section}, and the like. It constructs what amounts to a table
+of contents. These lines are displayed in another buffer called the
address@hidden buffer. In that buffer, you can position the cursor
+over one of the lines and use the @kbd{C-c C-c} command
+(@code{occur-mode-goto-occurrence}), to jump to the corresponding spot
+in the Texinfo file.
+
address@hidden @kbd
address@hidden C-c C-s
address@hidden M-x texinfo-show-structure
address@hidden texinfo-show-structure
+Show the @code{@@chapter}, @code{@@section}, and such lines of a
+Texinfo file.
+
address@hidden C-c C-c
address@hidden M-x occur-mode-goto-occurrence
address@hidden occur-mode-goto-occurrence
+Go to the line in the Texinfo file corresponding to the line under the
+cursor in the @file{*Occur*} buffer.
address@hidden table
+
+If you call @code{texinfo-show-structure} with a prefix argument by
+typing @address@hidden C-c C-s}}, it will list not only those lines with the
+@@-commands for @code{@@chapter}, @code{@@section}, and the like, but
+also the @code{@@node} lines. You can use @code{texinfo-show-structure}
+with a prefix argument to check whether the `Next', `Previous', and `Up'
+pointers of an @code{@@node} line are correct.
+
+Often, when you are working on a manual, you will be interested only
+in the structure of the current chapter. In this case, you can mark
+off the region of the buffer that you are interested in by using the
address@hidden n n} (@code{narrow-to-region}) command and
address@hidden will work on only that region. To see
+the whole buffer again, use @address@hidden n w}} (@code{widen}).
+(@xref{Narrowing, , , emacs, The GNU Emacs Manual}, for more
+information about the narrowing commands.)
+
address@hidden page-delimiter
address@hidden Page delimiter in Texinfo mode
+In addition to providing the @code{texinfo-show-structure} command,
+Texinfo mode sets the value of the page delimiter variable to match
+the chapter-level @@-commands. This enables you to use the @kbd{C-x
+]} (@code{forward-page}) and @kbd{C-x [} (@code{backward-page})
+commands to move forward and backward by chapter, and to use the
address@hidden n p} (@code{narrow-to-page}) command to narrow to a chapter.
address@hidden, , , emacs, The GNU Emacs Manual}, for more information
+about the page commands.
+
+
address@hidden Updating Nodes and Menus
address@hidden Updating Nodes and Menus
+
address@hidden Updating nodes and menus
address@hidden Create nodes, menus automatically
address@hidden Insert nodes, menus automatically
address@hidden Automatically insert nodes, menus
+
+Texinfo mode provides commands for automatically creating or updating
+menus and node pointers. The commands are called ``update'' commands
+because their most frequent use is for updating a Texinfo file after you
+have worked on it; but you can use them to insert the `Next',
+`Previous', and `Up' pointers into an @code{@@node} line that has none
+and to create menus in a file that has none.
+
+If you do not use any updating commands, you need to write menus by
+hand, which is a tedious task.
+
address@hidden
+* Updating Commands:: Five major updating commands.
+* Updating Requirements:: How to structure a Texinfo file for
+ using the updating command.
+* Other Updating Commands:: How to indent descriptions, insert
+ missing nodes lines, and update
+ nodes in sequence.
address@hidden menu
+
address@hidden Updating Commands
address@hidden The Updating Commands
+
+You can use the updating commands to:
+
address@hidden @bullet
address@hidden
+insert or update the `Next', `Previous', and `Up' pointers of a node,
+
address@hidden
+insert or update the menu for a section, and
+
address@hidden
+create a master menu for a Texinfo source file.
address@hidden itemize
+
+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} line, except
+for the `Top' @code{@@node} line. (A @dfn{structuring command line} is
+a line beginning with @code{@@chapter}, @code{@@section}, or other
+similar command.)
+
+You can write the structuring command line on the line that follows
+immediately after an @code{@@node} line or else on the line that
+follows after a single @code{@@comment} line or a single
address@hidden@@ifinfo} line. You cannot interpose more than one line between
+the @code{@@node} line and the structuring command line; and you may
+interpose only a @code{@@comment} line or an @code{@@ifinfo} line.
+
+Commands which work on a whole buffer require that the `Top' node be
+followed by a node with a @code{@@chapter} 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}-level nodes! The menu
+updating commands only create menus @emph{within} nodes for lower level
+nodes. To create a menu of chapters, you must provide a `Top'
+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} 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} command is the primary command:
+
address@hidden @kbd
address@hidden C-c C-u m
address@hidden M-x texinfo-master-menu
address@hidden texinfo-master-menu
+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,} if interactive), first create or
+update all the nodes and all the regular menus in the buffer before
+constructing the master menu. (@xref{The Top Node, , The Top Node and
+Master Menu}, for more about a master menu.)
+
+For @code{texinfo-master-menu} to work, the Texinfo file must have a
+`Top' node and at least one subsequent node.
+
+After extensively editing a Texinfo file, you can type the following:
+
address@hidden
+C-u M-x texinfo-master-menu
address@hidden or
+C-u C-c C-u m
address@hidden example
+
address@hidden
+This updates all the nodes and menus completely and all at once.
address@hidden table
+
+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.
+
address@hidden 1000
+The commands are:
+
address@hidden @kbd
address@hidden C-c C-u C-n
address@hidden M-x texinfo-update-node
address@hidden texinfo-update-node
+Insert the `Next', `Previous', and `Up' pointers for the node that point is
+within (i.e., for the @code{@@node} line preceding point). If the
address@hidden@@node} line has pre-existing `Next', `Previous', or `Up'
+pointers in it, the old pointers are removed and new ones inserted.
+With an argument (prefix argument, @kbd{C-u}, if interactive), this command
+updates all @code{@@node} lines in the region (which is the text
+between point and mark).
+
address@hidden C-c C-u C-m
address@hidden M-x texinfo-make-menu
address@hidden texinfo-make-menu
+Create or update the menu in the node that point is within.
+With an argument (@kbd{C-u} 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} 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.
+
address@hidden C-c C-u C-e
address@hidden M-x texinfo-every-node-update
address@hidden texinfo-every-node-update
+Insert or update the `Next', `Previous', and `Up' pointers for every
+node in the buffer.
+
address@hidden C-c C-u C-a
address@hidden M-x texinfo-all-menus-update
address@hidden texinfo-all-menus-update
+Create or update all the menus in the buffer. With an argument
+(@kbd{C-u} 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} command
+updates it; but the command does not create a new master menu if none
+already exists. (Use the @code{texinfo-master-menu} command for
+that.)
+
+When working on a document that does not merit a master menu, you can
+type the following:
+
address@hidden
+C-u C-c C-u C-a
address@hidden or
+C-u M-x texinfo-all-menus-update
address@hidden example
+
address@hidden
+This updates all the nodes and menus.
address@hidden table
+
+The @code{texinfo-column-for-description} 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 (@pxref{Customization,,,
+emacs, The GNU Emacs Manual}) or with the @kbd{M-x set-variable}
+command (@pxref{Examining, , Examining and Setting Variables, emacs,
+The GNU Emacs Manual}).
+
+Also, the @code{texinfo-indent-menu-description} 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} command to
+insert missing @code{@@node} lines into a file. (@xref{Other Updating
+Commands}, for more information.)
+
address@hidden Updating Requirements
address@hidden Updating Requirements
address@hidden Updating requirements
address@hidden Requirements for updating commands
+
+To use the updating commands, you must organize the Texinfo file
+hierarchically with chapters, sections, subsections, and the like.
+When you construct the hierarchy of the manual, do not `jump down'
+more than one level at a time: you can follow the `Top' node with a
+chapter, but not with a section; you can follow a chapter with a
+section, but not with a subsection. However, you may `jump up' any
+number of levels at one time---for example, from a subsection to a
+chapter.
+
+Each @code{@@node} line, with the exception of the line for the `Top'
+node, must be followed by a line with a structuring command such as
address@hidden@@chapter}, @code{@@section}, or
address@hidden@@unnumberedsubsec}.
+
+Each @code{@@node} line/structuring-command line combination
+must look either like this:
+
address@hidden
address@hidden
+@@node Comments, Minimum, Conventions, Overview
+@@comment node-name, next, previous, up
+@@section Comments
address@hidden group
address@hidden example
+
+or like this (without the @code{@@comment} line):
+
address@hidden
address@hidden
+@@node Comments, Minimum, Conventions, Overview
+@@section Comments
address@hidden group
address@hidden example
+
+or like this (without the explicit node pointers):
+
address@hidden
address@hidden
+@@node Comments
+@@section Comments
address@hidden group
address@hidden example
+
address@hidden
+In this example, `Comments' is the name of both the node and the
+section. The next node is called `Minimum' and the previous node is
+called `Conventions'. The `Comments' section is within the `Overview'
+node, which is specified by the `Up' pointer. (Instead of an
address@hidden@@comment} line, you may also write an @code{@@ifinfo} line.)
+
+If a file has a `Top' node, it must be called @samp{top} or @samp{Top}
+and be the first node in the file.
+
+The menu updating commands create a menu of sections within a chapter,
+a menu of subsections within a section, and so on. This means that
+you must have a `Top' node if you want a menu of chapters.
+
+Incidentally, the @code{makeinfo} command will create an Info file for a
+hierarchically organized Texinfo file that lacks `Next', `Previous' and
+`Up' pointers. Thus, if you can be sure that your Texinfo file will be
+formatted with @code{makeinfo}, you have no need for the update node
+commands. (@xref{Creating an Info File}, for more information about
address@hidden)
+
+
address@hidden Other Updating Commands
address@hidden Other Updating Commands
+
+In addition to the five major updating commands, Texinfo mode
+possesses several less frequently used updating commands:
+
address@hidden @kbd
address@hidden M-x texinfo-insert-node-lines
address@hidden texinfo-insert-node-lines
+Insert @code{@@node} lines before the @code{@@chapter},
address@hidden@@section}, and other sectioning commands wherever they are
+missing throughout a region in a Texinfo file.
+
+With an argument (@kbd{C-u} as prefix argument, if interactive), the
+command @code{texinfo-insert-node-lines} not only inserts
address@hidden@@node} lines but also inserts the chapter or section titles as
+the names of the corresponding nodes. In addition, it inserts the
+titles as node names in pre-existing @code{@@node} lines that lack
+names. Since node names should be more concise than section or
+chapter titles, you must manually edit node names so inserted.
+
+For example, the following marks a whole buffer as a region and inserts
address@hidden@@node} lines and titles throughout:
+
address@hidden
+C-x h C-u M-x texinfo-insert-node-lines
address@hidden example
+
+This command inserts titles as node names in @code{@@node} lines; the
address@hidden command (@pxref{Inserting,
+Inserting Frequently Used Commands}) inserts titles as descriptions in
+menu entries, a different action. However, in both cases, you need to
+edit the inserted text.
+
address@hidden M-x texinfo-multiple-files-update
address@hidden texinfo-multiple-files-update @r{(in brief)}
+Update nodes and menus in a document built from several separate files.
+With @kbd{C-u} as a prefix argument, create and insert a master menu in
+the outer file. With a numeric prefix argument, such as @kbd{C-u 2}, first
+update all the menus and all the `Next', `Previous', and `Up' pointers
+of all the included files before creating and inserting a master menu in
+the outer file. The @code{texinfo-multiple-files-update} command is
+described in the appendix on @code{@@include} files.
address@hidden@code{texinfo-multiple-files-update}}.
+
address@hidden M-x texinfo-indent-menu-description
address@hidden texinfo-indent-menu-description
+Indent every description in the menu following point to the specified
+column. You can use this command to give yourself more space for
+descriptions. With an argument (@kbd{C-u} as prefix argument, if
+interactive), the @code{texinfo-indent-menu-description} command indents
+every description in every menu in the region. However, this command
+does not indent the second and subsequent lines of a multi-line
+description.
+
address@hidden M-x texinfo-sequential-node-update
address@hidden texinfo-sequential-node-update
+Insert the names of the nodes immediately following and preceding the
+current node as the `Next' or `Previous' pointers regardless of those
+nodes' hierarchical level. This means that the `Next' node of a
+subsection may well be the next chapter. Sequentially ordered nodes are
+useful for novels and other documents that you read through
+sequentially. (However, in Info, the @kbd{g *} command lets
+you look through the file sequentially, so sequentially ordered nodes
+are not strictly necessary.) With an argument (prefix argument, if
+interactive), the @code{texinfo-sequential-node-update} command
+sequentially updates all the nodes in the region.
address@hidden table
+
address@hidden Info Formatting
address@hidden Formatting for Info
address@hidden Formatting for Info
address@hidden Running an Info formatter
address@hidden Info formatting
+
+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---that is, a region.
+
+You can use either the @code{texinfo-format-region} or the
address@hidden command to format a region:
+
address@hidden @kbd
address@hidden texinfo-format-region
address@hidden C-c C-e C-r
address@hidden M-x texinfo-format-region
address@hidden C-c C-m C-r
address@hidden M-x makeinfo-region
+Format the current region for Info.
address@hidden table
+
+You can use either the @code{texinfo-format-buffer} or the
address@hidden command to format a whole buffer:
+
address@hidden @kbd
address@hidden texinfo-format-buffer
address@hidden C-c C-e C-b
address@hidden M-x texinfo-format-buffer
address@hidden C-c C-m C-b
address@hidden M-x makeinfo-buffer
+Format the current buffer for Info.
address@hidden table
+
address@hidden 1000
+For example, after writing a Texinfo file, you can type the following:
+
address@hidden
+C-u C-c C-u m
address@hidden or
+C-u M-x texinfo-master-menu
address@hidden example
+
address@hidden
+This updates all the nodes and menus. Then type the following to create
+an Info file:
+
address@hidden
+C-c C-m C-b
address@hidden or
+M-x makeinfo-buffer
address@hidden example
+
+For @TeX{} or the Info formatting commands to work, the file @emph{must}
+include a line that has @code{@@setfilename} in its header.
+
address@hidden an Info File}, for details about Info formatting.
+
address@hidden Printing
address@hidden node-name, next, previous, up
address@hidden Printing
address@hidden Formatting for printing
address@hidden Printing a region or buffer
address@hidden Region formatting and printing
address@hidden Buffer formatting and printing
address@hidden Part of file formatting and printing
+
+Typesetting and printing a Texinfo file is a multi-step process in
+which you first create a file for printing (called a DVI file), and
+then print the file. Optionally, you may also create indices. To do
+this, you must run the @code{texindex} command after first running the
address@hidden typesetting command; and then you must run the @code{tex}
+command again. Or else run the @code{texi2dvi} command which
+automatically creates indices as needed (@pxref{Format with
address@hidden).
+
+Often, when you are writing a document, you want to typeset and print
+only part of a file to see what it will look like. You can use the
address@hidden and related commands for this purpose. Use
+the @code{texinfo-tex-buffer} command to format all of a
+buffer.
+
address@hidden @kbd
address@hidden C-c C-t C-b
address@hidden M-x texinfo-tex-buffer
address@hidden texinfo-tex-buffer
+Run @code{texi2dvi} on the buffer. In addition to running @TeX{} on the
+buffer, this command automatically creates or updates indices as
+needed.
+
address@hidden C-c C-t C-r
address@hidden M-x texinfo-tex-region
address@hidden texinfo-tex-region
+Run @TeX{} on the region.
+
address@hidden C-c C-t C-i
address@hidden M-x texinfo-texindex
+Run @code{texindex} to sort the indices of a Texinfo file formatted with
address@hidden The @code{texinfo-tex-region} command does
+not run @code{texindex} automatically; it only runs the @code{tex}
+typesetting command. You must run the @code{texinfo-tex-region} command
+a second time after sorting the raw index files with the @code{texindex}
+command. (Usually, you do not format an index when you format a region,
+only when you format a buffer. Now that the @code{texi2dvi} command
+exists, there is little or no need for this command.)
+
address@hidden C-c C-t C-p
address@hidden M-x texinfo-tex-print
address@hidden texinfo-tex-print
+Print the file (or the part of the file) previously formatted with
address@hidden or @code{texinfo-tex-region}.
address@hidden table
+
+For @code{texinfo-tex-region} or @code{texinfo-tex-buffer} to work, the
+file @emph{must} start with a @samp{\input texinfo} line and must
+include a @code{@@settitle} line. The file must end with @code{@@bye}
+on a line by itself. (When you use @code{texinfo-tex-region}, you must
+surround the @code{@@settitle} line with start-of-header and
+end-of-header lines.)
+
address@hidden, for a description of the other @TeX{} related
+commands, such as @code{tex-show-print-queue}.
+
address@hidden Texinfo Mode Summary
address@hidden Texinfo Mode Summary
+
+In Texinfo mode, each set of commands has default keybindings that
+begin with the same keys. All the commands that are custom-created
+for Texinfo mode begin with @kbd{C-c}. The keys are somewhat
+mnemonic.
+
address@hidden Insert Commands
+
+The insert commands are invoked by typing @kbd{C-c} twice and then the
+first letter of the @@-command to be inserted. (It might make more
+sense mnemonically to use @kbd{C-c C-i}, for `custom insert', but
address@hidden C-c} is quick to type.)
+
address@hidden
+C-c C-c c @r{Insert} @samp{@@code}.
+C-c C-c d @r{Insert} @samp{@@dfn}.
+C-c C-c e @r{Insert} @samp{@@end}.
+C-c C-c i @r{Insert} @samp{@@item}.
+C-c C-c n @r{Insert} @samp{@@node}.
+C-c C-c s @r{Insert} @samp{@@samp}.
+C-c C-c v @r{Insert} @samp{@@var}.
+C-c @{ @r{Insert braces.}
+C-c ]
+C-c @} @r{Move out of enclosing braces.}
+
address@hidden
+C-c C-c C-d @r{Insert a node's section title}
+ @r{in the space for the description}
+ @r{in a menu entry line.}
address@hidden group
address@hidden example
+
address@hidden Show Structure
+
+The @code{texinfo-show-structure} command is often used within a
+narrowed region.
+
address@hidden
+C-c C-s @r{List all the headings.}
address@hidden example
+
address@hidden The Master Update Command
+
+The @code{texinfo-master-menu} command creates a master menu; and can
+be used to update every node and menu in a file as well.
+
address@hidden Probably should use @tables in this section.
address@hidden
address@hidden
+C-c C-u m
+M-x texinfo-master-menu
+ @r{Create or update a master menu.}
address@hidden group
+
address@hidden
+C-u C-c C-u m @r{With @kbd{C-u} as a prefix argument, first}
+ @r{create or update all nodes and regular}
+ @r{menus, and then create a master menu.}
address@hidden group
address@hidden example
+
address@hidden Update Pointers
+
+The update pointer commands are invoked by typing @kbd{C-c C-u} and
+then either @kbd{C-n} for @code{texinfo-update-node} or @kbd{C-e} for
address@hidden
+
address@hidden
+C-c C-u C-n @r{Update a node.}
+C-c C-u C-e @r{Update every node in the buffer.}
address@hidden example
+
address@hidden Update Menus
+
+Invoke the update menu commands by typing @kbd{C-c C-u}
+and then either @kbd{C-m} for @code{texinfo-make-menu} or
address@hidden for @code{texinfo-all-menus-update}. To update
+both nodes and menus at the same time, precede @kbd{C-c C-u
+C-a} with @kbd{C-u}.
+
address@hidden
+C-c C-u C-m @r{Make or update a menu.}
+
address@hidden
+C-c C-u C-a @r{Make or update all}
+ @r{menus in a buffer.}
address@hidden group
+
address@hidden
+C-u C-c C-u C-a @r{With @kbd{C-u} as a prefix argument,}
+ @r{first create or update all nodes and}
+ @r{then create or update all menus.}
address@hidden group
address@hidden example
+
address@hidden Format for Info
+
+The Info formatting commands that are written in Emacs Lisp are
+invoked by typing @kbd{C-c C-e} and then either @kbd{C-r} for a region
+or @kbd{C-b} for the whole buffer.
+
+The Info formatting commands that are written in C and based on the
address@hidden program are invoked by typing @kbd{C-c C-m} and then
+either @kbd{C-r} for a region or @kbd{C-b} for the whole buffer.
+
address@hidden 800
address@hidden
+Use the @address@hidden commands:
+
address@hidden
address@hidden
+C-c C-e C-r @r{Format the region.}
+C-c C-e C-b @r{Format the buffer.}
address@hidden group
address@hidden example
+
address@hidden 750
address@hidden
+Use @code{makeinfo}:
+
address@hidden
+C-c C-m C-r @r{Format the region.}
+C-c C-m C-b @r{Format the buffer.}
+C-c C-m C-l @r{Recenter the @code{makeinfo} output buffer.}
+C-c C-m C-k @r{Kill the @code{makeinfo} formatting job.}
address@hidden example
+
address@hidden Typeset and Print
+
+The @TeX{} typesetting and printing commands are invoked by typing
address@hidden C-t} and then another control command: @kbd{C-r} for
address@hidden, @kbd{C-b} for @code{texinfo-tex-buffer},
+and so on.
+
address@hidden
+C-c C-t C-r @r{Run @TeX{} on the region.}
+C-c C-t C-b @r{Run} @code{texi2dvi} @r{on the buffer.}
+C-c C-t C-i @r{Run} @code{texindex}.
+C-c C-t C-p @r{Print the DVI file.}
+C-c C-t C-q @r{Show the print queue.}
+C-c C-t C-d @r{Delete a job from the print queue.}
+C-c C-t C-k @r{Kill the current @TeX{} formatting job.}
+C-c C-t C-x @r{Quit a currently stopped @TeX{} formatting job.}
+C-c C-t C-l @r{Recenter the output buffer.}
address@hidden example
+
address@hidden Other Updating Commands
+
+The remaining updating commands do not have standard keybindings because
+they are rarely used.
+
address@hidden
address@hidden
+M-x texinfo-insert-node-lines
+ @r{Insert missing @code{@@node} lines in region.}
+ @r{With @kbd{C-u} as a prefix argument,}
+ @r{use section titles as node names.}
address@hidden group
+
address@hidden
+M-x texinfo-multiple-files-update
+ @r{Update a multi-file document.}
+ @r{With @kbd{C-u 2} as a prefix argument,}
+ @r{create or update all nodes and menus}
+ @r{in all included files first.}
address@hidden group
+
address@hidden
+M-x texinfo-indent-menu-description
+ @r{Indent descriptions.}
address@hidden group
+
address@hidden
+M-x texinfo-sequential-node-update
+ @r{Insert node pointers in strict sequence.}
address@hidden group
address@hidden example
+
+
@node Headings
@appendix Page Headings
@cindex Headings
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6526] make Texinfo Mode an appendix,
Gavin D. Smith <=