Star Sapphire Common LISP Home

Download Star Saphire
Index

LISP: QHELP

C: Lqhelp

min args: 1

max args: 1

[F][SSCL]

SYNOPSIS:

qhelp topic

DESCRIPTION:

This function provides quick help on the given topic (which can be either a symbol or a string) if it has been defined in the help This requires that the file qhelp.htx is either in the current directory or in the list of directories specified in the DOS environment variable 'PATH'. The Star Sapphire installation process installs this file in the LISP installation directory.

The file is displayed using the popfile tool.

This facility is also available in EMACS; in this case the help file is displayed in a view buffer so that the information can be copied into other windows.

If the given topic is not in the qhelp.htx database, then NIL is returned; to search the complete help database for available topics, use the help system.

SEE ALSO:

help

LISP: QUIT

C: Bye

min args: 0

max args: 0

[F][SSCL]

SYNOPSIS:

quit

DESCRIPTION:

The Star Sapphire specific quit function unconditionally quits the intepreter session, deleting the swap file.

SEE ALSO:

bye, exit

LISP: QUOTE

C: SFCQuote, EQuote

[F][SSCL 7]

SYNOPSIS:

quote object

DESCRIPTION:

The quote special form allows any LISP object to be used as a constant value in a program. The object itself is returned. The object is not evaluated. The object may be any LISP object whatsoever.

For instance, suppose that x has been assigned the value 15; then evaluating

x

produces

15

but evaluating

(quote x)

will produce

x

itself.

Note that most LISP objects are self-evaluating; thus using a quote form, with a number, a character or a string (for instance) is superflous but not harmful.

Where quote proves most useful is in conjunction with objects that when evaluated, have an entirely different meaning than when used as data; most notably lists and symbols.

Since quote is one of the most commonly used constructs, a standard macro-character abbreviation is defined for it.

Any form x preceded by a single quote (') character will have a (quote) wrapped around in the reader to produce (quote x).

For example:

(setq x '(foo bar baz))

is equivalent to

(setq x (quote (foo bar baz)))