• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

/usr/lib/swipl/library/help.pl
All Application Manual Name SummaryHelp

  • swipl
    • library
      • error.pl
      • debug.pl
      • apply.pl
      • lists.pl
      • broadcast.pl -- Event service
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • thread_pool.pl -- Resource bounded thread management
      • gensym.pl
      • settings.pl
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_colour.pl
      • record.pl
      • prolog_xref.pl
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • solution_sequences.pl -- Modify solution sequences
      • atom.pl -- Operations on atoms
      • prolog_pack.pl
      • git.pl -- Run GIT commands
      • ctypes.pl
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • base64.pl -- Base64 encoding and decoding
      • persistency.pl -- Provide persistent dynamic predicates
      • pure_input.pl -- Pure Input from files and streams
      • nb_set.pl
      • aggregate.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • iostream.pl -- Utilities to deal with streams
      • dialect.pl
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • yall.pl -- Lambda expressions
      • prolog_code.pl -- Utilities for reasoning about code
      • dif.pl -- The dif/2 constraint
      • thread.pl -- High level thread primitives
      • predicate_options.pl -- Access and analyse predicate options
      • rbtrees.pl
      • nb_rbtrees.pl
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • random.pl
      • pprint.pl -- Pretty Print Prolog terms
      • modules.pl -- Module utility predicates
      • lazy_lists.pl -- Lazy list handling
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • prolog_clause.pl
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl
      • strings.pl
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • backcomp.pl -- Backward compatibility
      • quintus.pl
      • prolog_profile.pl -- Execution profiler
      • prolog_config.pl -- Provide configuration information
      • threadutil.pl -- Interactive thread utilities
      • prolog_coverage.pl -- Coverage analysis tool
      • sort.pl
      • increval.pl
      • tables.pl
      • statistics.pl -- Get information about resource usage
      • oset.pl -- Ordered set manipulation
      • prolog_stack.pl
      • date.pl -- Process dates and times
      • listing.pl
      • intercept.pl -- Intercept and signal interface
      • system.pl -- System utilities
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • tableutil.pl
      • heaps.pl
      • help.pl -- Text based manual
        • tty_link_hook/5
        • help/0
        • help/1
        • show_html_hook/1
        • apropos/1
        • apropos/2
        • help_apropos/4
        • help_text/2
      • wfs.pl
      • charsio.pl
      • codesio.pl
      • terms.pl -- Term manipulation
      • shell.pl
      • check.pl
      • prolog_debug.pl -- User level debugging tools
      • prolog_autoload.pl
      • prolog_codewalk.pl -- Prolog code walker
      • edit.pl -- Editor interface
      • base32.pl -- Base32 encoding and decoding
      • coinduction.pl -- Co-Logic Programming
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl
      • prolog_jiti.pl
      • portray_text.pl -- Portray text
      • streams.pl -- Manage Prolog streams
      • prolog_metainference.pl
      • make.pl
      • optparse.pl -- command line parsing
      • fastrw.pl -- Fast reading and writing of terms
      • hashtable.pl -- Hash tables
      • exceptions.pl
      • macros.pl -- Macro expansion
      • prolog_trace.pl
      • prolog_history.pl
      • prolog_wrap.pl -- Wrapping predicates
      • explain.pl -- Describe Prolog Terms
      • rwlocks.pl -- Read/write locks
      • files.pl
      • writef.pl -- Old-style formatted write
      • tty.pl -- Terminal operations
      • prolog_qlfmake.pl -- Compile the library to QLF format
 help is det
 help(+What) is det
Show help for What. What is a term that describes the topics(s) to give help for. Notations for What are:
Atom
This ambiguous form is most commonly used and shows all matching documents. For example:
?- help(append).
Name / Arity
Give help on predicates with matching Name/Arity. Arity may be unbound.
Name // Arity
Give help on the matching DCG rule (non-terminal)
Module:Name
Give help on predicates with Name in Module and any arity. Used for loaded code only.
Module:Name/Arity
Give help on predicates with Name in Module and Arity. Used for loaded code only.
f(Name/Arity)
Give help on the matching Prolog arithmetic functions.
c(Name)
Give help on the matching C interface function
section(Label)
Show the section from the manual with matching Label.
xpce(Class, Kind, Name)
Show the documentation of an XPCE class member.

help/1 shows documentation from the manual as well as from loaded user code if the code is documented using PlDoc. To show only the documentatoion of the loaded predicate we may prefix predicate indicator with the module in which it is defined.

If an exact match fails this predicates attempts fuzzy matching and, when successful, display the results headed by a warning that the matches are based on fuzzy matching.

If possible, the results are sent through a pager such as the less program. This behaviour is controlled by the Prolog flag help_pager. See section level documentation.

If the terminal supports hyperlinks (see the Prolog flag hyperlink_term), the manual references in the page are clickable. In an Epilog window, clicking one quits the pager and runs help/1 on the linked object.

See also
- apropos/1 for searching the manual names and summaries.
ClioPatria (version V3.1.1-59-g7b9a7a3)