The tar-file Reference Manual

Table of Contents

The tar-file Reference Manual

This is the tar-file Reference Manual, version 0.2.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:13:35 2022 GMT+0.

1 Introduction

This project provides functionality to read and write a variety of tar archive formats. Currently supported are the POSIX ustar, PAX (ustar with a few new entry types), GNU, and v7 (very old) formats.

This project is rather low level and is focused exclusively on reading and writing physical tar file entries using streams. Therefore, it contains no functionality to automatically build archives from a set of files on the filesystem or write the contents of a file to the filesystem. Additionally, there are no smarts that read multiple physical entries and combine them into a single logical entry (e.g., with PAX extended headers or GNU long link/path name support). This approach is taken to both improve portability (the CL spec has no facility for things like detecting symlinks or modifying/reading file owners, etc.) and properly separate concerns.

For a higher level library that reads and writes logical entries, as well as includes file system integration, see cl-tar.

This project is a fork of Nathan Froyd's archive library. Much code remains, but the non-portable bits have been stripped, better support for multiple archive types (and autodetection) has been added, better blocking support added (tar readers/writers are supposed to read/write in multiples of 512 bytes), cpio support removed, and a test suite added, along with other miscellaneous fixes and improvements.

One major user visible difference between this library and the original archive is that there is no need to discard entries when you are finished with them and support has been added for seeking within a stream (using FILE-POSITION under the hood). This means you can do something like iterate over all entries in one go and then get a stream containing the contents of an arbitrary entry.

However, care must be taken if you hop around in a tar file as it will only work if the underlying stream containing the tar archive is seekable. Typically, streams backed by files are seekable, but all other input streams (including stdin) are not. Therefore if there is any chance your code that uses tar-file will read files from non-seekable streams, you should process entries sequentially and completely before moving on to the next one. Alternatively, you can set the blocking factor high enough that the entire file is read into memory at once (yikes!).

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 tar-file

Maintainer

Eric Timmons <eric@timmons.dev>

Author

Eric Timmons <eric@timmons.dev>

License

BSD-style (http://opensource.org/licenses/BSD-3-Clause)

Description

A system for reading and writing physical entries from/to tar files.

Version

0.2.1

Dependencies

• alexandria
• babel
• trivial-gray-streams
• uiop
• 40ants-doc
• salza2
• chipz
• flexi-streams

Source

tar-file.asd (file)

Components

• blocked-stream.lisp (file)
• bounded-stream.lisp (file)
• buffer-ops.lisp (file)
• conditions.lisp (file)
• constants.lisp (file)
• docs.lisp (file)
• entry.lisp (file)
• external-macros.lisp (file)
• generics.lisp (file)
• gnu.lisp (file)
• macros.lisp (file)
• package.lisp (file)
• peeking-stream.lisp (file)
• tar-file.lisp (file)
• utils.lisp (file)
• ustar.lisp (file)
• v7.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 tar-file.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-tar-file-20220220-git/tar-file.asd

Systems

tar-file (system)

3.1.2 tar-file/blocked-stream.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

blocked-stream.lisp

Internal Definitions

• block-size (method)
• blocked-input-stream (class)
• blocked-io-stream (class)
• blocked-output-stream (class)
• blocked-stream (class)
• blocked-stream-error (condition)
• buffer (method)
• (setf buffer) (method)
• buffer-valid-p (method)
• (setf buffer-valid-p) (method)
• dirty-p (method)
• (setf dirty-p) (method)
• discard-buffer (generic function)
• discard-buffer (method)
• discard-buffer (method)
• discard-buffer (method)
• ensure-buffer-valid (generic function)
• ensure-buffer-valid (method)
• eof-index (method)
• (setf eof-index) (method)
• fill-buffer (method)
• fill-buffer (method)
• index (method)
• (setf index) (method)
• simple-blocked-stream-error (condition)
• start-file-position (method)
• (setf start-file-position) (method)
• stream-offset (method)
• (setf stream-offset) (method)
• wrapped-stream (method)

3.1.3 tar-file/bounded-stream.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

bounded-stream.lisp

Internal Definitions

• %position (method)
• (setf %position) (method)
• bounded-input-stream (class)
• ensure-file-position (method)
• make-bounded-stream (function)
• n-bytes-remaining (method)
• (setf n-bytes-remaining) (method)
• wrapped-stream (method)

3.1.4 tar-file/buffer-ops.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)

Parent

tar-file (system)

Location

buffer-ops.lisp

Internal Definitions

• read-bytevec-from-buffer (function)
• read-number-from-buffer (function)
• write-number-to-buffer (function)

3.1.5 tar-file/conditions.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)

Parent

tar-file (system)

Location

conditions.lisp

Exported Definitions

• invalid-checksum-error (condition)
• malformed-pax-attribute-entry (condition)
• tar-file-error (condition)

Internal Definitions

• computed (method)
• provided (method)
• simple-tar-file-error (condition)

3.1.6 tar-file/constants.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

constants.lisp

Internal Definitions

• +ascii-/+ (constant)
• +ascii-a+ (constant)
• +ascii-newline+ (constant)
• +ascii-nine+ (constant)
• +ascii-space+ (constant)
• +ascii-z+ (constant)
• +ascii-zero+ (constant)
• +gnutar-directory-dump+ (constant)
• +gnutar-long-link-name+ (constant)
• +gnutar-long-name+ (constant)
• +gnutar-sparse+ (constant)
• +gnutar-volume-header-name+ (constant)
• +posix-extended-header+ (constant)
• +posix-global-header+ (constant)
• +tar-block-device+ (constant)
• +tar-character-device+ (constant)
• +tar-directory-file+ (constant)
• +tar-fifo-device+ (constant)
• +tar-hard-link+ (constant)
• +tar-implementation-specific-file+ (constant)
• +tar-n-block-bytes+ (constant)
• +tar-regular-alternate-file+ (constant)
• +tar-regular-file+ (constant)
• +tar-symbolic-link+ (constant)

3.1.7 tar-file/docs.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

docs.lisp

Internal Definitions

• @block-device-entry (special variable)
• @character-device-entry (special variable)
• @conditions (special variable)
• @directory-entry (special variable)
• @entries (special variable)
• @fifo-entry (special variable)
• @file-entry (special variable)
• @gnu-directory-dump-entry (special variable)
• @gnu-long-link-name-entry (special variable)
• @gnu-long-name-entry (special variable)
• @gnu-sparse-file-entry (special variable)
• @gnu-volume-header-name-entry (special variable)
• @hard-link-entry (special variable)
• @manual (special variable)
• @opening-tar-files (special variable)
• @pax-extended-attributes-entry (special variable)
• @pax-global-attributes-entry (special variable)
• @symbolic-link-entry (special variable)
• @tar-archive-types (special variable)
• @unknown-entry (special variable)

3.1.8 tar-file/entry.lisp

Dependencies

• package.lisp (file)
• constants.lisp (file)
• generics.lisp (file)

Parent

tar-file (system)

Location

entry.lisp

Exported Definitions

