Go to the first, previous, next, last section, table of contents.

Info

The

On-line, Menu-driven

GNU Documentation System

Copyright (C) 1989, 1992, 1993 Free Software Foundation, Inc.

Published by the Free Software Foundation
675 Massachusetts Avenue,
Cambridge, MA 02139 USA

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation.

@paragraphindent 3

- Getting Started: Getting started using an Info reader.
- Advanced Info: Advanced commands within Info.
- Create an Info File: How to make your own Info file.

# Getting Started

This first part of the Info manual describes how to get around inside of Info. The second part of the manual describes various advanced Info commands, and how to write an Info as distinct from a Texinfo file. The third part is about how to generate Info files from Texinfo files.

This manual is primarily designed for use on a computer, so that you can try Info commands while reading about them. Reading it on paper is less effective, since you must take it on faith that the commands described really do what the manual says. By all means go through this manual now that you have it; but please try going through the on-line version as well.

There are two ways of looking at the online version of this manual:

1. Type `info` at your shell's command line. This approach uses a stand-alone program designed just to read Info files.
2. Type `emacs` at the command line; then type `C-h i` (Control `h`, followed by `i`). This approach uses the Info mode of the Emacs program, an editor with many other capabilities.

In either case, then type `mInfo` (just the letters), followed by `RET`---the "Return" or "Enter" key. At this point, you should be ready to follow the instructions in this manual as you read them on the screen.

- Help-Small-Screen: Starting Info on a Small Screen
- Help: How to use Info
- Help-P: Returning to the Previous node
- Help-^L: The Space, Rubout, B and ^L commands.
- Help-M: Menus
- Help-Adv: Some advanced Info commands
- Help-Q: Quitting Info

## Starting Info on a Small Screen

(In Info, you only see this section if your terminal has a small number of lines; most readers pass by it without seeing it.)

Since your terminal has an unusually small number of lines on its screen, it is necessary to give you special advice at the beginning.

If you see the text ``--All----'` at near the bottom right corner of the screen, it means the entire text you are looking at fits on the screen. If you see ``--Top----'` instead, it means that there is more text below that does not fit. To move forward through the text and see another screen full, press the Space bar, `SPC`. To move back up, press the key labeled ``Delete'` or `DEL`.

## How to use Info

You are talking to the program Info, for reading documentation.

Right now you are looking at one Node of Information. A node contains text describing a specific topic at a specific level of detail. This node's topic is "how to use Info".

The top line of a node is its header. This node's header (look at it now) says that it is the node named ``Help'` in the file ``info'`. It says that the ``Next'` node after this one is the node called ``Help-P'`. An advanced Info command lets you go to any node whose name you know.

Besides a ``Next'`, a node can have a ``Previous'` or an ``Up'`. This node has a ``Previous'` which is ``Help-Small-Screen'`, and an ``Up'` which is ``Getting Started'`. Some nodes have no ``Previous'` and some have no ``Up'`.

Now it is time to move on to the ``Next'` node, named ``Help-P'`.

    >> Type `n' to move there.  Type just one character;
       do not type the quotes and do not type a RET afterward.

``>>'` in the margin means it is really time to try a command.

## Returning to the Previous node

This node is called ``Help-P'`. The ``Previous'` node, as you see, is ``Help'`, which is the one you just came from using the `n` command. Another `n` command now would take you to the next node, ``Help-^L'`.

    >> But do not do that yet.  First, try the p command, which takes
       you to the `Previous' node.  When you get there, you can do an
       n again to return here.

This all probably seems insultingly simple so far, but do not be led into skimming. Things will get more complicated soon. Also, do not try a new command until you are told it is time to. Otherwise, you may make Info skip past an important warning that was coming up.

    >> Now do an n to get to the node `Help-^L' and learn more.

## The Space, Delete, B and ^L commands.

This node's header tells you that you are now at node ``Help-^L'`, and that `p` would get you back to ``Help-P'`. The node's title is underlined; it says what the node is about (most nodes have titles).

