/usr/lib/swipl/library/optparse.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl -- List Manipulation
      • debug.pl
      • broadcast.pl -- Event service
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • uid.pl
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • redis.pl -- Redis client
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • make.pl -- Reload modified source files
      • optparse.pl -- command line parsing
        • opt_arguments/3
        • opt_parse/4
        • opt_parse/5
        • opt_help/2
        • parse_type/3
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • statistics.pl -- Get information about resource usage
      • odbc.pl
      • check.pl -- Consistency checking
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • prolog_profile.pl -- Execution profiler
      • test_cover.pl -- Clause coverage analysis
      • editline.pl -- BSD libedit based command line editing
      • streampool.pl -- Input multiplexing
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • when.pl -- Conditional coroutining
      • portray_text.pl -- Portray text
      • prolog_trace.pl -- Print access to predicates
      • redis_streams.pl -- Using Redis streams
      • prolog_debug.pl -- User level debugging tools
      • rdf.pl -- RDF/XML parser
      • archive.pl -- Access several archive formats
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • intercept.pl -- Intercept and signal interface
      • help.pl -- Text based manual
      • isub.pl -- isub: a string similarity measure
      • crypt.pl
      • prolog_codewalk.pl -- Prolog code walker
      • shell.pl -- Elementary shell commands
      • mqi.pl
      • quintus.pl -- Quintus compatibility
      • system.pl -- System utilities
      • unicode.pl -- Unicode string handling
      • prolog_wrap.pl -- Wrapping predicates
      • stomp.pl -- STOMP client.
      • rlimit.pl
      • readline.pl -- GNU readline interface
      • yaml.pl -- Process YAML data
      • prolog_history.pl -- Per-directory persistent commandline history
      • edit.pl -- Editor interface
      • udp_broadcast.pl -- A UDP broadcast proxy
      • plunit.pl -- Unit Testing
      • streams.pl -- Manage Prolog streams
      • xmldsig.pl -- XML Digital signature
      • paxos.pl -- A Replicated Data Store
      • c14n2.pl -- C14n2 canonical XML documents
      • xmlenc.pl -- XML encryption library
      • sgml_write.pl -- XML/SGML writer module
      • prolog_metainference.pl -- Infer meta-predicate properties
      • writef.pl -- Old-style formatted write
      • pwp.pl -- Prolog Well-formed Pages
      • threadutil.pl -- Interactive thread utilities
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • tty.pl -- Terminal operations
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • thread.pl -- High level thread primitives
      • hashtable.pl -- Hash tables
      • prolog_versions.pl -- Demand specific Prolog versions
      • doc_files.pl -- Create stand-alone documentation files
      • tables.pl -- XSB interface to tables
      • increval.pl -- Incremental dynamic predicate modification
      • prolog_autoload.pl -- Autoload all dependencies
      • files.pl
      • rwlocks.pl -- Read/write locks
      • xsdp_types.pl -- XML-Schema primitive types
      • double_metaphone.pl -- Phonetic string matching
      • doc_latex.pl -- PlDoc LaTeX backend
      • explain.pl -- Describe Prolog Terms
      • oset.pl -- Ordered set manipulation
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • cgi.pl -- Read CGI parameters
      • table.pl
      • macros.pl -- Macro expansion
      • fastrw.pl -- Fast reading and writing of terms
      • readln.pl -- Read line as list of tokens
 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.