object

help

Command-line help for Logtalk tools, libraries, entities, predicates, and non-terminals.

Availability:

logtalk_load(help(loader))

Author: Paulo Moura

Version: 0:42:0

Date: 2025-12-21

Compilation flags:

static, context_switching_calls, complements(allow)

Implements:

public forwarding

Uses:

atom

integer

list

os

user

Remarks:

(none)

Inherited public predicates:

 forward/1

Public predicates

help/0

Provides instructions on how to use the help tool.

Compilation flags:

static

Mode and number of proofs:

help - one

---

handbook/0

Provides access to the Handbook.

Compilation flags:

static

Mode and number of proofs:

handbook - one

---

apis/0

Provides access to the APIs documentation.

Compilation flags:

static

Mode and number of proofs:

apis - one

---

apis/1

Provides help on the given predicate or non-terminal.

Compilation flags:

static

Template:

apis(Indicator)

Mode and number of proofs:

apis(+predicate_indicator) - one

apis(+non_terminal_indicator) - one

---

tools/0

Provides access to the developer tools documentation.

Compilation flags:

static

Mode and number of proofs:

tools - one

---

tool/1

Provides help on the given developer tool.

Compilation flags:

static

Template:

tool(Tool)

Mode and number of proofs:

tool(+atom) - zero_or_one

---

libraries/0

Provides access to the standard libraries documentation.

Compilation flags:

static

Mode and number of proofs:

libraries - one

---

library/1

Provides help on the given standard library.

Compilation flags:

static

Template:

library(Library)

Mode and number of proofs:

library(+atom) - zero_or_one

---

entity/1

Provides help on the given built-in, tool, and library entity (object, protocol, or category).

Compilation flags:

static

Template:

entity(Entity)

Mode and number of proofs:

entity(+entity_identifier) - zero_or_one

---

(/)/2

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

Compilation flags:

static

Template:

Name/Arity

Mode and number of proofs:

+atom/ +integer - zero_or_one

---

(//)/2

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

Compilation flags:

static

Template:

Name//Arity

Mode and 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 and 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 and 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(Name,Arity,Directory,Basename)

Mode and 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(Name,Arity,Directory,Basename)

Mode and 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(Name,Arity,Directory,Basename)

Mode and number of proofs:

built_in_method(?atom,?integer,-atom,-atom) - zero_or_more

---

control_construct/4

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

Compilation flags:

static

Template:

control_construct(Name,Arity,Directory,Basename)

Mode and number of proofs:

control_construct(?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(Name,Arity,Directory,Basename)

Mode and number of proofs:

built_in_non_terminal(?atom,?integer,-atom,-atom) - zero_or_more

---

Protected predicates

(no local declarations; see entity ancestors if any)

Private predicates

(no local declarations; see entity ancestors if any)

Operators

(none)