• atime (method)
• attribute (generic function)
• attribute (method)
• attribute-names (generic function)
• attribute-names (method)
• block-device-entry (class)
• character-device-entry (class)
• ctime (method)
• devmajor (method)
• devminor (method)
• directory-entry (class)
• do-attributes (macro)
• entry (class)
• entry-block-device-p (method)
• entry-character-device-p (method)
• entry-directory-p (method)
• entry-fifo-p (method)
• entry-file-p (method)
• entry-gnu-directory-dump-p (method)
• entry-gnu-long-link-name-p (method)
• entry-gnu-long-name-p (method)
• entry-gnu-sparse-file-p (method)
• entry-gnu-volume-header-name-p (method)
• entry-hard-link-p (method)
• entry-has-data-p (generic function)
• entry-has-data-p (method)
• entry-has-data-p (method)
• entry-pax-extended-attributes-p (method)
• entry-pax-global-attributes-p (method)
• entry-symbolic-link-p (method)
• entry-unknown-p (method)
• fifo-entry (class)
• file-entry (class)
• gid (method)
• gname (method)
• gnu-directory-dump-entry (class)
• gnu-long-link-name-entry (class)
• gnu-long-name-entry (class)
• gnu-sparse-file-entry (class)
• gnu-volume-header-name-entry (class)
• hard-link-entry (class)
• isextended (method)
• linkname (method)
• make-entry-stream (generic function)
• make-entry-stream (method)
• mode (method)
• mtime (method)
• name (method)
• numbytes-sparse-0 (method)
• numbytes-sparse-1 (method)
• numbytes-sparse-2 (method)
• offset (method)
• offset-sparse-0 (method)
• offset-sparse-1 (method)
• offset-sparse-2 (method)
• offset-sparse-3 (method)
• pax-extended-attributes-entry (class)
• pax-global-attributes-entry (class)
• prefix (method)
• realsize (method)
• size (method)
• symbolic-link-entry (class)
• uid (method)
• uname (method)
• unknown-entry (class)
• write-block-device-entry (method)
• write-character-device-entry (method)
• write-directory-entry (method)
• write-fifo-entry (method)
• write-file-entry (method)
• write-gnu-long-link-name-entry (method)
• write-gnu-long-name-entry (method)
• write-hard-link-entry (method)
• write-pax-extended-attributes-entry (method)
• write-pax-global-attributes-entry (method)
• write-symbolic-link-entry (method)

Internal Definitions

• attribute-alist-to-bytevec (function)
• attribute-pair-to-bytevec (function)
• attributes (method)
• (setf attributes) (method)
• checksum (method)
• entry-tar-file (method)
• has-data-mixin (class)
• header (method)
• long-link-name (method)
• (setf long-link-name) (method)
• long-name (method)
• (setf long-name) (method)
• magic (method)
• make-header-forwarder (macro)
• numbytes-sparse-3 (method)
• pax-attributes-entry (class)
• populate-pax-attributes (function)
• read-attribute (function)
• read-attribute-length (function)
• start-position (method)
• typeflag (method)
• user-attributes-to-alist (method)
• user-attributes-to-alist (method)
• version (method)

3.1.9 tar-file/external-macros.lisp

Dependencies

• generics.lisp (file)
• utils.lisp (file)

Parent

tar-file (system)

Location

external-macros.lisp

Exported Definitions

• do-entries (macro)
• with-open-tar-file (macro)

Internal Definitions

call-with-open-tar-file (function)

3.1.10 tar-file/generics.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

generics.lisp

Exported Definitions

• atime (generic function)
• close-tar-file (generic function)
• ctime (generic function)
• devmajor (generic function)
• devminor (generic function)
• entry-block-device-p (generic function)
• entry-block-device-p (method)
• entry-character-device-p (generic function)
• entry-character-device-p (method)
• entry-directory-p (generic function)
• entry-directory-p (method)
• entry-fifo-p (generic function)
• entry-fifo-p (method)
• entry-file-p (generic function)
• entry-file-p (method)
• entry-gnu-directory-dump-p (generic function)
• entry-gnu-directory-dump-p (method)
• entry-gnu-long-link-name-p (generic function)
• entry-gnu-long-link-name-p (method)
• entry-gnu-long-name-p (generic function)
• entry-gnu-long-name-p (method)
• entry-gnu-sparse-file-p (generic function)
• entry-gnu-sparse-file-p (method)
• entry-gnu-volume-header-name-p (generic function)
• entry-gnu-volume-header-name-p (method)
• entry-pax-extended-attributes-p (generic function)
• entry-pax-extended-attributes-p (method)
• entry-pax-global-attributes-p (generic function)
• entry-pax-global-attributes-p (method)
• entry-symbolic-link-p (generic function)
• entry-symbolic-link-p (method)
• entry-unknown-p (generic function)
• entry-unknown-p (method)
• finalize-tar-file (generic function)
• gid (generic function)
• gname (generic function)
• isextended (generic function)
• linkname (generic function)
• mode (generic function)
• mtime (generic function)
• name (generic function)
• numbytes-sparse-0 (generic function)
• numbytes-sparse-1 (generic function)
• numbytes-sparse-2 (generic function)
• offset (generic function)
• offset-sparse-0 (generic function)
• offset-sparse-1 (generic function)
• offset-sparse-2 (generic function)
• offset-sparse-3 (generic function)
• prefix (generic function)
• read-entry (generic function)
• realsize (generic function)
• size (generic function)
• uid (generic function)
• uname (generic function)
• write-block-device-entry (generic function)
• write-character-device-entry (generic function)
• write-directory-entry (generic function)
• write-fifo-entry (generic function)
• write-file-entry (generic function)
• write-gnu-long-link-name-entry (generic function)
• write-gnu-long-name-entry (generic function)
• write-hard-link-entry (generic function)
• write-pax-extended-attributes-entry (generic function)
• write-pax-global-attributes-entry (generic function)
• write-symbolic-link-entry (generic function)

Internal Definitions

• numbytes-sparse-3 (generic function)
• write-entry (generic function)
• write-entry-data (generic function)
• write-header-to-buffer (generic function)

3.1.11 tar-file/gnu.lisp

Dependencies

• package.lisp (file)
• macros.lisp (file)
• tar-file.lisp (file)

Parent

tar-file (system)

Location

gnu.lisp

Exported Definitions

• atime (method)
• (setf atime) (method)
• ctime (method)
• (setf ctime) (method)
• devmajor (method)
• (setf devmajor) (method)
• devminor (method)
• (setf devminor) (method)
• entry-type (method)
• gid (method)
• (setf gid) (method)
• gname (method)
• (setf gname) (method)
• gnu-tar-file (class)
• isextended (method)
• (setf isextended) (method)
• linkname (method)
• (setf linkname) (method)
• mode (method)
• (setf mode) (method)
• mtime (method)
• (setf mtime) (method)
• name (method)
• (setf name) (method)
• numbytes-sparse-0 (method)
• (setf numbytes-sparse-0) (method)
• numbytes-sparse-1 (method)
• (setf numbytes-sparse-1) (method)
• numbytes-sparse-2 (method)
• (setf numbytes-sparse-2) (method)
• offset (method)
• (setf offset) (method)
• offset-sparse-0 (method)
• (setf offset-sparse-0) (method)
• offset-sparse-1 (method)
• (setf offset-sparse-1) (method)
• offset-sparse-2 (method)
• (setf offset-sparse-2) (method)
• offset-sparse-3 (method)
• (setf offset-sparse-3) (method)
• realsize (method)
• (setf realsize) (method)
• size (method)
• (setf size) (method)
• uid (method)
• (setf uid) (method)
• uname (method)
• (setf uname) (method)

Internal Definitions

