The tar-file Reference Manual

3.1.1 tar-file/tar-file.asd

Source

tar-file.asd.

Parent Component

tar-file (system).

ASDF Systems

tar-file.

---

3.1.2 tar-file/blocked-stream.lisp

Dependency

package.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• close (method).
• initialize-instance (method).
• stream-element-type (method).
• (setf stream-file-position) (method).
• stream-file-position (method).
• stream-read-byte (method).
• stream-read-sequence (method).
• stream-write-byte (method).
• stream-write-sequence (method).

Internals

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

---

3.1.3 tar-file/bounded-stream.lisp

Dependency

package.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• stream-read-byte (method).
• stream-read-sequence (method).

Internals

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

---

3.1.4 tar-file/buffer-ops.lisp

Dependencies

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

Source

tar-file.asd.

Parent Component

tar-file (system).

Internals

• 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

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

Internals

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

---

3.1.6 tar-file/constants.lisp

Dependency

package.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Internals

• +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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Internals

• @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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• atime (method).
• attribute (generic function).
• attribute-names (generic function).
• 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-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).
• 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).
• print-object (method).
• realsize (method).
• size (method).
• slot-unbound (method).
• slot-unbound (method).
• slot-unbound (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).

Internals

• attribute-alist-to-bytevec (function).
• attribute-pair-to-bytevec (function).
• attributes (reader method).
• (setf attributes) (writer method).
• checksum (method).
• entry-tar-file (reader method).
• has-data-mixin (class).
• header (reader method).
• long-link-name (reader method).
• (setf long-link-name) (writer method).
• long-name (reader method).
• (setf long-name) (writer 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 (reader 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

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

Internals

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

---

3.1.10 tar-file/generics.lisp

Dependency

package.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• atime (generic function).
• close-tar-file (generic function).
• ctime (generic function).
• devmajor (generic function).
• devminor (generic function).
• entry-block-device-p (generic function).
• entry-character-device-p (generic function).
• entry-directory-p (generic function).
• entry-fifo-p (generic function).
• entry-file-p (generic function).
• entry-gnu-directory-dump-p (generic function).
• entry-gnu-long-link-name-p (generic function).
• entry-gnu-long-name-p (generic function).
• entry-gnu-sparse-file-p (generic function).
• entry-gnu-volume-header-name-p (generic function).
• entry-pax-extended-attributes-p (generic function).
• entry-pax-global-attributes-p (generic function).
• entry-symbolic-link-p (generic function).
• entry-unknown-p (generic function).
• 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).

Internals

• 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

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

Internals

• %%padding (reader method).
• (setf %%padding) (writer method).
• *gnu-magic-vector* (special variable).
• *gnu-version-vector* (special variable).
• checksum (reader method).
• (setf checksum) (writer 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 (reader method).
• (setf longnames) (writer method).
• magic (reader method).
• (setf magic) (writer method).
• numbytes-sparse-3 (reader method).
• (setf numbytes-sparse-3) (writer method).
• read-header-from-buffer (method).
• typeflag (reader method).
• (setf typeflag) (writer method).
• unused (reader method).
• (setf unused) (writer method).
• version (reader method).
• (setf version) (writer method).
• write-header-to-buffer (method).

---

3.1.12 tar-file/macros.lisp

Dependency

generics.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Internals

• 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

Source

tar-file.asd.

Parent Component

tar-file (system).

Packages

tar-file.

---

3.1.14 tar-file/peeking-stream.lisp

Dependency

package.lisp (file).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• initialize-instance (method).
• (setf stream-file-position) (method).
• stream-file-position (method).
• stream-read-byte (method).
• stream-read-sequence (method).

Internals

• num-bytes-peeked (reader method).
• peeked-bytes (reader method).
• peeking-input-stream (class).
• start-position (reader method).
• unread-peeked-bytes (reader method).
• (setf unread-peeked-bytes) (writer method).
• wrapped-stream (reader 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

• 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).

Internals

• %tar-file-direction (reader method).
• *default-type* (special variable).
• *type-detectors* (special variable).
• detect-type (function).
• header-encoding (reader method).
• (setf header-encoding) (writer method).
• header-type (generic function).
• make-compression-stream (function).
• make-stream-for-entry (function).
• next-entry-start (reader method).
• (setf next-entry-start) (writer method).
• open-tar-file-p (reader method).
• (setf open-tar-file-p) (writer method).
• register-type-detector (function).
• tar-file-other-streams-to-close (reader method).
• tar-file-stream (reader 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

*default-header-encoding* (special variable).

Internals

• 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).

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

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

Internals

• %%padding (reader method).
• (setf %%padding) (writer method).
• *ustar-magic-vector* (special variable).
• *ustar-version-vector* (special variable).
• checksum (reader method).
• (setf checksum) (writer 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 (reader method).
• (setf magic) (writer method).
• read-header-from-buffer (method).
• typeflag (reader method).
• (setf typeflag) (writer 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 (reader method).
• (setf version) (writer method).
• write-header-to-buffer (method).

---

3.1.18 tar-file/v7.lisp

Dependencies

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

Source

tar-file.asd.

Parent Component

tar-file (system).

Public Interface

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

Internals

• %%padding (reader method).
• (setf %%padding) (writer method).
• checksum (reader method).
• (setf checksum) (writer 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 (reader method).
• (setf typeflag) (writer 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).

---

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.

---

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.

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.

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.

---

5.1.3 Ordinary 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.

---

5.1.4 Generic functions

Generic Function: atime (entry) ¶

Return the atime of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: atime ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

atime.

Method: atime ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf atime) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf atime) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

atime.

Generic Function: attribute (entry name &optional default) ¶

Get the NAME attribute from ENTRY.

Package

tar-file.

Source

entry.lisp.

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.

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.

Methods

Method: close-tar-file (tar-file) ¶

Source

tar-file.lisp.

Generic Function: ctime (entry) ¶

Return the ctime of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: ctime ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

ctime.

Method: ctime ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf ctime) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf ctime) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

ctime.

Generic Function: devmajor (entry) ¶

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

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: devmajor ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

devmajor.

Reader Method: devmajor ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

devmajor.

Method: devmajor ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf devmajor) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf devmajor) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

