# info(3)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

info - Display a GNU Info database
info-on - Display Info on a given topic
info-goto-link - Display Info on a given link
$INFOPATH - GNU info files base directory
.info.path - Cached info search path

## SYNOPSIS

info

info-on topic-str

info-goto-link link-str

$INFOPATH string

.info.path string

## DESCRIPTION

info interprets the GNU info pages, and presents the info file information within a buffer window called `*info XXXXX`, where `XXXXX` is the name of the info file. The root of the info page is displayed and may be traversed by selecting the links with the mouse, or by using the standard info traversal keys.

The root of the info tree is, by default, a file called dir, which points to the other information sources. The default search paths for the info directories are:-

`c:/info` - MS-DOS and MS-Windows (all).
`/usr/local/info` - All UNIX platforms.

The root directory may also be specified with the `$INFOPATH` environment variable. This is a colon (`:`) or semi-colon (`;`) separated list of directory paths which specify the locations of the info files, for UNIX and Microsoft DOS/Windows environment's, respectively.

info-on gets info on a user specified top level topic, e.g. "`gcc`", the info file "topic-str`.info`" must be found in the info search path.

info-goto-link gets and displays info on a user specified link or subject. The link may be within the currently displayed topic (the link-str need only specify the subject node name) or a subject within another topic (in which case the link-str takes the following form "`(`topic`)` subject").

## NOTES

info is a macro implemented in file `info.emf`.

When an info command is run for the first time, the info search path is constructed and stored locally in the command variable .info.path. This variable must be directly changed by the user if changes to the info search path are required.

## SEE ALSO

info(9).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>