Prints help information on the specified built-ins in PredSpec on the
current output.
PredSpec
Predicate specification in form Name/Arity or an atom Name
Description
Prints help information about the specified built-in predicates to the
current output. The information displayed is a text version of the BIP
book. If only Name is specified, the system looks for all predicates
that have this atom in their name. If there are more than one predicate
matching, a short description for each one is printed, rather than the
whole page. For instance, help var prints the short description of
get_var_info/3, nonvar/1, readvar/3, var/1 and variant/2, whereas help
dv prints the whole BIP Book page for readvar/3.
Fail Conditions
Fails if no help is available for PredSpec.
Resatisfiable
no
Exceptions
Examples
Success:
help(nl/0). % Displays BIP book page on nl/0
help(write/X). % Displays short description of
% write/1 and write/2
help(X). % Displays short description of
% all built-ins
Fail:
help(nobip/1).