devmajor.

Writer Method: (setf devmajor) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

devmajor.

Generic Function: devminor (entry) ¶

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

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: devminor ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

devminor.

Reader Method: devminor ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

devminor.

Method: devminor ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf devminor) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf devminor) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

devminor.

Writer Method: (setf devminor) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

devminor.

Generic Function: entry-block-device-p (entry) ¶

Returns non-NIL if ENTRY denotes a block device.

Package

tar-file.

Source

generics.lisp.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

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.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

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

Source

entry.lisp.

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.

Methods

Method: entry-type ((tar-file v7-tar-file) header) ¶

Source

v7.lisp.

Method: entry-type ((tar-file ustar-tar-file) header) ¶

Source

ustar.lisp.

Method: entry-type ((tar-file gnu-tar-file) header) ¶

Source

gnu.lisp.

Generic Function: entry-unknown-p (entry) ¶

Returns non-NIL if ENTRY is unknown.

Package

tar-file.

Source

generics.lisp.

Methods

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

Source

entry.lisp.

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.

Methods

Method: finalize-tar-file ((tar-file tar-file)) ¶

Source

tar-file.lisp.

Generic Function: gid (entry) ¶

Return the gid of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: gid ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

gid.

Reader Method: gid ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

gid.

Reader Method: gid ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

gid.

Method: gid ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf gid) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf gid) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

gid.

Writer Method: (setf gid) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

gid.

Writer Method: (setf gid) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

gid.

Generic Function: gname (entry) ¶

Return the gname of the ENTRY (a string).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: gname ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

gname.

Reader Method: gname ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

gname.

Method: gname ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf gname) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf gname) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

gname.

Writer Method: (setf gname) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

gname.

Generic Function: isextended (entry) ¶

Return the isextended field of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: isextended ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

isextended.

Method: isextended ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf isextended) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf isextended) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

isextended.

Generic Function: linkname (entry) ¶

Return the linkname of the ENTRY (a string).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: linkname ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

linkname.

Reader Method: linkname ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

linkname.

Reader Method: linkname ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

linkname.

Method: linkname ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf linkname) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf linkname) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

linkname.

Writer Method: (setf linkname) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

linkname.

Writer Method: (setf linkname) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

linkname.

Generic Function: make-entry-stream (entry) ¶

Returns a new binary stream that contains ENTRY’s data.

Package

tar-file.

Source

entry.lisp.

Methods

Method: make-entry-stream ((entry has-data-mixin)) ¶

Generic Function: mode (entry) ¶

Return the mode of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: mode ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

mode.

Reader Method: mode ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

mode.

Reader Method: mode ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

mode.

Method: mode ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf mode) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf mode) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

mode.

Writer Method: (setf mode) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

mode.

Writer Method: (setf mode) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

mode.

Generic Function: mtime (entry) ¶

Return the mtime of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: mtime ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

