object

# help

> Command-line help for Logtalk built-in control constructs, predicates, non-terminals, and methods.

author:
  `Paulo Moura`
version:
  `0.1`
date:
  `2016/6/29`

compilation flags:
  `static, context_switching_calls`

implements:
  `public forwarding`

## Public interface

### help/0

> Prints instructions on how to use the help tool.

compilation flags:
  `static`
mode – number of proofs:
  `help – one`

### (/)/2

> Provides help on the Functor/Arity built-in control construct, directive, predicate, or method.

compilation flags:
  `static`
template:
  `Functor/Arity`
mode – number of proofs:
  `+atom/ +integer – zero_or_one`

### (//)/2

> Provides help on the Functor//Arity built-in non-terminal.

compilation flags:
  `static`
template:
  `Functor//Arity`
mode – number of proofs:
  `+atom// +integer – zero_or_one`

### completion/2

> Provides a completion pair (Completion-Page) for a given prefix.

compilation flags:
  `static`
template:
  `completion(Prefix,Completion)`
mode – number of proofs:
  `completion(+atom,-pair) – zero_or_more`

### completions/2

> Provides a list of completions pairs (Completion-Page) for a given prefix.

compilation flags:
  `static`
template:
  `completions(Prefix,Completions)`
mode – number of proofs:
  `completions(+atom,-lists(pair)) – zero_or_more`

### built_in_directive/4

> Provides access to the HTML documenting files describing built-in directives.

compilation flags:
  `static`
template:
  `built_in_directive(Functor,Arity,Directory,Basename)`
mode – number of proofs:
  `built_in_directive(?atom,?integer,-atom,-atom) – zero_or_more`

### built_in_predicate/4

> Provides access to the HTML documenting files describing built-in predicates.

compilation flags:
  `static`
template:
  `built_in_predicate(Functor,Arity,Directory,Basename)`
mode – number of proofs:
  `built_in_predicate(?atom,?integer,-atom,-atom) – zero_or_more`

### built_in_method/4

> Provides access to the HTML documenting files describing built-in methods.

compilation flags:
  `static`
template:
  `built_in_method(Functor,Arity,Directory,Basename)`
mode – number of proofs:
  `built_in_method(?atom,?integer,-atom,-atom) – zero_or_more`

### control/4

> Provides access to the HTML documenting files describing built-in control constructs.

compilation flags:
  `static`
template:
  `control(Functor,Arity,Directory,Basename)`
mode – number of proofs:
  `control(?atom,?integer,-atom,-atom) – zero_or_more`

### built_in_non_terminal/4

> Provides access to the HTML documenting files describing built-in DCG non-terminals.

compilation flags:
  `static`
template:
  `built_in_non_terminal(Functor,Arity,Directory,Basename)`
mode – number of proofs:
  `built_in_non_terminal(?atom,?integer,-atom,-atom) – zero_or_more`

### library/0

> Provides help on the standard Logtalk library.

compilation flags:
  `static`
mode – number of proofs:
  `library – one`

### library/1

> Provides help on the standard Logtalk library entities, predicates, and non-terminals.

compilation flags:
  `static`
template:
  `library(Topic)`
mode – number of proofs:
  `library(+entity_identifier) – zero_or_one`

### manuals/0

> Provides access to the Logtalk User and Reference manuals.

compilation flags:
  `static`
mode – number of proofs:
  `manuals – one`

## Protected interface

(see related entities)

## Private predicates

(see related entities)

## Operators

### (none)

## Remarks

### (none)

## See also

### (none)