2.7.1 library(help): Text based manual
All Application Manual Name SummaryHelp

  • Documentation
    • Reference manual
      • Overview
        • Online Help
          • library(help): Text based manual
            • help/0
            • help/1
            • show_html_hook/1
            • apropos/1
            • apropos/2
            • help_apropos/4
            • help_text/2
            • tty_link_hook/2
    • Packages
Availability::- use_module(library(help)).(can be autoloaded)
Source[det]apropos(+Query)
[det]apropos(+Query, +Options)
Print objects from the manual whose name or summary match with Query. Query takes one of the following forms:
Type:Text
Find objects matching Text and filter the results by Type. Type matching is a case intensitive prefix match. Defined types are section, cfunction, function, iso_predicate, swi_builtin_predicate, library_predicate, dcg and aliases chapter, arithmetic, c_function, predicate, nonterminal and non_terminal. For example:
?- apropos(c:close).
?- apropos(f:min).
Text
Text is broken into tokens. A topic matches if all tokens appear in the name or summary of the topic. Matching is case insensitive. Results are ordered depending on the quality of the match.

Only the best limit matches are shown. Options:

limit(+Count)
Maximum number of matches to show. Default 20.
offset(+Skip)
Ignore the Skip best matches. Default 0.

If the terminal supports hyperlinks (see the Prolog flag hyperlink_term), the matches are clickable and so is the line that reports there are more matches. In an Epilog window, clicking these runs help/1 on the match or apropos/2 on the next page.