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

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