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

Opts is a list of parsed options in the form Key(Value), or (with the option functor(Func) given) in the form Func(Key, Value). Dashed args not in OptsSpec are not permitted and will raise error (see tip on how to pass unknown flags in the module description). PositionalArgs are the remaining non-dashed args after each flag has taken its argument (filling in true or false for booleans). There are no restrictions on non-dashed arguments and they may go anywhere (although it is good practice to put them last). ParseOptions are

output_functor(Func)
Set the functor Func of the returned options Func(Key,Value). Default is the special value 'OPTION' (upper-case), which makes the returned options have form Key(Value).
duplicated_flags(Keep)
Controls how to handle options given more than once on the commad line. Keep is one of keepfirst, keeplast, keepall with the obvious meaning. Default is keeplast.
allow_empty_flag_spec(Bool)
If true (default), a flag specification is not required (it is allowed that both shortflags and longflags be either [] or absent). Flagless options cannot be manipulated from the command line and will not show up in the generated help. This is useful when you have (also) general configuration parameters in your OptsSpec, especially if you think they one day might need to be controlled externally. See example in the module overview. allow_empty_flag_spec(false) gives the more customary behaviour of raising error on empty flags.
ClioPatria (version V3.1.1-51-ga0b30a5)