mtime.

Reader Method: mtime ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

mtime.

Reader Method: mtime ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

mtime.

Method: mtime ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf mtime) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf mtime) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

mtime.

Writer Method: (setf mtime) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

mtime.

Writer Method: (setf mtime) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

mtime.

Generic Function: name (entry) ¶

Return the name of the ENTRY (a string).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: name ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

name.

Reader Method: name ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

name.

Reader Method: name ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

name.

Method: name ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf name) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf name) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

name.

Writer Method: (setf name) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

name.

Writer Method: (setf name) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

name.

Generic Function: numbytes-sparse-0 (entry) ¶

Return the numbytes of the first sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: numbytes-sparse-0 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

numbytes-sparse-0.

Method: numbytes-sparse-0 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf numbytes-sparse-0) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf numbytes-sparse-0) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

numbytes-sparse-0.

Generic Function: numbytes-sparse-1 (entry) ¶

Return the numbytes of the second sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: numbytes-sparse-1 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

numbytes-sparse-1.

Method: numbytes-sparse-1 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf numbytes-sparse-1) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf numbytes-sparse-1) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

numbytes-sparse-1.

Generic Function: numbytes-sparse-2 (entry) ¶

Return the numbytes of the third sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: numbytes-sparse-2 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

numbytes-sparse-2.

Method: numbytes-sparse-2 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf numbytes-sparse-2) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf numbytes-sparse-2) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

numbytes-sparse-2.

Generic Function: offset (entry) ¶

Return the offset of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: offset ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

offset.

Method: offset ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf offset) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf offset) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

offset.

Generic Function: offset-sparse-0 (entry) ¶

Return the offset of the first sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: offset-sparse-0 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

offset-sparse-0.

Method: offset-sparse-0 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf offset-sparse-0) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf offset-sparse-0) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

offset-sparse-0.

Generic Function: offset-sparse-1 (entry) ¶

Return the offset of the second sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: offset-sparse-1 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

offset-sparse-1.

Method: offset-sparse-1 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf offset-sparse-1) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf offset-sparse-1) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

offset-sparse-1.

Generic Function: offset-sparse-2 (entry) ¶

Return the offset of the third sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: offset-sparse-2 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

offset-sparse-2.

Method: offset-sparse-2 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf offset-sparse-2) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf offset-sparse-2) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

offset-sparse-2.

Generic Function: offset-sparse-3 (entry) ¶

Return the offset of the fourth sparse block of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: offset-sparse-3 ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

offset-sparse-3.

Method: offset-sparse-3 ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf offset-sparse-3) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf offset-sparse-3) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

offset-sparse-3.

Generic Function: prefix (entry) ¶

Return the prefix of the ENTRY (a string).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: prefix ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

prefix.

Method: prefix ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf prefix) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf prefix) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

prefix.

Generic Function: read-entry (tar-file) ¶

Return the next entry in TAR-FILE or NIL if there is no next entry

Package

tar-file.

Source

generics.lisp.

Methods

Method: read-entry :around ((tar-file tar-file)) ¶

Source

tar-file.lisp.

Method: read-entry ((tar-file tar-file)) ¶

Source

tar-file.lisp.

Method: read-entry :before ((tar-file tar-file)) ¶

Source

tar-file.lisp.

Generic Function: realsize (entry) ¶

Return the realsize of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: realsize ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

realsize.

Method: realsize ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf realsize) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf realsize) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

realsize.

Generic Function: size (entry) ¶

Return the size of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: size ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

size.

Reader Method: size ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

size.

Reader Method: size ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

size.

Method: size ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf size) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf size) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

size.

Writer Method: (setf size) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

size.

Writer Method: (setf size) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

size.

Generic Function: uid (entry) ¶

Return the uid of the ENTRY (an integer).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: uid ((v7-header v7-header)) ¶

automatically generated reader method

Source

v7.lisp.

Target Slot

uid.

Reader Method: uid ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

uid.

Reader Method: uid ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

uid.

Method: uid ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf uid) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf uid) ((v7-header v7-header)) ¶

automatically generated writer method

Source

v7.lisp.

Target Slot

uid.

Writer Method: (setf uid) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

uid.

Writer Method: (setf uid) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

uid.

Generic Function: uname (entry) ¶

Return the uname of the ENTRY (a string).

Package

tar-file.

Source

generics.lisp.

Methods

Reader Method: uname ((ustar-header ustar-header)) ¶

automatically generated reader method

Source

ustar.lisp.

Target Slot

uname.

Reader Method: uname ((gnu-header gnu-header)) ¶

