/usr/lib/swipl/library/archive.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
      • sort.pl
      • prolog_metainference.pl -- Infer meta-predicate properties
      • prolog_codewalk.pl -- Prolog code walker
      • backcomp.pl -- Backward compatibility
      • system.pl -- System utilities
      • threadutil.pl -- Interactive thread utilities
      • prolog_config.pl -- Provide configuration information
      • sgml_write.pl -- XML/SGML writer module
      • unicode.pl -- Unicode string handling
      • 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
      • statistics.pl -- Get information about resource usage
      • check.pl -- Consistency checking
      • prolog_autoload.pl -- Autoload all dependencies
      • prolog_stack.pl -- Examine the Prolog stack
      • protobufs.pl -- Google's Protocol Buffers
      • xsdp_types.pl -- XML-Schema primitive types
      • quintus.pl -- Quintus compatibility
      • rlimit.pl
      • rdf.pl
      • rdf_parser.pl
      • rewrite.pl
      • rdf_triple.pl -- Create triples from intermediate representation
      • double_metaphone.pl -- Phonetic string matching
      • console_input.pl
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • udp_broadcast.pl -- A UDP broadcast proxy
      • streampool.pl -- Input multiplexing
      • doc_files.pl -- Create stand-alone documentation files
      • c14n2.pl -- C14n2 canonical XML documents
      • table.pl
      • make.pl -- Reload modified source files
      • odbc.pl
      • paxos.pl -- A Replicated Data Store
      • readline.pl -- GNU readline interface
      • thread.pl -- High level thread primitives
      • test_cover.pl -- Clause cover analysis
      • pwp.pl -- Prolog Well-formed Pages
      • edit.pl -- Editor interface
      • optparse.pl -- command line parsing
      • writef.pl -- Old-style formatted write
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • plunit.pl -- Unit Testing
      • archive.pl -- Access several archive formats
        • archive_open/3
        • archive_open/4
        • archive_close/1
        • archive_property/2
        • archive_next_header/2
        • archive_open_entry/2
        • archive_set_header_property/2
        • archive_header_property/2
        • archive_extract/3
        • archive_entries/2
        • archive_data_stream/3
        • archive_create/3
        • archive_foldl/4
      • qsave.pl -- Save current program as a state or executable
      • doc_latex.pl -- PlDoc LaTeX backend
      • help.pl -- Text based manual
      • isub.pl -- isub: a string similarity measure
      • prolog_history.pl -- Per-directory persistent commandline history
      • xmlenc.pl -- XML encryption library
      • files.pl
      • xmldsig.pl -- XML Digital signature
      • explain.pl -- Describe Prolog Terms
      • editline.pl -- BSD libedit based command line editing
      • cgi.pl -- Read CGI parameters
 archive_open(+Data, +Mode, -Archive, +Options) is det
Open the archive in Data and unify Archive with a handle to the opened archive. Data is either a file or a stream that contains a valid archive. Details are controlled by Options. Typically, the option close_parent(true) is used to close stream if the archive is closed using archive_close/1. For other options, the defaults are typically fine. The option format(raw) must be used to process compressed streams that do not contain explicit entries (e.g., gzip'ed data) unambibuously. The raw format creates a pseudo archive holding a single member named data.
close_parent(+Boolean)
If this option is true (default false), Stream is closed if archive_close/1 is called on Archive.
compression(+Compression)
Synomym for filter(Compression). Deprecated.
filter(+Filter)
Support the indicated filter. This option may be used multiple times to support multiple filters. In read mode, If no filter options are provided, all is assumed. In write mode, none is assumed. Supported values are all, bzip2, compress, gzip, grzip, lrzip, lzip, lzma, lzop, none, rpm, uu and xz. The value all is default for read, none for write.
format(+Format)
Support the indicated format. This option may be used multiple times to support multiple formats in read mode. In write mode, you must supply a single format. If no format options are provided, all is assumed for read mode. Note that all does not include raw and mtree. To open both archive and non-archive files, both format(all) and format(raw) and/or format(mtree) must be specified. Supported values are: all, 7zip, ar, cab, cpio, empty, gnutar, iso9660, lha, mtree, rar, raw, tar, xar and zip. The value all is default for read.

Note that the actually supported compression types and formats may vary depending on the version and installation options of the underlying libarchive library. This predicate raises a domain error if the (explicitly) requested format is not supported.

Errors
- domain_error(filter, Filter) if the requested filter is not supported.
- domain_error(format, Format) if the requested format type is not supported.