object

help

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

Availability:

logtalk_load(help(loader))

Author: Paulo Moura

Version: 0:35:0

Date: 2024-12-16

Compilation flags:

static, context_switching_calls, complements(allow)

Implements:

public forwarding

Uses:

atom

os

user

Remarks:

(none)

Inherited public predicates:

 apis/0  apis/1  forward/1  handbook/0  handbook/1  man/1

Public predicates

help/0

Prints instructions on how to use the help tool.

Compilation flags:

static

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

Mode and 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 and number of proofs:

library - one

---

library/1

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

Compilation flags:

static

Template:

library(Topic)

Mode and number of proofs:

library(+atom) - zero_or_one

library(+predicate_indicator) - zero_or_one

library(+non_terminal_indicator) - zero_or_one

---

entity/1

Provides help on Logtalk entities (objects, protocols, or categories).

Compilation flags:

static

Template:

entity(Entity)

Mode and number of proofs:

entity(+entity_identifier) - zero_or_one

---

manuals/0

Provides access to the Logtalk User and Reference manuals.

Compilation flags:

static

Mode and number of proofs:

manuals - one

---

Protected predicates

(no local declarations; see entity ancestors if any)

Private predicates

(no local declarations; see entity ancestors if any)

Operators

(none)