• %%padding (method)
• (setf %%padding) (method)
• *gnu-magic-vector* (special variable)
• *gnu-version-vector* (special variable)
• checksum (method)
• (setf checksum) (method)
• detect-gnu-tar-file (function)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• gnu-header (class)
• gnu-header-read-%%padding-from-buffer (function)
• gnu-header-read-atime-from-buffer (function)
• gnu-header-read-checksum-from-buffer (function)
• gnu-header-read-ctime-from-buffer (function)
• gnu-header-read-devmajor-from-buffer (function)
• gnu-header-read-devminor-from-buffer (function)
• gnu-header-read-gid-from-buffer (function)
• gnu-header-read-gname-from-buffer (function)
• gnu-header-read-isextended-from-buffer (function)
• gnu-header-read-linkname-from-buffer (function)
• gnu-header-read-longnames-from-buffer (function)
• gnu-header-read-magic-from-buffer (function)
• gnu-header-read-mode-from-buffer (function)
• gnu-header-read-mtime-from-buffer (function)
• gnu-header-read-name-from-buffer (function)
• gnu-header-read-numbytes-sparse-0-from-buffer (function)
• gnu-header-read-numbytes-sparse-1-from-buffer (function)
• gnu-header-read-numbytes-sparse-2-from-buffer (function)
• gnu-header-read-numbytes-sparse-3-from-buffer (function)
• gnu-header-read-offset-from-buffer (function)
• gnu-header-read-offset-sparse-0-from-buffer (function)
• gnu-header-read-offset-sparse-1-from-buffer (function)
• gnu-header-read-offset-sparse-2-from-buffer (function)
• gnu-header-read-offset-sparse-3-from-buffer (function)
• gnu-header-read-realsize-from-buffer (function)
• gnu-header-read-size-from-buffer (function)
• gnu-header-read-typeflag-from-buffer (function)
• gnu-header-read-uid-from-buffer (function)
• gnu-header-read-uname-from-buffer (function)
• gnu-header-read-unused-from-buffer (function)
• gnu-header-read-version-from-buffer (function)
• gnu-header-write-%%padding-to-buffer (function)
• gnu-header-write-atime-to-buffer (function)
• gnu-header-write-checksum-to-buffer (function)
• gnu-header-write-ctime-to-buffer (function)
• gnu-header-write-devmajor-to-buffer (function)
• gnu-header-write-devminor-to-buffer (function)
• gnu-header-write-gid-to-buffer (function)
• gnu-header-write-gname-to-buffer (function)
• gnu-header-write-isextended-to-buffer (function)
• gnu-header-write-linkname-to-buffer (function)
• gnu-header-write-longnames-to-buffer (function)
• gnu-header-write-magic-to-buffer (function)
• gnu-header-write-mode-to-buffer (function)
• gnu-header-write-mtime-to-buffer (function)
• gnu-header-write-name-to-buffer (function)
• gnu-header-write-numbytes-sparse-0-to-buffer (function)
• gnu-header-write-numbytes-sparse-1-to-buffer (function)
• gnu-header-write-numbytes-sparse-2-to-buffer (function)
• gnu-header-write-numbytes-sparse-3-to-buffer (function)
• gnu-header-write-offset-sparse-0-to-buffer (function)
• gnu-header-write-offset-sparse-1-to-buffer (function)
• gnu-header-write-offset-sparse-2-to-buffer (function)
• gnu-header-write-offset-sparse-3-to-buffer (function)
• gnu-header-write-offset-to-buffer (function)
• gnu-header-write-realsize-to-buffer (function)
• gnu-header-write-size-to-buffer (function)
• gnu-header-write-typeflag-to-buffer (function)
• gnu-header-write-uid-to-buffer (function)
• gnu-header-write-uname-to-buffer (function)
• gnu-header-write-unused-to-buffer (function)
• gnu-header-write-version-to-buffer (function)
• header-length (method)
• header-length (method)
• header-type (method)
• longnames (method)
• (setf longnames) (method)
• magic (method)
• (setf magic) (method)
• numbytes-sparse-3 (method)
• (setf numbytes-sparse-3) (method)
• read-header-from-buffer (method)
• typeflag (method)
• (setf typeflag) (method)
• unused (method)
• (setf unused) (method)
• version (method)
• (setf version) (method)
• write-header-to-buffer (method)

3.1.12 tar-file/macros.lisp

Dependency

generics.lisp (file)

Parent

tar-file (system)

Location

macros.lisp

Internal Definitions

• define-octet-header (macro)
• extractor-function-name (function)
• field-length (generic function)
• field-offset (generic function)
• header-length (generic function)
• injector-function-name (function)

3.1.13 tar-file/package.lisp

Parent

tar-file (system)

Location

package.lisp

Packages

tar-file

3.1.14 tar-file/peeking-stream.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

peeking-stream.lisp

Internal Definitions

• num-bytes-peeked (method)
• peeked-bytes (method)
• peeking-input-stream (class)
• start-position (method)
• unread-peeked-bytes (method)
• (setf unread-peeked-bytes) (method)
• wrapped-stream (method)

3.1.15 tar-file/tar-file.lisp

Dependencies

• generics.lisp (file)
• bounded-stream.lisp (file)
• macros.lisp (file)
• external-macros.lisp (file)
• entry.lisp (file)
• constants.lisp (file)

Parent

tar-file (system)

Location

tar-file.lisp

Exported Definitions

• close-tar-file (method)
• entry-type (generic function)
• finalize-tar-file (method)
• open-tar-file (function)
• read-entry (method)
• read-entry (method)
• read-entry (method)
• tar-file (class)

Internal Definitions

• %tar-file-direction (method)
• *default-type* (special variable)
• *type-detectors* (special variable)
• detect-type (function)
• header-encoding (method)
• (setf header-encoding) (method)
• header-type (generic function)
• make-compression-stream (function)
• make-stream-for-entry (function)
• next-entry-start (method)
• (setf next-entry-start) (method)
• open-tar-file-p (method)
• (setf open-tar-file-p) (method)
• register-type-detector (function)
• tar-file-other-streams-to-close (method)
• tar-file-stream (method)
• transfer-octets-to-tar-file (function)
• transfer-stream-to-tar-file (function)
• write-entry (method)
• write-entry (method)
• write-entry-data (method)

3.1.16 tar-file/utils.lisp

Dependency

package.lisp (file)

Parent

tar-file (system)

Location

utils.lisp

Exported Definitions

*default-header-encoding* (special variable)

Internal Definitions

• bytevec-to-string (function)
• compute-checksum-for-tar-header (function)
• compute-old-checksum-for-tar-header (function)
• null-block-p (function)
• round-up-to-tar-block (function)
• string-to-bytevec (function)
• tar-block-checksum-matches-p (function)
• tar-checksum-guts (function)

3.1.17 tar-file/ustar.lisp

Dependencies

• package.lisp (file)
• macros.lisp (file)
• tar-file.lisp (file)

Parent

tar-file (system)

Location

ustar.lisp

Exported Definitions

• devmajor (method)
• (setf devmajor) (method)
• devminor (method)
• (setf devminor) (method)
• entry-type (method)
• gid (method)
• (setf gid) (method)
• gname (method)
• (setf gname) (method)
• linkname (method)
• (setf linkname) (method)
• mode (method)
• (setf mode) (method)
• mtime (method)
• (setf mtime) (method)
• name (method)
• (setf name) (method)
• prefix (method)
• (setf prefix) (method)
• size (method)
• (setf size) (method)
• uid (method)
• (setf uid) (method)
• uname (method)
• (setf uname) (method)
• ustar-tar-file (class)

Internal Definitions

