:help

Arguments: &optional command-name

Without an argument, this command prints a summary of the commands, mostly consisting of name, abbreviation, and valid arguments; if command-name is present, it prints more detailed documentation about the command. Commands added with tpl:alias will be included in the list, with [alias] as part of the description. Documentation strings and abbreviations will shown for alias commands.

This command will print a `page' of output at a time (page is defined below). When a page has been output, the system will pause. Entering a return at that point will cause the next page to be displayed. Entering a number causes the command to take that value as the page size (the value holds for this call to :help only). Any fixnum may be entered. A negative or zero value causes the remainder of the output to be displayed with no further breaks.

A page is defined to be *help-page-length* number of lines, if the value of that variable is a positive integer. If the value is negative or zero, :help will print without pausing.

The minimal abbreviation of :help is :he.

See top-level.htm for more information on top-level commands.

Copyright (c) 1998-2006, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 7.0. The object described on this page has been modified in the 7.0 release; see the Release Notes.
Created 2005.9.20.