• 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 -- Print debug messages and test assertions
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • broadcast.pl -- Event service
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl
      • option.pl -- Option list processing
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • 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 -- Prolog syntax colouring support.
      • record.pl -- Access compound arguments by name
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • occurs.pl -- Finding and counting sub-terms
      • ordsets.pl -- Ordered set manipulation
      • assoc.pl -- Binary associations
      • ugraphs.pl -- Graph manipulation library
      • iostream.pl -- Utilities to deal with streams
      • atom.pl -- Operations on atoms
      • prolog_pack.pl -- A package manager for Prolog
      • solution_sequences.pl -- Modify solution sequences
      • git.pl -- Run GIT commands
      • ctypes.pl -- Character code classification
      • 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 -- Non-backtrackable sets
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • dialect.pl -- Support multiple Prolog dialects
      • 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
      • rbtrees.pl -- Red black trees
      • nb_rbtrees.pl -- Non-backtrackable operations on red black trees
      • random.pl -- Random numbers
      • sandbox.pl -- Sandboxed Prolog code
      • prolog_format.pl -- Analyse format specifications
      • 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 -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • dicts.pl -- Dict utilities
      • heaps.pl -- heaps/priority queues
      • system.pl -- System utilities
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • backcomp.pl -- Backward compatibility
      • help.pl -- Text based manual
        • help/0
        • help/1
        • show_html_hook/1
        • apropos/1
      • date.pl -- Process dates and times
      • prolog_profile.pl -- Execution profiler
      • listing.pl -- List programs and pretty print clauses
      • quintus.pl -- Quintus compatibility
      • base32.pl -- Base32 encoding and decoding
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • sort.pl
      • statistics.pl -- Get information about resource usage
      • terms.pl -- Term manipulation
      • varnumbers.pl -- Utilities for numbered terms
      • when.pl -- Conditional coroutining
      • exceptions.pl -- Exception classification
      • wfs.pl -- Well Founded Semantics interface
      • prolog_stack.pl -- Examine the Prolog stack
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_trace.pl -- Print access to predicates
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_coverage.pl -- Coverage analysis tool
      • oset.pl -- Ordered set manipulation
      • optparse.pl -- command line parsing
      • make.pl -- Reload modified source files
      • check.pl -- Consistency checking
      • threadutil.pl -- Interactive thread utilities
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_config.pl -- Provide configuration information
      • zip.pl -- Access resource ZIP archives
      • intercept.pl -- Intercept and signal interface
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • strings.pl -- String utilities
      • macros.pl -- Macro expansion
      • prolog_debug.pl -- User level debugging tools
      • portray_text.pl -- Portray text
      • prolog_wrap.pl -- Wrapping predicates
      • explain.pl -- Describe Prolog Terms
      • edit.pl -- Editor interface
      • tty.pl -- Terminal operations
      • shell.pl -- Elementary shell commands
      • writef.pl -- Old-style formatted write
      • files.pl
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • qsave.pl -- Save current program as a state or executable
      • prolog_autoload.pl -- Autoload all dependencies
      • rwlocks.pl -- Read/write locks
      • hashtable.pl -- Hash tables
      • streams.pl -- Manage Prolog streams
      • win_menu.pl -- Console window menu
 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.

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.

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