automatically generated reader method

Source

gnu.lisp.

Target Slot

uname.

Method: uname ((entry entry)) ¶

Source

entry.lisp.

Generic Writer: (setf uname) (object) ¶

Package

tar-file.

Methods

Writer Method: (setf uname) ((ustar-header ustar-header)) ¶

automatically generated writer method

Source

ustar.lisp.

Target Slot

uname.

Writer Method: (setf uname) ((gnu-header gnu-header)) ¶

automatically generated writer method

Source

gnu.lisp.

Target Slot

uname.

Generic Function: write-block-device-entry (tar-file name &rest args &key uname gname mode mtime uid gid devmajor devminor prefix) ¶

Write a BLOCK-DEVICE-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-block-device-entry (tar-file name &rest args &key uname gname mode mtime uid gid devmajor devminor prefix) ¶

Source

entry.lisp.

Generic Function: write-character-device-entry (tar-file name &rest args &key uname gname mode mtime uid gid devmajor devminor prefix) ¶

Write a CHARACTER-DEVICE-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-character-device-entry (tar-file name &rest args &key uname gname mode mtime uid gid devmajor devminor prefix) ¶

Source

entry.lisp.

Generic Function: write-directory-entry (tar-file name &rest args &key uname gname mode mtime uid gid size prefix) ¶

Write a DIRECTORY-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-directory-entry (tar-file name &rest args &key uname gname mode mtime uid gid size prefix) ¶

Source

entry.lisp.

Generic Function: write-fifo-entry (tar-file name &rest args &key uname gname mode mtime uid gid prefix) ¶

Write a FIFO-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-fifo-entry (tar-file name &rest args &key uname gname mode mtime uid gid prefix) ¶

Source

entry.lisp.

Generic Function: write-file-entry (tar-file name &rest args &key uname gname mode mtime uid gid size data prefix) ¶

Write a FILE-ENTRY to TAR-FILE.

DATA can be either NIL (no data is written), an octet vector (written as is), a string (encoded using UTF-8 and written), or a PATHNAME (opened, read, and written to the archive).

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-file-entry (tar-file name &rest args &key uname gname mode mtime uid gid size data prefix) ¶

Source

entry.lisp.

Generic Function: write-gnu-long-link-name-entry (tar-file name &rest args &key data) ¶

Write a GNU-LONG-LINK-NAME-ENTRY to TAR-FILE.

DATA must be either a string (which is then UTF-8 encoded) or a byte vector.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-gnu-long-link-name-entry (tar-file name &rest args &key data) ¶

Source

entry.lisp.

Generic Function: write-gnu-long-name-entry (tar-file name &rest args &key data) ¶

Write a GNU-LONG-NAME-ENTRY to TAR-FILE.

DATA must be either a string (which is then UTF-8 encoded) or a byte vector.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-gnu-long-name-entry (tar-file name &rest args &key data) ¶

Source

entry.lisp.

Generic Function: write-hard-link-entry (tar-file name &rest args &key uname gname mode mtime uid gid linkname prefix) ¶

Write a HARD-LINK-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-hard-link-entry (tar-file name &rest args &key uname gname mode mtime uid gid linkname prefix) ¶

Source

entry.lisp.

Generic Function: write-pax-extended-attributes-entry (tar-file name &rest args &key attributes) ¶

Write a PAX-EXTENDED-ATTRIBUTES-ENTRY to TAR-FILE.

ATTRIBUTES must be either a hash table mapping strings to strings or an alist mapping strings to strings. If it is an alist, ordering is preserved.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-pax-extended-attributes-entry (tar-file name &rest args &key attributes) ¶

Source

entry.lisp.

Generic Function: write-pax-global-attributes-entry (tar-file name &rest args &key attributes) ¶

Write a PAX-GLOBAL-ATTRIBUTES-ENTRY to TAR-FILE.

ATTRIBUTES must be either a hash table mapping strings to strings or an alist mapping strings to strings. If it is an alist, ordering is preserved.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-pax-global-attributes-entry (tar-file name &rest args &key attributes) ¶

Source

entry.lisp.

Generic Function: write-symbolic-link-entry (tar-file name &rest args &key uname gname mode mtime uid gid linkname prefix) ¶

Write a SYMBOLIC-LINK-ENTRY to TAR-FILE.

Package

tar-file.

Source

generics.lisp.

Methods

Method: write-symbolic-link-entry (tar-file name &rest args &key uname gname mode mtime uid gid linkname prefix) ¶

Source

entry.lisp.

---