• 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
      • lists.pl -- List Manipulation
      • broadcast.pl
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl
      • option.pl -- Option list processing
      • thread_pool.pl
      • gensym.pl
      • settings.pl
      • 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
      • 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
      • threadutil.pl -- Interactive thread utilities
      • intercept.pl -- Intercept and signal interface
      • backcomp.pl -- Backward compatibility
      • hashtable.pl -- Hash tables
      • optparse.pl -- command line parsing
      • charsio.pl -- I/O on Lists of Character Codes
      • win_menu.pl -- Console window menu
      • tty.pl -- Terminal operations
      • edit.pl -- Editor interface
      • rwlocks.pl -- Read/write locks
      • terms.pl -- Term manipulation
      • explain.pl -- Describe Prolog Terms
      • date.pl -- Process dates and times
      • writef.pl -- Old-style formatted write
      • statistics.pl -- Get information about resource usage
      • prolog_coverage.pl -- Coverage analysis tool
      • check.pl -- Consistency checking
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_versions.pl -- Demand specific (Prolog) versions
      • strings.pl -- String utilities
      • oset.pl -- Ordered set manipulation
      • make.pl -- Reload modified source files
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_trace.pl -- Print access to predicates
      • shell.pl -- Elementary shell commands
      • listing.pl -- List programs and pretty print clauses
      • varnumbers.pl -- Utilities for numbered terms
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • when.pl -- Conditional coroutining
      • codesio.pl -- I/O on Lists of Character Codes
      • wfs.pl -- Well Founded Semantics interface
      • system.pl -- System utilities
      • prolog_config.pl -- Provide configuration information
      • prolog_stack.pl -- Examine the Prolog stack
      • quintus.pl -- Quintus compatibility
      • heaps.pl -- heaps/priority queues
      • macros.pl -- Macro expansion
      • zip.pl -- Access resource ZIP archives
      • sort.pl
      • prolog_debug.pl -- User level debugging tools
      • portray_text.pl -- Portray text
      • prolog_metainference.pl -- Infer meta-predicate properties
      • base32.pl -- Base32 encoding and decoding
      • coinduction.pl -- Co-Logic Programming
      • prolog_profile.pl -- Execution profiler
      • help.pl -- Text based manual
      • streams.pl -- Manage Prolog streams
      • prolog_history.pl -- Per-directory persistent commandline history
      • prolog_wrap.pl -- Wrapping predicates
      • exceptions.pl -- Exception classification
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • qsave.pl -- Save current program as a state or executable
      • files.pl
 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)