This is a big node and it does not all fit on your display screen. You can tell that there is more that is not visible because you can see the string ``--Top-----'` rather than ``--All----'` near the bottom right corner of the screen.

The Space, Delete and `B` commands exist to allow you to "move around" in a node that does not all fit on the screen at once. Space moves forward, to show what was below the bottom of the screen. Delete moves backward, to show what was above the top of the screen (there is not anything above the top until you have typed some spaces).

    >> Now try typing a Space (afterward, type a Delete to return here).

When you type the space, the two lines that were at the bottom of the screen appear at the top, followed by more lines. Delete takes the two lines from the top and moves them to the bottom, usually, but if there are not a full screen's worth of lines above them they may not make it all the way to the bottom.

Space and Delete scroll through all the nodes in an Info file as a single logical sequence. In this sequence, a node's subnodes appear following their parent. If a node's menu is on the screen, Space takes you into the subnodes listed in the menu, one by one. Once you reach the end of a node, Space takes you to the next node or back to the parent node.

If your screen is ever garbaged, you can tell Info to print it out again by typing `C-l` (`Control-L`, that is--hold down "Control" and type an `L` or `l`).

    >> Type C-l now.

To move back to the beginning of the node you are on, you can type a lot of Deletes. You can also type simply `b` for beginning.

    >> Try that now.  (We have put in enough verbiage to push this past
    the first screenful, but screens are so big nowadays that perhaps it
    isn't enough.  You may need to shrink your Emacs or Info window.)
    Then come back, with Spaces.

If your screen is very tall, all of this node might fit at once. In that case, "b" won't do anything. Sorry; what can we do?

You have just learned a considerable number of commands. If you want to use one but have trouble remembering which, you should type a `?` which prints out a brief list of commands. When you are finished looking at the list, make it go away by typing a `SPC`.

    >> Type a ? now.  After it finishes, type a SPC.

(If you are using the standalone Info reader, type `l' to return here.)

From now on, you will encounter large nodes without warning, and will be expected to know how to use Space and Delete to move around in them without being told. Since not all terminals have the same size screen, it would be impossible to warn you anyway.

    >> Now type n to see the description of the m command.

## Menus

Menus and the `m` command

With only the `n` and `p` commands for moving between nodes, nodes are restricted to a linear sequence. Menus allow a branching structure. A menu is a list of other nodes you can move to. It is actually just part of the text of the node formatted specially so that Info can interpret it. The beginning of a menu is always identified by a line which starts with ``* Menu:'`. A node contains a menu if and only if it has a line in it which starts that way. The only menu you can use at any moment is the one in the node you are in. To use a menu in any other node, you must move to that node first.

After the start of the menu, each line that starts with a ``*'` identifies one subtopic. The line usually contains a brief name for the subtopic (followed by a ``:'`), the name of the node that talks about that subtopic, and optionally some further description of the subtopic. Lines in the menu that do not start with a ``*'` have no special meaning--they are only for the human reader's benefit and do not define additional subtopics. Here is an example:

    * Foo:  FOO's Node      This tells about FOO

The subtopic name is Foo, and the node describing it is ``FOO's Node'`. The rest of the line is just for the reader's Information. [[ But this line is not a real menu item, simply because there is no line above it which starts with ``* Menu:'`.]]

When you use a menu to go to another node (in a way that will be described soon), what you specify is the subtopic name, the first thing in the menu line. Info uses it to find the menu line, extracts the node name from it, and goes to that node. The reason that there is both a subtopic name and a node name is that the node name must be meaningful to the computer and may therefore have to be ugly looking. The subtopic name can be chosen just to be convenient for the user to specify. Often the node name is convenient for the user to specify and so both it and the subtopic name are the same. There is an abbreviation for this:

    * Foo::   This tells about FOO

This means that the subtopic name and node name are the same; they are both ``Foo'`.

    >> Now use Spaces to find the menu in this node, then come back to
       the front with a b and some Spaces.  As you see, a menu is
       actually visible in its node.  If you cannot find a menu in a node
       by looking at it, then the node does not have a menu and the
       m command is not available.

The command to go to one of the subnodes is `m`---but do not do it yet! Before you use `m`, you must understand the difference between commands and arguments. So far, you have learned several commands that do not need arguments. When you type one, Info processes it and is instantly ready for another command. The `m` command is different: it is incomplete without the name of the subtopic. Once you have typed `m`, Info tries to read the subtopic name.

Now look for the line containing many dashes near the bottom of the screen. There is one more line beneath that one, but usually it is blank. If it is empty, Info is ready for a command, such as `n` or `b` or Space or `m`. If that line contains text ending in a colon, it mean Info is trying to read the argument to a command. At such times, commands do not work, because Info tries to use them as the argument. You must either type the argument and finish the command you started, or type `Control-g` to cancel the command. When you have done one of those things, the line becomes blank again.

The command to go to a subnode via a menu is `m`. After you type the `m`, the line at the bottom of the screen says ``Menu item: '`. You must then type the name of the subtopic you want, and end it with a `RET`.

You can abbreviate the subtopic name. If the abbreviation is not unique, the first matching subtopic is chosen. Some menus put the shortest possible abbreviation for each subtopic name in capital letters, so you can see how much you need to type. It does not matter whether you use upper case or lower case when you type the subtopic. You should not put any spaces at the end, or inside of the item name, except for one space where a space appears in the item in the menu.