• %%padding (method)
• (setf %%padding) (method)
• *ustar-magic-vector* (special variable)
• *ustar-version-vector* (special variable)
• checksum (method)
• (setf checksum) (method)
• detect-ustar-tar-file (function)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• header-length (method)
• header-length (method)
• header-type (method)
• magic (method)
• (setf magic) (method)
• read-header-from-buffer (method)
• typeflag (method)
• (setf typeflag) (method)
• ustar-header (class)
• ustar-header-read-%%padding-from-buffer (function)
• ustar-header-read-checksum-from-buffer (function)
• ustar-header-read-devmajor-from-buffer (function)
• ustar-header-read-devminor-from-buffer (function)
• ustar-header-read-gid-from-buffer (function)
• ustar-header-read-gname-from-buffer (function)
• ustar-header-read-linkname-from-buffer (function)
• ustar-header-read-magic-from-buffer (function)
• ustar-header-read-mode-from-buffer (function)
• ustar-header-read-mtime-from-buffer (function)
• ustar-header-read-name-from-buffer (function)
• ustar-header-read-prefix-from-buffer (function)
• ustar-header-read-size-from-buffer (function)
• ustar-header-read-typeflag-from-buffer (function)
• ustar-header-read-uid-from-buffer (function)
• ustar-header-read-uname-from-buffer (function)
• ustar-header-read-version-from-buffer (function)
• ustar-header-write-%%padding-to-buffer (function)
• ustar-header-write-checksum-to-buffer (function)
• ustar-header-write-devmajor-to-buffer (function)
• ustar-header-write-devminor-to-buffer (function)
• ustar-header-write-gid-to-buffer (function)
• ustar-header-write-gname-to-buffer (function)
• ustar-header-write-linkname-to-buffer (function)
• ustar-header-write-magic-to-buffer (function)
• ustar-header-write-mode-to-buffer (function)
• ustar-header-write-mtime-to-buffer (function)
• ustar-header-write-name-to-buffer (function)
• ustar-header-write-prefix-to-buffer (function)
• ustar-header-write-size-to-buffer (function)
• ustar-header-write-typeflag-to-buffer (function)
• ustar-header-write-uid-to-buffer (function)
• ustar-header-write-uname-to-buffer (function)
• ustar-header-write-version-to-buffer (function)
• version (method)
• (setf version) (method)
• write-header-to-buffer (method)

3.1.18 tar-file/v7.lisp

Dependencies

• package.lisp (file)
• macros.lisp (file)
• tar-file.lisp (file)

Parent

tar-file (system)

Location

v7.lisp

Exported Definitions

• entry-type (method)
• gid (method)
• (setf gid) (method)
• linkname (method)
• (setf linkname) (method)
• mode (method)
• (setf mode) (method)
• mtime (method)
• (setf mtime) (method)
• name (method)
• (setf name) (method)
• size (method)
• (setf size) (method)
• uid (method)
• (setf uid) (method)
• v7-tar-file (class)

Internal Definitions

