• 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/main.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 -- Utility library for loading foreign objects (DLLs, shared objects)
      • 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
        • main/0
        • argv_options/3
        • argv_options/4
        • argv_usage/1
        • cli_parse_debug_options/2
        • cli_debug_opt_type/3
        • cli_debug_opt_help/2
        • cli_debug_opt_meta/2
        • cli_enable_development_system/0
      • 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
      • backcomp.pl -- Backward compatibility
      • prolog_debug.pl -- User level debugging tools
      • optparse.pl -- command line parsing
      • threadutil.pl -- Interactive thread utilities
      • date.pl -- Process dates and times
      • edit.pl -- Editor interface
      • make.pl -- Reload modified source files
      • prolog_coverage.pl -- Coverage analysis tool
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • shell.pl -- Elementary shell commands
      • prolog_codewalk.pl -- Prolog code walker
      • listing.pl -- List programs and pretty print clauses
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_profile.pl -- Execution profiler
      • quintus.pl -- Quintus compatibility
      • prolog_stack.pl -- Examine the Prolog stack
      • check.pl -- Consistency checking
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • charsio.pl -- I/O on Lists of Character Codes
      • heaps.pl -- heaps/priority queues
      • prolog_wrap.pl -- Wrapping predicates
      • statistics.pl -- Get information about resource usage
      • exceptions.pl -- Exception classification
      • intercept.pl -- Intercept and signal interface
      • fastrw.pl -- Fast reading and writing of terms
      • zip.pl -- Access resource ZIP archives
      • varnumbers.pl -- Utilities for numbered terms
      • tty.pl -- Terminal operations
      • system.pl -- System utilities
      • streams.pl -- Manage Prolog streams
      • macros.pl -- Macro expansion
      • prolog_config.pl -- Provide configuration information
      • wfs.pl -- Well Founded Semantics interface
      • strings.pl -- String utilities
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • sort.pl
      • rwlocks.pl -- Read/write locks
      • prolog_autoload.pl -- Autoload all dependencies
      • writef.pl -- Old-style formatted write
      • help.pl -- Text based manual
      • win_menu.pl -- Console window menu
      • codesio.pl -- I/O on Lists of Character Codes
      • files.pl
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • when.pl -- Conditional coroutining
      • qsave.pl -- Save current program as a state or executable
      • prolog_trace.pl -- Print access to predicates
      • base32.pl -- Base32 encoding and decoding
      • explain.pl -- Describe Prolog Terms
      • hashtable.pl -- Hash tables
      • coinduction.pl -- Co-Logic Programming
      • oset.pl -- Ordered set manipulation
      • prolog_history.pl -- Per-directory persistent commandline history
      • portray_text.pl -- Portray text
 argv_usage(:Level) is det
Use print_message/2 to print a usage message at Level. To print the message as plain text indefault color, use debug. Other meaningful options are informational or warning. The help page consists of four sections, two of which are optional:
  1. The header is created from opt_help(help(header), String). It is optional.
  2. The usage is added by default. The part behind Usage: <command> is by default [options] and can be overruled using opt_help(help(usage), String).
  3. The actual option descriptions. The options are presented in the order they are defined in opt_type/3. Subsequent options for the same destination (option name) are joined with the first.
  4. The footer_ is created from opt_help(help(footer), String). It is optional.

The help provided by help(header), help(usage) and help(footer) are either a simple string or a list of elements as defined by print_message_lines/3. In the latter case, the construct \Callable can be used to call a DCG rule in the module from which the user calls argv_options/3. For example, we can add a bold title using

opt_help(help(header), [ansi(bold, '~w', ['My title'])]).
ClioPatria (version V3.1.1-51-ga0b30a5)