Bookmark this page

Reading Info Documentation

Objectives

After completing this section, students should be able to find information from local documentation in GNU Info.

Introducing GNU Info

Man pages have a format useful as a command reference, but less useful as general documentation. For such documents, the GNU Project developed a different online documentation system, known as GNU Info. Info documents are an important resource on a Red Hat Enterprise Linux system because many fundamental components and utilities, such as the coreutils package and glibc standard libraries, are either developed by the GNU Project or utilize the Info document system.

Important

You might wonder why there are two local documentation systems, man pages and Info documents. Some of the reasons for this are practical in nature, and some have to do with the way Linux and its applications have been developed by various open source communities over the years.

Man pages have a much more formal format, and typically document a specific command or function from a software package, and are structured as individual text files. Info documents typically cover particular software packages as a whole, tend to have more practical examples of how to use the software, and are structured as hypertext documents.

You should be familiar with both systems in order to take maximum advantage of the information available to you from the system.

Reading Info Documentation

To launch the Info document viewer, use the pinfo command. pinfo opens in the top directory.

Figure 4.1: pinfo Info document viewer, top directory

Info documentation is comprehensive and hyperlinked. It is possible to output info pages to multiple formats. By contrast, man pages are optimized for printed output. The Info format is more flexible than man pages, allowing thorough discussion of complex commands and concepts. Like man pages, Info nodes are read from the command line, using the pinfo command.

A typical man page has a small amount of content focusing on one particular topic, command, tool, or file. The Info documentation is a comprehensive document. Info provides the following improvements:

  • One single document for a large system containing all the necessary information for that system

  • Hyperlinks

  • A complete browsable document index

  • A full text search of the entire document

Some commands and utilities have both man pages and info documentation; usually, the Info documentation is more in depth. Compare the differences in tar documentation using man and pinfo:

[user@host ~]$ man tar
[user@host ~]$ pinfo tar

The pinfo reader is more advanced than the original info command. To browse a specific topic, use the pinfo topic command. The pinfo command without an argument opens the top directory. New documentation becomes available in pinfo when their software packages are installed.

Note

If no Info topic exists in the system for a particular entry that you requested, Info will look for a matching man page and display that instead.

Comparing GNU Info and Man Page Navigation

The pinfo command and the man command use slightly different navigational keystrokes. The following table compares the navigational keystrokes for both commands:

Table 4.4. pinfo and man, key binding comparison

Navigationpinfoman
Scroll forward (down) one screenPageDown or SpacePageDown or Space
Scroll backward (up) one screenPageUp or bPageUp or b
Display the directory of topicsd-
Scroll forward (down) one half-screen-d
Display the parent node of a topicu-
Display the top (up) of a topicHOMEg
Scroll backward (up) one half-screen-u
Scroll forward (down) to next hyperlinkDownArrow-
Open topic at cursor locationEnter-
Scroll forward (down) one line-DownArrow or Enter
Scroll backward (up) to previous hyperlinkUpArrow-
Scroll backward (up) one line-UpArrow
Search for a pattern/string/string
Display next node (chapter) in topicn-
Repeat previous search forward (down)/ then Entern
Display previous node (chapter) in topicp-
Repeat previous search backward (up)-N
Quit the programqq

References

pinfo info (Info: An Introduction)

pinfo pinfo (Documentation for pinfo)

The GNU Project http://www.gnu.org/gnu/thegnuproject.html

pinfo(1) and info(1) man pages

Revision: rh124-8.2-df5a585