GNU Texinfo

https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html
Admin
GNU Texinfo is the official documentation system for the GNU project, providing a single source...
Tokens:153,804
Snippets:1,085
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example included file foo.texinfo

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the structure of an included file, starting with a node and chapter heading.

```texinfo
@node First, Second, , Top
@chapter First Chapter

Contents of first chapter ...
```

--------------------------------

### @example with mv command and its output

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Illustrates the @example environment with a simple shell command. The lines containing @example and @end example disappear from the output, and the command is displayed as-is. Blank lines before and after the environment are recommended for appearance.

```texinfo
@example
mv foo bar
@end example
```

```text
mv foo bar
```

--------------------------------

### @example command usage example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the syntax of the @example environment with a sample block of text. The text is indented, not filled, and typeset in a fixed-width font in the printed manual. In the Info file, each line is indented with five spaces.

```texinfo
This is an example of text written between an
@example command
and an @end example command.
The text is indented but not filled.

In the printed manual, the text is typeset in a
fixed-width font, and extra spaces and blank lines are
significant.  In the Info file, an analogous result is
obtained by indenting each line with five spaces.
```

--------------------------------

### Texinfo @table with @samp example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Example of a two-column table using @table @samp. Each entry starts with @item, the first column text is on the same line, and the second column text follows on subsequent lines. Blank lines before @item are recommended for better formatting in Info files.

```texinfo
@table @samp
@item foo
This is the text for
@samp{foo}.

@item bar
Text for @samp{bar}.
@end table
```

--------------------------------

### @sc command output example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the output produced by the @sc example. The text is rendered in small caps in printed and HTML output, and in uppercase in Info files.

```text
The ACM and IEEE are technical societies.
```

--------------------------------

### @defvar example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Example of the @defvar command, equivalent to @defvr Variable ... . Terminate with @end defvar.

```texinfo
@defvar kill-ring
...
@end defvar
```

--------------------------------

### Index entries placement example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows how to place index entries before the paragraph they apply to, with a blank line after the index entry for 'Leaping'. The example uses @section and @cindex commands.

```texinfo
@section The Dog and the Fox
@cindex Jumping, in general
@cindex Leaping

@cindex Dog, lazy, jumped over
@cindex Lazy dog jumped over
@cindex Fox, jumps over dog
@cindex Quick fox jumps over dog
The quick brown fox jumps over the lazy dog.
```

--------------------------------

### Example dir file menu entries

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Example of menu entries in the dir file that list only file names, taking readers directly to the Top nodes of each Info document.

```texinfo
* Info: (info).         Documentation browsing system.
* Emacs: (emacs).       The extensible, self-documenting
                        text editor.
```

--------------------------------

### @xref example with four and five arguments

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Example of @xref with four and five arguments, referencing 'Electrical Effects' in the 'weather' Info file. Produces the Info output shown.

```texinfo
@xref{Electrical Effects, Lightning, Thunder and Lightning,
weather, An Introduction to Meteorology}, for details.
```

```text
*Note Lightning: (weather)Electrical Effects, for details.
```

--------------------------------

### @noindent example source and output

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Illustrates @noindent, which prevents indentation of text following an example. The command is placed on a line by itself before the continuation text. The output shows the text starting flush left.

```texinfo
@example
This is an example
@end example

@noindent
This line is not indented.  As you can see, the
beginning of the line is fully flush left with the line
that follows after it.  (This whole example is between
@code{@@display} and @code{@@end display}.)
```

```text
This is an example



This line is not indented.  As you can see, the
beginning of the line is fully flush left with the line
that follows after it.  (This whole example is between
@display and @end display.)
```

--------------------------------

### install-info synopsis

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the command-line syntax for install-info. The info-file and dir-file arguments are optional if the corresponding options are provided. There are no compile-time defaults and standard input is never used.

```bash
install-info [option]... [info-file [dir-file]]
```

--------------------------------

### @setchapternewpage odd example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Causes each chapter to start on a fresh odd-numbered page and formats for double-sided printing. This is the form most often used for books and manuals.

```texinfo
@setchapternewpage odd
```

--------------------------------

### Example of a new menu entry for GDB

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the format for adding a new Info file to the 'dir' menu. The entry includes the menu name, file name in parentheses, and a description. The '.info' extension is omitted to avoid clutter.

```plaintext
* GDB: (gdb).           The source-level C debugger.
```

--------------------------------

### Using @need to prevent page breaks

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

A line containing only @need n starts a new page if fewer than n mils remain. Do not use braces around the argument. This example uses @need 800 to ensure at least 800 mils remain before the following paragraph.

```texinfo
@need 800
This paragraph is preceded by ...
```

--------------------------------

### Example of the 'dir' file menu

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the top-level menu format used in the 'dir' file. Each entry points to the 'Top' node of an Info file, with the file name in parentheses and a description.

```plaintext
* Menu:
* Info:    (info).     Documentation browsing system.
* Emacs:   (emacs).    The extensible, self-documenting
                       text editor.
* Texinfo: (texinfo).  With one source file, make
                       either a printed manual using
                       @TeX{} or an Info file.
...
```

--------------------------------

### @cartouche example with @example block

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Use @cartouche inside an @example block to draw a rounded rectangle around the example in printed manuals. It has no effect in other output files.

```texinfo
@example
@cartouche
% pwd
/usr/local/share/emacs
@end cartouche
@end example
```

--------------------------------