• %%padding (method)
• (setf %%padding) (method)
• checksum (method)
• (setf checksum) (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• header-length (method)
• header-length (method)
• header-type (method)
• read-header-from-buffer (method)
• typeflag (method)
• (setf typeflag) (method)
• v7-header (class)
• v7-header-read-%%padding-from-buffer (function)
• v7-header-read-checksum-from-buffer (function)
• v7-header-read-gid-from-buffer (function)
• v7-header-read-linkname-from-buffer (function)
• v7-header-read-mode-from-buffer (function)
• v7-header-read-mtime-from-buffer (function)
• v7-header-read-name-from-buffer (function)
• v7-header-read-size-from-buffer (function)
• v7-header-read-typeflag-from-buffer (function)
• v7-header-read-uid-from-buffer (function)
• v7-header-write-%%padding-to-buffer (function)
• v7-header-write-checksum-to-buffer (function)
• v7-header-write-gid-to-buffer (function)
• v7-header-write-linkname-to-buffer (function)
• v7-header-write-mode-to-buffer (function)
• v7-header-write-mtime-to-buffer (function)
• v7-header-write-name-to-buffer (function)
• v7-header-write-size-to-buffer (function)
• v7-header-write-typeflag-to-buffer (function)
• v7-header-write-uid-to-buffer (function)
• write-header-to-buffer (method)

4 Packages

Packages are listed by definition order.

4.1 tar-file

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *default-header-encoding* (special variable)
• atime (generic function)
• atime (method)
• atime (method)
• (setf atime) (generic function)
• (setf atime) (method)
• attribute (generic function)
• attribute (method)
• attribute-names (generic function)
• attribute-names (method)
• block-device-entry (class)
• character-device-entry (class)
• close-tar-file (generic function)
• close-tar-file (method)
• ctime (generic function)
• ctime (method)
• ctime (method)
• (setf ctime) (generic function)
• (setf ctime) (method)
• devmajor (generic function)
• devmajor (method)
• devmajor (method)
• devmajor (method)
• (setf devmajor) (generic function)
• (setf devmajor) (method)
• (setf devmajor) (method)
• devminor (generic function)
• devminor (method)
• devminor (method)
• devminor (method)
• (setf devminor) (generic function)
• (setf devminor) (method)
• (setf devminor) (method)
• directory-entry (class)
• do-attributes (macro)
• do-entries (macro)
• entry (class)
• entry-block-device-p (generic function)
• entry-block-device-p (method)
• entry-block-device-p (method)
• entry-character-device-p (generic function)
• entry-character-device-p (method)
• entry-character-device-p (method)
• entry-directory-p (generic function)
• entry-directory-p (method)
• entry-directory-p (method)
• entry-fifo-p (generic function)
• entry-fifo-p (method)
• entry-fifo-p (method)
• entry-file-p (generic function)
• entry-file-p (method)
• entry-file-p (method)
• entry-gnu-directory-dump-p (generic function)
• entry-gnu-directory-dump-p (method)
• entry-gnu-directory-dump-p (method)
• entry-gnu-long-link-name-p (generic function)
• entry-gnu-long-link-name-p (method)
• entry-gnu-long-link-name-p (method)
• entry-gnu-long-name-p (generic function)
• entry-gnu-long-name-p (method)
• entry-gnu-long-name-p (method)
• entry-gnu-sparse-file-p (generic function)
• entry-gnu-sparse-file-p (method)
• entry-gnu-sparse-file-p (method)
• entry-gnu-volume-header-name-p (generic function)
• entry-gnu-volume-header-name-p (method)
• entry-gnu-volume-header-name-p (method)
• entry-hard-link-p (generic function)
• entry-hard-link-p (method)
• entry-has-data-p (generic function)
• entry-has-data-p (method)
• entry-has-data-p (method)
• entry-pax-extended-attributes-p (generic function)
• entry-pax-extended-attributes-p (method)
• entry-pax-extended-attributes-p (method)
• entry-pax-global-attributes-p (generic function)
• entry-pax-global-attributes-p (method)
• entry-pax-global-attributes-p (method)
• entry-symbolic-link-p (generic function)
• entry-symbolic-link-p (method)
• entry-symbolic-link-p (method)
• entry-type (generic function)
• entry-type (method)
• entry-type (method)
• entry-type (method)
• entry-unknown-p (generic function)
• entry-unknown-p (method)
• entry-unknown-p (method)
• fifo-entry (class)
• file-entry (class)
• finalize-tar-file (generic function)
• finalize-tar-file (method)
• gid (generic function)
• gid (method)
• gid (method)
• gid (method)
• gid (method)
• (setf gid) (generic function)
• (setf gid) (method)
• (setf gid) (method)
• (setf gid) (method)
• gname (generic function)
• gname (method)
• gname (method)
• gname (method)
• (setf gname) (generic function)
• (setf gname) (method)
• (setf gname) (method)
• gnu-directory-dump-entry (class)
• gnu-long-link-name-entry (class)
• gnu-long-name-entry (class)
• gnu-sparse-file-entry (class)
• gnu-tar-file (class)
• gnu-volume-header-name-entry (class)
• hard-link-entry (class)
• invalid-checksum-error (condition)
• isextended (generic function)
• isextended (method)
• isextended (method)
• (setf isextended) (generic function)
• (setf isextended) (method)
• linkname (generic function)
• linkname (method)
• linkname (method)
• linkname (method)
• linkname (method)
• (setf linkname) (generic function)
• (setf linkname) (method)
• (setf linkname) (method)
• (setf linkname) (method)
• make-entry-stream (generic function)
• make-entry-stream (method)
• malformed-pax-attribute-entry (condition)
• mode (generic function)
• mode (method)
• mode (method)
• mode (method)
• mode (method)
• (setf mode) (generic function)
• (setf mode) (method)
• (setf mode) (method)
• (setf mode) (method)
• mtime (generic function)
• mtime (method)
• mtime (method)
• mtime (method)
• mtime (method)
• (setf mtime) (generic function)
• (setf mtime) (method)
• (setf mtime) (method)
• (setf mtime) (method)
• name (generic function)
• name (method)
• name (method)
• name (method)
• name (method)
• (setf name) (generic function)
• (setf name) (method)
• (setf name) (method)
• (setf name) (method)
• numbytes-sparse-0 (generic function)
• numbytes-sparse-0 (method)
• numbytes-sparse-0 (method)
• (setf numbytes-sparse-0) (generic function)
• (setf numbytes-sparse-0) (method)
• numbytes-sparse-1 (generic function)
• numbytes-sparse-1 (method)
• numbytes-sparse-1 (method)
• (setf numbytes-sparse-1) (generic function)
• (setf numbytes-sparse-1) (method)
• numbytes-sparse-2 (generic function)
• numbytes-sparse-2 (method)
• numbytes-sparse-2 (method)
• (setf numbytes-sparse-2) (generic function)
• (setf numbytes-sparse-2) (method)
• offset (generic function)
• offset (method)
• offset (method)
• (setf offset) (generic function)
• (setf offset) (method)
• offset-sparse-0 (generic function)
• offset-sparse-0 (method)
• offset-sparse-0 (method)
• (setf offset-sparse-0) (generic function)
• (setf offset-sparse-0) (method)
• offset-sparse-1 (generic function)
• offset-sparse-1 (method)
• offset-sparse-1 (method)
• (setf offset-sparse-1) (generic function)
• (setf offset-sparse-1) (method)
• offset-sparse-2 (generic function)
• offset-sparse-2 (method)
• offset-sparse-2 (method)
• (setf offset-sparse-2) (generic function)
• (setf offset-sparse-2) (method)
• offset-sparse-3 (generic function)
• offset-sparse-3 (method)
• offset-sparse-3 (method)
• (setf offset-sparse-3) (generic function)
• (setf offset-sparse-3) (method)
• open-tar-file (function)
• pax-extended-attributes-entry (class)
• pax-global-attributes-entry (class)
• prefix (generic function)
• prefix (method)
• prefix (method)
• (setf prefix) (generic function)
• (setf prefix) (method)
• read-entry (generic function)
• read-entry (method)
• read-entry (method)
• read-entry (method)
• realsize (generic function)
• realsize (method)
• realsize (method)
• (setf realsize) (generic function)
• (setf realsize) (method)
• size (generic function)
• size (method)
• size (method)
• size (method)
• size (method)
• (setf size) (generic function)
• (setf size) (method)
• (setf size) (method)
• (setf size) (method)
• symbolic-link-entry (class)
• tar-file (class)
• tar-file-error (condition)
• uid (generic function)
• uid (method)
• uid (method)
• uid (method)
• uid (method)
• (setf uid) (generic function)
• (setf uid) (method)
• (setf uid) (method)
• (setf uid) (method)
• uname (generic function)
• uname (method)
• uname (method)
• uname (method)
• (setf uname) (generic function)
• (setf uname) (method)
• (setf uname) (method)
• unknown-entry (class)
• ustar-tar-file (class)
• v7-tar-file (class)
• with-open-tar-file (macro)
• write-block-device-entry (generic function)
• write-block-device-entry (method)
• write-character-device-entry (generic function)
• write-character-device-entry (method)
• write-directory-entry (generic function)
• write-directory-entry (method)
• write-fifo-entry (generic function)
• write-fifo-entry (method)
• write-file-entry (generic function)
• write-file-entry (method)
• write-gnu-long-link-name-entry (generic function)
• write-gnu-long-link-name-entry (method)
• write-gnu-long-name-entry (generic function)
• write-gnu-long-name-entry (method)
• write-hard-link-entry (generic function)
• write-hard-link-entry (method)
• write-pax-extended-attributes-entry (generic function)
• write-pax-extended-attributes-entry (method)
• write-pax-global-attributes-entry (generic function)
• write-pax-global-attributes-entry (method)
• write-symbolic-link-entry (generic function)
• write-symbolic-link-entry (method)

Internal Definitions

• %%padding (generic function)
• %%padding (method)
• (setf %%padding) (method)
• %%padding (method)
• (setf %%padding) (method)
• %%padding (method)
• (setf %%padding) (method)
• (setf %%padding) (generic function)
• %position (generic function)
• %position (method)
• (setf %position) (method)
• (setf %position) (generic function)
• %tar-file-direction (generic function)
• %tar-file-direction (method)
• *default-type* (special variable)
• *gnu-magic-vector* (special variable)
• *gnu-version-vector* (special variable)
• *type-detectors* (special variable)
• *ustar-magic-vector* (special variable)
• *ustar-version-vector* (special variable)
• +ascii-/+ (constant)
• +ascii-a+ (constant)
• +ascii-newline+ (constant)
• +ascii-nine+ (constant)
• +ascii-space+ (constant)
• +ascii-z+ (constant)
• +ascii-zero+ (constant)
• +gnutar-directory-dump+ (constant)
• +gnutar-long-link-name+ (constant)
• +gnutar-long-name+ (constant)
• +gnutar-sparse+ (constant)
• +gnutar-volume-header-name+ (constant)
• +posix-extended-header+ (constant)
• +posix-global-header+ (constant)
• +tar-block-device+ (constant)
• +tar-character-device+ (constant)
• +tar-directory-file+ (constant)
• +tar-fifo-device+ (constant)
• +tar-hard-link+ (constant)
• +tar-implementation-specific-file+ (constant)
• +tar-n-block-bytes+ (constant)
• +tar-regular-alternate-file+ (constant)
• +tar-regular-file+ (constant)
• +tar-symbolic-link+ (constant)
• @block-device-entry (special variable)
• @character-device-entry (special variable)
• @conditions (special variable)
• @directory-entry (special variable)
• @entries (special variable)
• @fifo-entry (special variable)
• @file-entry (special variable)
• @gnu-directory-dump-entry (special variable)
• @gnu-long-link-name-entry (special variable)
• @gnu-long-name-entry (special variable)
• @gnu-sparse-file-entry (special variable)
• @gnu-volume-header-name-entry (special variable)
• @hard-link-entry (special variable)
• @manual (special variable)
• @opening-tar-files (special variable)
• @pax-extended-attributes-entry (special variable)
• @pax-global-attributes-entry (special variable)
• @symbolic-link-entry (special variable)
• @tar-archive-types (special variable)
• @unknown-entry (special variable)
• attribute-alist-to-bytevec (function)
• attribute-pair-to-bytevec (function)
• attributes (generic function)
• attributes (method)
• (setf attributes) (method)
• (setf attributes) (generic function)
• block-size (generic function)
• block-size (method)
• blocked-input-stream (class)
• blocked-io-stream (class)
• blocked-output-stream (class)
• blocked-stream (class)
• blocked-stream-error (condition)
• bounded-input-stream (class)
• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• (setf buffer) (generic function)
• buffer-valid-p (generic function)
• buffer-valid-p (method)
• (setf buffer-valid-p) (method)
• (setf buffer-valid-p) (generic function)
• bytevec-to-string (function)
• call-with-open-tar-file (function)
• checksum (generic function)
• checksum (method)
• checksum (method)
• checksum (method)
• checksum (method)
• (setf checksum) (generic function)
• (setf checksum) (method)
• (setf checksum) (method)
• (setf checksum) (method)
• compute-checksum-for-tar-header (function)
• compute-old-checksum-for-tar-header (function)
• computed (generic function)
• computed (method)
• define-octet-header (macro)
• detect-gnu-tar-file (function)
• detect-type (function)
• detect-ustar-tar-file (function)
• dirty-p (generic function)
• dirty-p (method)
• (setf dirty-p) (method)
• (setf dirty-p) (generic function)
• discard-buffer (generic function)
• discard-buffer (method)
• discard-buffer (method)
• discard-buffer (method)
• ensure-buffer-valid (generic function)
• ensure-buffer-valid (method)
• ensure-file-position (generic function)
• ensure-file-position (method)
• entry-tar-file (generic function)
• entry-tar-file (method)
• eof-index (generic function)
• eof-index (method)
• (setf eof-index) (method)
• (setf eof-index) (generic function)
• extractor-function-name (function)
• field-length (generic function)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-length (method)
• field-offset (generic function)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• field-offset (method)
• fill-buffer (generic function)
• fill-buffer (method)
• fill-buffer (method)
• gnu-header (class)
• gnu-header-read-%%padding-from-buffer (function)
• gnu-header-read-atime-from-buffer (function)
• gnu-header-read-checksum-from-buffer (function)
• gnu-header-read-ctime-from-buffer (function)
• gnu-header-read-devmajor-from-buffer (function)
• gnu-header-read-devminor-from-buffer (function)
• gnu-header-read-gid-from-buffer (function)
• gnu-header-read-gname-from-buffer (function)
• gnu-header-read-isextended-from-buffer (function)
• gnu-header-read-linkname-from-buffer (function)
• gnu-header-read-longnames-from-buffer (function)
• gnu-header-read-magic-from-buffer (function)
• gnu-header-read-mode-from-buffer (function)
• gnu-header-read-mtime-from-buffer (function)
• gnu-header-read-name-from-buffer (function)
• gnu-header-read-numbytes-sparse-0-from-buffer (function)
• gnu-header-read-numbytes-sparse-1-from-buffer (function)
• gnu-header-read-numbytes-sparse-2-from-buffer (function)
• gnu-header-read-numbytes-sparse-3-from-buffer (function)
• gnu-header-read-offset-from-buffer (function)
• gnu-header-read-offset-sparse-0-from-buffer (function)
• gnu-header-read-offset-sparse-1-from-buffer (function)
• gnu-header-read-offset-sparse-2-from-buffer (function)
• gnu-header-read-offset-sparse-3-from-buffer (function)
• gnu-header-read-realsize-from-buffer (function)
• gnu-header-read-size-from-buffer (function)
• gnu-header-read-typeflag-from-buffer (function)
• gnu-header-read-uid-from-buffer (function)
• gnu-header-read-uname-from-buffer (function)
• gnu-header-read-unused-from-buffer (function)
• gnu-header-read-version-from-buffer (function)
• gnu-header-write-%%padding-to-buffer (function)
• gnu-header-write-atime-to-buffer (function)
• gnu-header-write-checksum-to-buffer (function)
• gnu-header-write-ctime-to-buffer (function)
• gnu-header-write-devmajor-to-buffer (function)
• gnu-header-write-devminor-to-buffer (function)
• gnu-header-write-gid-to-buffer (function)
• gnu-header-write-gname-to-buffer (function)
• gnu-header-write-isextended-to-buffer (function)
• gnu-header-write-linkname-to-buffer (function)
• gnu-header-write-longnames-to-buffer (function)
• gnu-header-write-magic-to-buffer (function)
• gnu-header-write-mode-to-buffer (function)
• gnu-header-write-mtime-to-buffer (function)
• gnu-header-write-name-to-buffer (function)
• gnu-header-write-numbytes-sparse-0-to-buffer (function)
• gnu-header-write-numbytes-sparse-1-to-buffer (function)
• gnu-header-write-numbytes-sparse-2-to-buffer (function)
• gnu-header-write-numbytes-sparse-3-to-buffer (function)
• gnu-header-write-offset-sparse-0-to-buffer (function)
• gnu-header-write-offset-sparse-1-to-buffer (function)
• gnu-header-write-offset-sparse-2-to-buffer (function)
• gnu-header-write-offset-sparse-3-to-buffer (function)
• gnu-header-write-offset-to-buffer (function)
• gnu-header-write-realsize-to-buffer (function)
• gnu-header-write-size-to-buffer (function)
• gnu-header-write-typeflag-to-buffer (function)
• gnu-header-write-uid-to-buffer (function)
• gnu-header-write-uname-to-buffer (function)
• gnu-header-write-unused-to-buffer (function)
• gnu-header-write-version-to-buffer (function)
• has-data-mixin (class)
• header (generic function)
• header (method)
• header-encoding (generic function)
• header-encoding (method)
• (setf header-encoding) (method)
• (setf header-encoding) (generic function)
• header-length (generic function)
• header-length (method)
• header-length (method)
• header-length (method)
• header-length (method)
• header-length (method)
• header-length (method)
• header-type (generic function)
• header-type (method)
• header-type (method)
• header-type (method)
• index (generic function)
• index (method)
• (setf index) (method)
• (setf index) (generic function)
• injector-function-name (function)
• long-link-name (generic function)
• long-link-name (method)
• (setf long-link-name) (method)
• (setf long-link-name) (generic function)
• long-name (generic function)
• long-name (method)
• (setf long-name) (method)
• (setf long-name) (generic function)
• longnames (generic function)
• longnames (method)
• (setf longnames) (method)
• (setf longnames) (generic function)
• magic (generic function)
• magic (method)
• magic (method)
• magic (method)
• (setf magic) (generic function)
• (setf magic) (method)
• (setf magic) (method)
• make-bounded-stream (function)
• make-compression-stream (function)
• make-header-forwarder (macro)
• make-stream-for-entry (function)
• n-bytes-remaining (generic function)
• n-bytes-remaining (method)
• (setf n-bytes-remaining) (method)
• (setf n-bytes-remaining) (generic function)
• next-entry-start (generic function)
• next-entry-start (method)
• (setf next-entry-start) (method)
• (setf next-entry-start) (generic function)
• null-block-p (function)
• num-bytes-peeked (generic function)
• num-bytes-peeked (method)
• numbytes-sparse-3 (generic function)
• numbytes-sparse-3 (method)
• numbytes-sparse-3 (method)
• (setf numbytes-sparse-3) (generic function)
• (setf numbytes-sparse-3) (method)
• open-tar-file-p (generic function)
• open-tar-file-p (method)
• (setf open-tar-file-p) (method)
• (setf open-tar-file-p) (generic function)
• pax-attributes-entry (class)
• peeked-bytes (generic function)
• peeked-bytes (method)
• peeking-input-stream (class)
• populate-pax-attributes (function)
• provided (generic function)
• provided (method)
• read-attribute (function)
• read-attribute-length (function)
• read-bytevec-from-buffer (function)
• read-header-from-buffer (generic function)
• read-header-from-buffer (method)
• read-header-from-buffer (method)
• read-header-from-buffer (method)
• read-number-from-buffer (function)
• register-type-detector (function)
• round-up-to-tar-block (function)
• simple-blocked-stream-error (condition)
• simple-tar-file-error (condition)
• start-file-position (generic function)
• start-file-position (method)
• (setf start-file-position) (method)
• (setf start-file-position) (generic function)
• start-position (generic function)
• start-position (method)
• start-position (method)
• stream-offset (generic function)
• stream-offset (method)
• (setf stream-offset) (method)
• (setf stream-offset) (generic function)
• string-to-bytevec (function)
• tar-block-checksum-matches-p (function)
• tar-checksum-guts (function)
• tar-file-other-streams-to-close (generic function)
• tar-file-other-streams-to-close (method)
• tar-file-stream (generic function)
• tar-file-stream (method)
• transfer-octets-to-tar-file (function)
• transfer-stream-to-tar-file (function)
• typeflag (generic function)
• typeflag (method)
• typeflag (method)
• typeflag (method)
• typeflag (method)
• (setf typeflag) (generic function)
• (setf typeflag) (method)
• (setf typeflag) (method)
• (setf typeflag) (method)
• unread-peeked-bytes (generic function)
• unread-peeked-bytes (method)
• (setf unread-peeked-bytes) (method)
• (setf unread-peeked-bytes) (generic function)
• unused (generic function)
• unused (method)
• (setf unused) (method)
• (setf unused) (generic function)
• user-attributes-to-alist (generic function)
• user-attributes-to-alist (method)
• user-attributes-to-alist (method)
• ustar-header (class)
• ustar-header-read-%%padding-from-buffer (function)
• ustar-header-read-checksum-from-buffer (function)
• ustar-header-read-devmajor-from-buffer (function)
• ustar-header-read-devminor-from-buffer (function)
• ustar-header-read-gid-from-buffer (function)
• ustar-header-read-gname-from-buffer (function)
• ustar-header-read-linkname-from-buffer (function)
• ustar-header-read-magic-from-buffer (function)
• ustar-header-read-mode-from-buffer (function)
• ustar-header-read-mtime-from-buffer (function)
• ustar-header-read-name-from-buffer (function)
• ustar-header-read-prefix-from-buffer (function)
• ustar-header-read-size-from-buffer (function)
• ustar-header-read-typeflag-from-buffer (function)
• ustar-header-read-uid-from-buffer (function)
• ustar-header-read-uname-from-buffer (function)
• ustar-header-read-version-from-buffer (function)
• ustar-header-write-%%padding-to-buffer (function)
• ustar-header-write-checksum-to-buffer (function)
• ustar-header-write-devmajor-to-buffer (function)
• ustar-header-write-devminor-to-buffer (function)
• ustar-header-write-gid-to-buffer (function)
• ustar-header-write-gname-to-buffer (function)
• ustar-header-write-linkname-to-buffer (function)
• ustar-header-write-magic-to-buffer (function)
• ustar-header-write-mode-to-buffer (function)
• ustar-header-write-mtime-to-buffer (function)
• ustar-header-write-name-to-buffer (function)
• ustar-header-write-prefix-to-buffer (function)
• ustar-header-write-size-to-buffer (function)
• ustar-header-write-typeflag-to-buffer (function)
• ustar-header-write-uid-to-buffer (function)
• ustar-header-write-uname-to-buffer (function)
• ustar-header-write-version-to-buffer (function)
• v7-header (class)
• v7-header-read-%%padding-from-buffer (function)
• v7-header-read-checksum-from-buffer (function)
• v7-header-read-gid-from-buffer (function)
• v7-header-read-linkname-from-buffer (function)
• v7-header-read-mode-from-buffer (function)
• v7-header-read-mtime-from-buffer (function)
• v7-header-read-name-from-buffer (function)
• v7-header-read-size-from-buffer (function)
• v7-header-read-typeflag-from-buffer (function)
• v7-header-read-uid-from-buffer (function)
• v7-header-write-%%padding-to-buffer (function)
• v7-header-write-checksum-to-buffer (function)
• v7-header-write-gid-to-buffer (function)
• v7-header-write-linkname-to-buffer (function)
• v7-header-write-mode-to-buffer (function)
• v7-header-write-mtime-to-buffer (function)
• v7-header-write-name-to-buffer (function)
• v7-header-write-size-to-buffer (function)
• v7-header-write-typeflag-to-buffer (function)
• v7-header-write-uid-to-buffer (function)
• version (generic function)
• version (method)
• version (method)
• version (method)
• (setf version) (generic function)
• (setf version) (method)
• (setf version) (method)
• wrapped-stream (generic function)
• wrapped-stream (method)
• wrapped-stream (method)
• wrapped-stream (method)
• write-entry (generic function)
• write-entry (method)
• write-entry (method)
• write-entry-data (generic function)
• write-entry-data (method)
• write-header-to-buffer (generic function)
• write-header-to-buffer (method)
• write-header-to-buffer (method)
• write-header-to-buffer (method)
• write-number-to-buffer (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *default-header-encoding*

The default encoding to use for strings read from/written to tar headers. Must be recognized by Babel.

Package

tar-file

Source

utils.lisp (file)

5.1.2 Macros

Macro: do-attributes (NAME VALUE ENTRY &optional RESULT) &body BODY

Given a PAX ENTRY with attributes, execute BODY for every attribute, with NAME bound to the attribute name and VALUE bound to the attribute value.

Package

tar-file

Source

entry.lisp (file)

Macro: do-entries (ENTRY TAR-FILE &optional RESULT) &body BODY

Iterate over the entries in TAR-FILE. For each entry, ENTRY is bound to an ENTRY representing the entry. RESULT is used as in DOTIMES.

Package

tar-file

Source

external-macros.lisp (file)

Macro: with-open-tar-file (TAR-FILE-VAR PATHNAME-OR-STREAM &key DIRECTION IF-EXISTS IF-DOES-NOT-EXIST TYPE COMPRESSION BLOCKING-FACTOR HEADER-ENCODING) &body BODY

Bind TAR-FILE-VAR to a newly opened TAR-FILE, backed by
PATHNAME-OR-STREAM. If PATHNAME-OR-STREAM evaluates to a stream, that stream is used directly, otherwise, it is opened via OPEN. If PATHNAME-OR-STREAM is a stream, that stream is not closed upon exiting the body of the macro.

DIRECTION must be either :INPUT or :OUTPUT.

IF-EXISTS and IF-DOES-NOT-EXIST are passed to OPEN if PATHNAME-OR-STREAM is not a stream.

See OPEN-TAR-FILE for a description of TYPE, BLOCKING-FACTOR, HEADER-ENCODING, and COMPRESSION.

Package

tar-file

Source

external-macros.lisp (file)

5.1.3 Functions

Function: open-tar-file STREAM &key DIRECTION TYPE BLOCKING-FACTOR HEADER-ENCODING COMPRESSION

Create a TAR-FILE object backed by STREAM. The STREAM should not be read from or written to any more.

DIRECTION is either :INPUT or :OUTPUT.

BLOCKING-FACTOR is an integer that specifies how many 512-byte blocks should be read from or written to STREAM at any one time.

TYPE is either AUTO or a class designator for a subclass of TAR-FILE. If :AUTO, the appropriate class will be determined by looking at the first tar header.

HEADER-ENCODING is an encoding specifier recognized by Babel.

COMPRESSION determines what compression scheme is used, if any. It can be either :AUTO (the default), NIL (no compression), or :GZIP. If :AUTO, the compression type is determined using the PATHNAME of the stream (for :OUTPUT) or by peeking at the stream for magic numbers (for :INPUT).

Package

tar-file

Source

tar-file.lisp (file)

5.1.4 Generic functions

Generic Function: atime ENTRY

Return the atime of the ENTRY (an integer).

Package

tar-file

Source

generics.lisp (file)

Writer

(setf atime) (generic function)

Methods

Method: atime (GNU-HEADER gnu-header)

automatically generated reader method

Source

gnu.lisp (file)

Method: atime (ENTRY entry)

Source

entry.lisp (file)

Generic Function: (setf atime) NEW-VALUE OBJECT

Package

tar-file

Reader

atime (generic function)

Methods

Method: (setf atime) NEW-VALUE (GNU-HEADER gnu-header)

automatically generated writer method

Source

gnu.lisp (file)

Generic Function: attribute ENTRY NAME &optional DEFAULT

Get the NAME attribute from ENTRY.

Package

tar-file

Source

entry.lisp (file)

Methods

Method: attribute (ENTRY pax-attributes-entry) NAME &optional DEFAULT

Generic Function: attribute-names ENTRY

Return a list of attribute names contained within ENTRY.

Package

tar-file

Source

entry.lisp (file)

Methods

Method: attribute-names (ENTRY pax-attributes-entry)

Generic Function: close-tar-file TAR-FILE

Closes the stream associated with TAR-FILE and the tar-file itself. Further operations on the tar-file are undefined.

Does NOT close the underlying STREAM that backed the TAR-FILE.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: close-tar-file TAR-FILE

Source

tar-file.lisp (file)

Generic Function: ctime ENTRY

Return the ctime of the ENTRY (an integer).

Package

tar-file

Source

generics.lisp (file)

Writer

(setf ctime) (generic function)

Methods

Method: ctime (GNU-HEADER gnu-header)

automatically generated reader method

Source

gnu.lisp (file)

Method: ctime (ENTRY entry)

Source

entry.lisp (file)

Generic Function: (setf ctime) NEW-VALUE OBJECT

Package

tar-file

Reader

ctime (generic function)

Methods

Method: (setf ctime) NEW-VALUE (GNU-HEADER gnu-header)

automatically generated writer method

Source

gnu.lisp (file)

Generic Function: devmajor ENTRY

Return the major device of the ENTRY (an integer).

Package

tar-file

Source

generics.lisp (file)

Writer

(setf devmajor) (generic function)

Methods

Method: devmajor (USTAR-HEADER ustar-header)

automatically generated reader method

Source

ustar.lisp (file)

Method: devmajor (GNU-HEADER gnu-header)

automatically generated reader method

Source

gnu.lisp (file)

Method: devmajor (ENTRY entry)

Source

entry.lisp (file)

Generic Function: (setf devmajor) NEW-VALUE OBJECT

Package

tar-file

Reader

devmajor (generic function)

Methods

Method: (setf devmajor) NEW-VALUE (USTAR-HEADER ustar-header)

automatically generated writer method

Source

ustar.lisp (file)

Method: (setf devmajor) NEW-VALUE (GNU-HEADER gnu-header)

automatically generated writer method

Source

gnu.lisp (file)

Generic Function: devminor ENTRY

Return the minor device of the ENTRY (an integer).

Package

tar-file

Source

generics.lisp (file)

Writer

(setf devminor) (generic function)

Methods

Method: devminor (USTAR-HEADER ustar-header)

automatically generated reader method

Source

ustar.lisp (file)

Method: devminor (GNU-HEADER gnu-header)

automatically generated reader method

Source

gnu.lisp (file)

Method: devminor (ENTRY entry)

Source

entry.lisp (file)

Generic Function: (setf devminor) NEW-VALUE OBJECT

Package

tar-file

Reader

devminor (generic function)

Methods

Method: (setf devminor) NEW-VALUE (USTAR-HEADER ustar-header)

automatically generated writer method

Source

ustar.lisp (file)

Method: (setf devminor) NEW-VALUE (GNU-HEADER gnu-header)

automatically generated writer method

Source

gnu.lisp (file)

Generic Function: entry-block-device-p ENTRY

Returns non-NIL if ENTRY denotes a block device.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-block-device-p (ENTRY block-device-entry)

Source

entry.lisp (file)

Method: entry-block-device-p ENTRY

Generic Function: entry-character-device-p ENTRY

Returns non-NIL if ENTRY denotes a character device.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-character-device-p (ENTRY character-device-entry)

Source

entry.lisp (file)

Method: entry-character-device-p ENTRY

Generic Function: entry-directory-p ENTRY

Returns non-NIL if ENTRY denotes a directory.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-directory-p (ENTRY directory-entry)

Source

entry.lisp (file)

Method: entry-directory-p ENTRY

Generic Function: entry-fifo-p ENTRY

Returns non-NIL if ENTRY denotes a fifo.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-fifo-p (ENTRY fifo-entry)

Source

entry.lisp (file)

Method: entry-fifo-p ENTRY

Generic Function: entry-file-p ENTRY

Returns non-NIL if ENTRY denotes a regular file.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-file-p (ENTRY file-entry)

Source

entry.lisp (file)

Method: entry-file-p ENTRY

Generic Function: entry-gnu-directory-dump-p ENTRY

Returns non-NIL if ENTRY contains a GNU directory dump.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-gnu-directory-dump-p (ENTRY gnu-directory-dump-entry)

Source

entry.lisp (file)

Method: entry-gnu-directory-dump-p ENTRY

Generic Function: entry-gnu-long-link-name-p ENTRY

Returns non-NIL if ENTRY contains a GNU long link name.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-gnu-long-link-name-p (ENTRY gnu-long-link-name-entry)

Source

entry.lisp (file)

Method: entry-gnu-long-link-name-p ENTRY

Generic Function: entry-gnu-long-name-p ENTRY

Returns non-NIL if ENTRY contains a GNU long name.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-gnu-long-name-p (ENTRY gnu-long-name-entry)

Source

entry.lisp (file)

Method: entry-gnu-long-name-p ENTRY

Generic Function: entry-gnu-sparse-file-p ENTRY

Returns non-NIL if ENTRY contains a GNU sparse file.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-gnu-sparse-file-p (ENTRY gnu-sparse-file-entry)

Source

entry.lisp (file)

Method: entry-gnu-sparse-file-p ENTRY

Generic Function: entry-gnu-volume-header-name-p ENTRY

Returns non-NIL if ENTRY contains a GNU volume header name.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-gnu-volume-header-name-p (ENTRY gnu-volume-header-name-entry)

Source

entry.lisp (file)

Method: entry-gnu-volume-header-name-p ENTRY

Generic Function: entry-hard-link-p ENTRY

Package

tar-file

Methods

Method: entry-hard-link-p (ENTRY hard-link-entry)

Source

entry.lisp (file)

Generic Function: entry-has-data-p ENTRY

Returns non-NIL if ENTRY has associated data that can be read using MAKE-ENTRY-STREAM.

Package

tar-file

Source

entry.lisp (file)

Methods

Method: entry-has-data-p ENTRY

Method: entry-has-data-p (ENTRY has-data-mixin)

Generic Function: entry-pax-extended-attributes-p ENTRY

Returns non-NIL if ENTRY contains PAX extended attributes.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-pax-extended-attributes-p (ENTRY pax-extended-attributes-entry)

Source

entry.lisp (file)

Method: entry-pax-extended-attributes-p ENTRY

Generic Function: entry-pax-global-attributes-p ENTRY

Returns non-NIL if ENTRY contains PAX global attributes.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-pax-global-attributes-p (ENTRY pax-global-attributes-entry)

Source

entry.lisp (file)

Method: entry-pax-global-attributes-p ENTRY

Generic Function: entry-symbolic-link-p ENTRY

Returns non-NIL if ENTRY denotes a symbolic link.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-symbolic-link-p (ENTRY symbolic-link-entry)

Source

entry.lisp (file)

Method: entry-symbolic-link-p ENTRY

Generic Function: entry-type TAR-FILE HEADER

Return a symbol naming the class to use to represent the entry for HEADER in TAR-FILE.

Package

tar-file

Source

tar-file.lisp (file)

Methods

Method: entry-type (TAR-FILE v7-tar-file) HEADER

Source

v7.lisp (file)

Method: entry-type (TAR-FILE ustar-tar-file) HEADER

Source

ustar.lisp (file)

Method: entry-type (TAR-FILE gnu-tar-file) HEADER

Source

gnu.lisp (file)

Generic Function: entry-unknown-p ENTRY

Returns non-NIL if ENTRY is unknown.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: entry-unknown-p (ENTRY unknown-entry)

Source

entry.lisp (file)

Method: entry-unknown-p ENTRY

Generic Function: finalize-tar-file TAR-FILE

Perform any necessary processing for finalizing TAR-FILE. This function must be called prior to calling CLOSE-TAR-FILE.

Package

tar-file

Source

generics.lisp (file)

Methods

Method: finalize-tar-file (TAR-FILE tar-file)

Source

tar-file.lisp (file)