This tool provides basic on-line help for Logtalk features and libraries
when running in a limited set of operating-systems. For help on the
Logtalk compiler error and warning messages, see the
This tool API documentation is available at:
For sample queries, please see the
SCRIPT.txt file in the tool
| ?- logtalk_load(help(loader)).
To test this tool, load the
| ?- logtalk_load(help(tester)).
Currently, support is limited to Linux, macOS, and Windows.
On Windows, the
start command must be available. On Linux, the
xdg-open command must be available. On macOS, the command
This tool relies on the library portable operating-system access abstraction.
After loading the tool, use the query
help::help to get started.
On POSIX systems, when using Ciao Prolog, ECLiPSe, LVM, SICStus Prolog,
SWI-Prolog, Trealla Prolog, or XSB as the backend,
handbook/0-1 predicates are made available. These predicates open
inline, respectively, the Texinfo versions of the Handbook and the APIs
documentation. The optional argument is a topic to search, which can be
an atom, a predicate indicator, or a non-terminal indicator. Some
| ?- help::handbook. | ?- help::handbook(base64). | ?- help::handbook(logtalk_load/2). | ?- help::apis. | ?- help::apis(string_match/2). | ?- help::apis(body_term//2).
When you finish consult the documentation and quit the
you will be back to the top-level prompt (if you find that the top-level
have scrolled from its last position, try to set your terminal terminfo
If you’re running Logtalk from a git clone of its repo, you will need to
scripts/update_html_docs.ps1 scripts to generate the APIs
.info file and also run the
manuals/sources/build_manuals.ps1 scripts to generated the Handbook
.info file. In alternative, you can download the
.info files for
the latest stable release from the Logtalk website and save them to the
info command is provided by the third-party
package (tested with version 6.8). On macOS, this package can be
installed with either MacPorts:
$ sudo port install texinfo
Or using Homebrew:
$ brew install texinfo
On Linux systems, use the distribution own package manager to install
texinfo package. For example, in Ubuntu systems:
$ sudo apt install info
The open commands used to open documentation URLs drop the fragment part, thus preventing navigating to the specified position on the documentation page.
ECLiPSe defines a
help prefix operator that forces wrapping this
atom between parenthesis when sending messages to the tool. E.g. use
(help)::help instead of