### @verbatim environment example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the @verbatim environment with a sample block of text. No character substitutions are made, all commands are ignored until @end verbatim, and the text is typeset in a fixed-width font without indentation or filling. All spaces and blank lines are significant, including tabs.

```texinfo
This is an example of text written in a @verbatim
block.  No character substitutions are made.  All commands
are ignored, until `end verbatim'.

In the printed manual, the text is typeset in a
fixed-width font, and not indented or filled.  All
spaces and blank lines are significant, including tabs.
```

--------------------------------

### Using @group inside @example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Place @group and @end group inside @example and @end example to keep the example on one page. @group works reliably only within @example, @display, @format, @flushleft, and @flushright. Forgetting @end group can cause strange TeX error messages.

```texinfo
@example
@group
...
@end group
@end example
```

--------------------------------

### @exdent example source and output

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows how @exdent removes indentation from a single line within an @example block. The command is placed at the beginning of a line without braces. The output demonstrates the exdented line appearing without indentation.

```texinfo
@example
This line follows an @@example command.
@exdent This line is exdented.
This line follows the exdented line.
The @@end example comes on the next line.
@end group
```

```text
This line follows an @example command.

This line is exdented.

This line follows the exdented line.
The @end example comes on the next line.
```

--------------------------------

### Complete multitable example with @item and @tab

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

A complete example of a multi-column table. Rows begin with @item and columns are separated by @tab. The example uses @columnfractions .15 .45 .4 and produces a table with Key, Command, and Description columns.

```texinfo
@multitable @columnfractions .15 .45 .4
@item Key @tab Command @tab Description
@item C-x 2
@tab @code{split-window-vertically}
@tab Split the selected window into two windows,
with one above the other.
@item C-x 3
@tab @code{split-window-horizontally}
@tab Split the selected window into two windows
positioned side by side.
@item C-Mouse-2
@tab
@tab In the mode line or scroll bar of a window,
split that window.
@end multitable
```

--------------------------------

### @defun apply function &rest arguments

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

A sample function definition using the @defun command, demonstrating how to document a Lisp function with parameters and examples.

```APIDOC
## @defun apply function &rest arguments

### Description
Defines the Lisp function `apply`, which calls `function` with `arguments`, appending the last argument list to the other arguments. Returns the result of calling `function`.

### Syntax
@defun apply function &rest arguments
...
@end defun

### Parameters
- **function** (Lisp function or primitive function) - Required - The function to call.
- **arguments** (&rest) - Required - Arguments to pass to `function`; the last argument is a list appended to the others.

### Example
```lisp
(setq f 'list)
     => list
(apply f 'x 'y 'z)
     error--> Wrong type argument: listp, z
(apply '+ 1 2 '(3 4))
     => 10
(apply '+ '(1 2 3 4))
     => 10

(apply 'append '((a b c) nil (x y z) nil))
     => (a b c x y z)
```

### Notes
- `function` must be a Lisp function or a primitive function; special forms and macros are not allowed.
- The last argument is appended to the other arguments.
```

--------------------------------

### @titlefont{Texinfo} example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Use @titlefont to select a large font for the title. This example shows the command with the argument 'Texinfo'.

```texinfo
@titlefont{Texinfo}
```

--------------------------------

### Short Sample Texinfo File

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

A complete minimal Texinfo file demonstrating the basic structure: header, copying, titlepage, contents, menu, chapters, index, and @bye. Use as a starting template for simple manuals.

```texinfo
\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename sample.info
@settitle Sample Manual 1.0
@c %**end of header

@copying
This is a short example of a complete Texinfo file.

Copyright (C) 2002 Free Software Foundation, Inc.
@end copying

@titlepage
@title Sample Title
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@c Output the table of the contents at the beginning.
@contents

@ifnottex
@node Top

@insertcopying
@end ifnottex

@menu
* First Chapter::    The first chapter is the
                       only chapter in this sample.
* Index::            Complete index.
@end menu


@node First Chapter
@chapter First Chapter

@cindex chapter, first

This is the first chapter.
@cindex index entry, another

Here is a numbered list.

@enumerate
@item
This is the first item.

@item
This is the second item.
@end enumerate


@node Index
@unnumbered Index

@printindex cp

@bye

```

--------------------------------

### Update all nodes and menus then format buffer for Info

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

First updates all nodes and menus with texinfo-master-menu, then creates an Info file with makeinfo-buffer. The file must include a line with @setfilename in its header for formatting to work.

```emacs-lisp
C-u C-c C-u m

or

C-u M-x texinfo-master-menu
```

```emacs-lisp
C-c C-m C-b

or

M-x makeinfo-buffer
```

--------------------------------

### @sp 2 example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Use @sp to insert vertical space. This example inserts two blank lines on the printed page.

```texinfo
@sp 2
```

--------------------------------

### Texinfo source for @point{} example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

The Texinfo source that produces the buffer examples above. Uses @point{} to indicate point and @result{} for the return value.

```texinfo
@example
---------- Buffer: foo ----------
This is the @point{}contents of foo.
---------- Buffer: foo ----------

(insert "changed ")
     @result{} nil
---------- Buffer: foo ----------
This is the changed @point{}contents of foo.
---------- Buffer: foo ----------
@end example
```

--------------------------------

### @r command output example

Source: https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html

Shows the printed output of the @r example. The comment appears in roman font instead of the fixed-width font.

```text
(+ 2 2)    ; Add two plus two.
```
Tokens:
Raw