You can also use the completion feature to help enter the subtopic name. If you type the Tab key after entering part of a name, it will magically fill in more of the name--as much as follows uniquely from what you have entered.

If you move the cursor to one of the menu subtopic lines, then you do not need to type the argument: you just type a Return, and it stands for the subtopic of the line you are on.

Here is a menu to give you a chance to practice.

This menu gives you three ways of going to one place, Help-FOO.
- Foo: A node you can visit for fun.
- Bar: Strange! two ways to get to the same place.
- Help-FOO: And yet another!

    >>  Now type just an m and see what happens:

Now you are "inside" an `m` command. Commands cannot be used now; the next thing you will type must be the name of a subtopic.

You can change your mind about doing the `m` by typing Control-g.

    >> Try that now;  notice the bottom line clear.

    >> Then type another m.

    >> Now type `BAR' item name.  Do not type Return yet.

While you are typing the item name, you can use the Delete key to cancel one character at a time if you make a mistake.

    >> Type one to cancel the `R'.  You could type another `R' to
       replace it.  You do not have to, since `BA' is a valid abbreviation.

    >> Now you are ready to go.  Type a RET.

After visiting Help-FOO, you should return here.

    >> Type n to see more commands.

### The `u` command

Congratulations! This is the node ``Help-FOO'`. Unlike the other nodes you have seen, this one has an ``Up'`: ``Help-M'`, the node you just came from via the `m` command. This is the usual convention--the nodes you reach from a menu have ``Up'` nodes that lead back to the menu. Menus move Down in the tree, and ``Up'` moves Up. ``Previous'`, on the other hand, is usually used to "stay on the same level but go backwards"

You can go back to the node ``Help-M'` by typing the command `u` for "Up". That puts you at the front of the node--to get back to where you were reading you have to type some `SPC`s.

    >> Now type u to move back up to `Help-M'.

## Some advanced Info commands

The course is almost over, so please stick with it to the end.

If you have been moving around to different nodes and wish to retrace your steps, the `l` command (`l` for last) will do that, one node-step at a time. As you move from node to node, Info records the nodes where you have been in a special history list. The `l` command revisits nodes in the history list; each successive `l` command moves one step back through the history.

If you have been following directions, an `l` command now will get you back to ``Help-M'`. Another `l` command would undo the `u` and get you back to ``Help-FOO'`. Another `l` would undo the `m` and get you back to ``Help-M'`.

    >> Try typing three l's, pausing in between to see what each
        l does.

Then follow directions again and you will end up back here.

Note the difference between `l` and `p`: `l` moves to where you last were, whereas `p` always moves to the node which the header says is the ``Previous'` node (from this node, to ``Help-M'`).

The ``d'` command gets you instantly to the Directory node. This node, which is the first one you saw when you entered Info, has a menu which leads (directly, or indirectly through other menus), to all the nodes that exist.

    >> Try doing a `d', then do an l to return here (yes,
       do return).

Sometimes, in Info documentation, you will see a cross reference. Cross references look like this: See section The node reached by the cross reference in Info. That is a real, live cross reference which is named ``Cross'` and points at the node named ``Help-Cross'`.

If you wish to follow a cross reference, you must use the ``f'` command. The ``f'` must be followed by the cross reference name (in this case, ``Cross'`). While you enter the name, you can use the Delete key to edit your input. If you change your mind about following any reference, you can use `Control-g` to cancel the command.

Completion is available in the ``f'` command; you can complete among all the cross reference names in the current node by typing a Tab.

    >> Type `f', followed by `Cross', and a RET.

To get a list of all the cross references in the current node, you can type `?` after an ``f'`. The ``f'` continues to await a cross reference name even after printing the list, so if you don't actually want to follow a reference, you should type a `Control-g` to cancel the ``f'`.

    >> Type "f?" to get a list of the cross references in this node.  Then
       type a Control-g and see how the `f' gives up.

    >> Now type n to see the last node of the course.

### The node reached by the cross reference in Info

This is the node reached by the cross reference named ``Cross'`.

While this node is specifically intended to be reached by a cross reference, most cross references lead to nodes that "belong" someplace else far away in the structure of Info. So you cannot expect the footnote to have a ``Next'`, ``Previous'` or ``Up'` pointing back to where you came from. In general, the `l` (el) command is the only way to get back there.

    >> Type l to return to the node where the cross reference was.

## Quitting Info

To get out of Info, back to what you were doing before, type `q` for Quit.

This is the end of the course on using Info. There are some other commands that are meant for experienced users; they are useful, and you can find them by looking in the directory node for documentation on Info. Finding them will be a good exercise in using Info in the usual manner.

    >> Type `d' to go to the Info directory node; then type
       `mInfo' and Return, to get to the node about Info and
       see what other help is available.

Go to the first, previous, next, last section, table of contents.