osd-help(3)

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

NAME

osd-help - GUI based on-line help

SYNOPSIS

osd-help

DESCRIPTION

osd-help provides a GUI front end to the on-line help manual, the dialog consists of 3 pages which are defined as follows:-

The contents page displays a list on contents similar to the help(2) high level help page. Selecting an item will display the help page in a buffer, selecting Exit will exit the dialog.

Index

The index page gives a list of help items, the Scope menu can be used to narrow the index list to the required item type.

Search

The search page provides a way of searching the on-line help for a given topic. Similarly to the Index page, the Scope menu is provided to narrow the search to the required area.

The search strings is considered to be made up of items separated by spaces, an item can be enclosed in quotes ('"') so that the item can include a space. If the first letter of an item is a '+' the given item must be found in a page for it to match, if the character is a '-' the item must NOT be found on a page for it to match, or other items are considered optional. At least one item must be found on a page for it to be a match, the numbers to the right of each found page is the number of items found.

NOTES

See Help! for help on the on-line help pages.

osd-help is a macro using osd(2), defined in osdhelp.emf.