The tar Reference Manual

3.1.1 tar/tar.asd

Source

tar.asd.

Parent Component

tar (system).

ASDF Systems

tar.

---

3.1.2 tar/archive.lisp

Dependency

package.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

• archive (class).
• close-archive (generic function).
• do-entries (macro).
• open-archive (function).
• read-entry (generic function).
• with-open-archive (macro).
• write-entry (generic function).

Internals

• %write-entry (generic function).
• archive-direction (reader method).
• archive-file (reader method).
• archive-opened-stream (reader method).
• archive-supports-property-p (generic function).
• archive-type-to-tar-file-type (generic function).
• call-with-open-archive (function).
• convert-from-physical-entry (generic function).
• tar-file-to-archive-type (generic function).

---

3.1.3 tar/conditions.lisp

Dependency

package.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

• ignore-unsupported-property (function).
• property-value-too-long (condition).
• required-property-missing (condition).
• required-property-missing-name (reader method).
• tar-condition (condition).
• tar-error (condition).
• truncate-value (function).
• unsupported-property (condition).
• unsupported-property-value (condition).
• unsupported-property-value-name (reader method).
• unsupported-property-value-value (reader method).
• with-ignored-unsupported-properties (macro).
• with-truncated-unsupported-values (macro).

Internals

• call-with-ignored-unsupported-properties (function).
• call-with-truncated-unsupported-values (function).
• unbound-property (condition).
• unbound-property-name (reader method).
• unsupported-property-name (reader method).

---

3.1.4 tar/entry.lisp

Dependencies

• package.lisp (file).
• utils.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

• archive (reader method).
• (setf archive) (writer method).
• atime (generic function).
• (setf atime) (generic function).
• block-device-entry (class).
• character-device-entry (class).
• ctime (generic function).
• (setf ctime) (generic function).
• devmajor (generic reader).
• (setf devmajor) (generic writer).
• devminor (generic reader).
• (setf devminor) (generic writer).
• directory-entry (class).
• entry (class).
• fifo-entry (class).
• file-entry (class).
• gid (generic reader).
• (setf gid) (generic writer).
• gname (generic function).
• (setf gname) (generic function).
• hard-link-entry (class).
• linkname (generic reader).
• (setf linkname) (generic writer).
• make-entry-stream (generic function).
• mode (generic reader).
• (setf mode) (generic writer).
• mode-list (type).
• mtime (generic reader).
• (setf mtime) (generic writer).
• name (generic reader).
• (setf name) (generic writer).
• size (generic reader).
• (setf size) (generic writer).
• symbolic-link-entry (class).
• uid (generic reader).
• (setf uid) (generic writer).
• uname (generic function).
• (setf uname) (generic function).

Internals

• data (reader method).
• define-entry-property (macro).
• define-optional-entry-property (macro).
• device-entry (class).
• entry-property-slot-names (generic function).
• has-data-mixin (class).
• link-entry (class).
• permissions-list-p (function).
• physical-entry (reader method).
• unknown-entry (class).

---

3.1.5 tar/gnu-archive.lisp

Dependencies

• package.lisp (file).
• archive.lisp (file).
• utils.lisp (file).
• validation.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

gnu-archive (class).

Internals

• archive-supports-property-p (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).

---

3.1.6 tar/package.lisp

Source

tar.asd.

Parent Component

tar (system).

Packages

tar.

---

3.1.7 tar/pax-archive.lisp

Dependencies

• package.lisp (file).
• archive.lisp (file).
• utils.lisp (file).
• validation.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

pax-archive (class).

Internals

• %write-entry (method).
• archive-default-attributes (reader method).
• archive-supports-negative-time-p (method).
• archive-supports-property-p (method).
• archive-supports-sub-seconds-p (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• check-property-for-writing (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).

---

3.1.8 tar/ustar-archive.lisp

Dependencies

• package.lisp (file).
• archive.lisp (file).
• utils.lisp (file).
• validation.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

ustar-archive (class).

Internals

• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• archive-supports-negative-time-p (method).
• archive-supports-property-p (method).
• archive-supports-sub-seconds-p (method).
• check-property-for-writing (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• integer-max-value (method).
• integer-max-value (method).
• integer-max-value (method).
• integer-max-value (method).
• integer-max-value (method).
• split-name (function).
• string-max-length (method).
• string-max-length (method).
• string-max-length (method).
• string-max-length (method).

---

3.1.9 tar/utils.lisp

Dependency

package.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Internals

• +mode-permissions+ (constant).
• maybe-truncate (function).
• mode-to-permissions (function).
• permissions-to-mode (function).
• string-to-timestamp (function).
• tar-file-entry-with-prefix-name (function).
• timestamp-to-string (function).

---

3.1.10 tar/v7-archive.lisp

Dependencies

• package.lisp (file).
• archive.lisp (file).
• validation.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Public Interface

v7-archive (class).

Internals

• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• %write-entry (method).
• archive-supports-negative-time-p (method).
• archive-supports-sub-seconds-p (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• convert-from-physical-entry (method).
• integer-max-value (method).
• integer-max-value (method).
• integer-max-value (method).
• string-max-length (method).
• string-max-length (method).

---

3.1.11 tar/validation.lisp

Dependencies

• package.lisp (file).
• archive.lisp (file).
• entry.lisp (file).

Source

tar.asd.

Parent Component

tar (system).

Internals

• archive-supports-negative-time-p (generic function).
• archive-supports-sub-seconds-p (generic function).
• check-integer-max-value (function).
• check-properties (generic function).
• check-property-for-writing (generic function).
• check-required-property (function).
• check-string-length (function).
• check-timestamp (function).
• integer-max-value (generic function).
• string-max-length (generic function).

---

5.1.1 Macros

Macro: do-entries ((entry archive &optional result) &body body) ¶

Iterate over the entries in ARCHIVE. For each entry, ENTRY is bound to an ENTRY representing the entry. RESULT is returned.

Package

tar.

Source

archive.lisp.

Macro: with-ignored-unsupported-properties ((&optional value) &body body) ¶

Execute BODY in a context where UNSUPPORTED-PROPERTY errors are ignored and VALUE is returned from any attempt to access them.

Package

tar.

Source

conditions.lisp.

Macro: with-open-archive ((archive-var stream-or-path &rest args &key type direction if-exists if-does-not-exist blocking-factor header-encoding compression) &body body) ¶

Evaluate BODY with ARCHIVE-VAR bound to an instance of ARCHIVE. See OPEN-ARCHIVE for more discussion of the arguments. If STREAM-OR-PATH is a path, the underlying stream is closed upon exiting the macro. If it is a stream, it remains open.

Package

tar.

Source

archive.lisp.

Macro: with-truncated-unsupported-values ((&key properties) &body body) ¶

Evaluate BODY in a context where truncatable values are automatically truncated.

Package

tar.

Source

conditions.lisp.

---

5.1.2 Ordinary functions

Function: ignore-unsupported-property (&optional value condition) ¶

A restart to ignore an UNSUPPORTED-PROPERTY CONDITION. Either returns VALUE from the accessor or silently ignores the attempt to set the value.

Package

tar.

Source

conditions.lisp.

Function: open-archive (stream-or-path &key type direction if-exists if-does-not-exist blocking-factor compression header-encoding) ¶

Create a tar archive object backed by STREAM-OR-PATH. If a stream, it 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 ARCHIVE. 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.

Source

archive.lisp.

Function: truncate-value (&optional condition) ¶

Truncate the value and write it to the archive.

Package

tar.

Source

conditions.lisp.

---

5.1.3 Generic functions

Generic Reader: archive (object) ¶

Package

tar.

Methods

Reader Method: archive ((entry entry)) ¶

automatically generated reader method

Source

entry.lisp.

Target Slot

archive.

Generic Writer: (setf archive) (object) ¶

Package

tar.

Methods

Writer Method: (setf archive) ((entry entry)) ¶

automatically generated writer method

Source

entry.lisp.

Target Slot

archive.

Generic Function: atime (entry) ¶

The atime of ENTRY. Returns a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: atime ((entry entry)) ¶

automatically generated reader method

Target Slot

atime.

Method: atime :around (entry) ¶

Generic Function: (setf atime) (entry) ¶

Set the atime of ENTRY. VALUE must be a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf atime) ((entry entry)) ¶

automatically generated writer method

Target Slot

atime.

Method: (setf atime) :around (entry) ¶

Generic Function: close-archive (archive) ¶

Close the ARCHIVE, performing any finalization as necessary. If a pathname was passed to OPEN-ARCHIVE, then the underlying stream is closed, otherwise it remains open.

Package

tar.

Source

archive.lisp.

Methods

Method: close-archive ((archive archive)) ¶

Generic Function: ctime (entry) ¶

The ctime of ENTRY. Returns a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: ctime ((entry entry)) ¶

automatically generated reader method

Target Slot

ctime.

Method: ctime :around (entry) ¶

Generic Function: (setf ctime) (entry) ¶

Set the ctime of ENTRY. VALUE must be a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf ctime) ((entry entry)) ¶

automatically generated writer method

Target Slot

ctime.

Method: (setf ctime) :around (entry) ¶

Generic Reader: devmajor (entry) ¶

The devmajor of ENTRY. Returns a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Reader Method: devmajor ((device-entry device-entry)) ¶

automatically generated reader method

Target Slot

devmajor.

Generic Writer: (setf devmajor) (entry) ¶

Set the devmajor of ENTRY. VALUE must be a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf devmajor) ((device-entry device-entry)) ¶

automatically generated writer method

Target Slot

devmajor.

Generic Reader: devminor (entry) ¶

The devminor of ENTRY. Returns a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Reader Method: devminor ((device-entry device-entry)) ¶

automatically generated reader method

Target Slot

devminor.

Generic Writer: (setf devminor) (entry) ¶

Set the devminor of ENTRY. VALUE must be a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf devminor) ((device-entry device-entry)) ¶

automatically generated writer method

Target Slot

devminor.

Generic Reader: gid (entry) ¶

The gid of ENTRY. Returns a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Reader Method: gid ((entry entry)) ¶

automatically generated reader method

Target Slot

gid.

Generic Writer: (setf gid) (entry) ¶

Set the gid of ENTRY. VALUE must be a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf gid) ((entry entry)) ¶

automatically generated writer method

Target Slot

gid.

Generic Function: gname (entry) ¶

The gname of ENTRY. Returns a STRING.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: gname ((entry entry)) ¶

automatically generated reader method

Target Slot

gname.

Method: gname :around (entry) ¶

Generic Function: (setf gname) (entry) ¶

Set the gname of ENTRY. VALUE must be a STRING.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf gname) ((entry entry)) ¶

automatically generated writer method

Target Slot

gname.

Method: (setf gname) :around (entry) ¶

Generic Reader: linkname (entry) ¶

The linkname of ENTRY. Returns a STRING.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: linkname ((link-entry link-entry)) ¶

automatically generated reader method

Target Slot

linkname.

Generic Writer: (setf linkname) (entry) ¶

Set the linkname of ENTRY. VALUE must be a STRING.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf linkname) ((link-entry link-entry)) ¶

automatically generated writer method

Target Slot

linkname.

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

Return a binary stream with the contents of ENTRY. Depending on the the type of stream underlying the archive (if it is seekable or not) and the BLOCKING-FACTOR given to OPEN-ARCHIVE, this may be callable either once or multiple times per entry, may or may not be callable after the next call to READ-ENTRY, and the the returned stream may or may not be readable after the next call to READ-ENTRY.

For maximum compatibility, you should call this only once per ENTRY and completely read from the stream before calling READ-ENTRY again.

Package

tar.

Source

entry.lisp.

Methods

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

Generic Reader: mode (entry) ¶

The mode of ENTRY. Returns a MODE-LIST.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: mode ((entry entry)) ¶

automatically generated reader method

Target Slot

mode.

Generic Writer: (setf mode) (entry) ¶

Set the mode of ENTRY. VALUE must be a MODE-LIST.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf mode) ((entry entry)) ¶

automatically generated writer method

Target Slot

mode.

Generic Reader: mtime (entry) ¶

The mtime of ENTRY. Returns a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: mtime ((entry entry)) ¶

automatically generated reader method

Target Slot

mtime.

Generic Writer: (setf mtime) (entry) ¶

Set the mtime of ENTRY. VALUE must be a TIMESTAMP.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf mtime) ((entry entry)) ¶

automatically generated writer method

Target Slot

mtime.

Generic Reader: name (entry) ¶

The name of ENTRY. Returns a STRING.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: name ((entry entry)) ¶

automatically generated reader method

Target Slot

name.

Generic Writer: (setf name) (entry) ¶

Set the name of ENTRY. VALUE must be a STRING.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf name) ((entry entry)) ¶

automatically generated writer method

Target Slot

name.

Generic Function: read-entry (archive) ¶

Read an ENTRY from ARCHIVE.

Package

tar.

Source

archive.lisp.

Methods

Method: read-entry ((archive archive)) ¶

Generic Reader: required-property-missing-name (condition) ¶

Package

tar.

Methods

Reader Method: required-property-missing-name ((condition required-property-missing)) ¶

Source

conditions.lisp.

Target Slot

name.

Generic Reader: size (entry) ¶

The size of ENTRY. Returns a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Reader Method: size ((unknown-entry unknown-entry)) ¶

automatically generated reader method

Target Slot

size.

Reader Method: size ((directory-entry directory-entry)) ¶

automatically generated reader method

Target Slot

size.

Reader Method: size ((file-entry file-entry)) ¶

automatically generated reader method

Target Slot

size.

Generic Writer: (setf size) (entry) ¶

Set the size of ENTRY. VALUE must be a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf size) ((unknown-entry unknown-entry)) ¶

automatically generated writer method

Target Slot

size.

Writer Method: (setf size) ((directory-entry directory-entry)) ¶

automatically generated writer method

Target Slot

size.

Writer Method: (setf size) ((file-entry file-entry)) ¶

automatically generated writer method

Target Slot

size.

Generic Reader: uid (entry) ¶

The uid of ENTRY. Returns a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Reader Method: uid ((entry entry)) ¶

automatically generated reader method

Target Slot

uid.

Generic Writer: (setf uid) (entry) ¶

Set the uid of ENTRY. VALUE must be a (INTEGER 0).

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf uid) ((entry entry)) ¶

automatically generated writer method

Target Slot

uid.

Generic Function: uname (entry) ¶

The uname of ENTRY. Returns a STRING.

Package

tar.

Source

entry.lisp.

Methods

Reader Method: uname ((entry entry)) ¶

automatically generated reader method

Target Slot

uname.

Method: uname :around (entry) ¶

Generic Function: (setf uname) (entry) ¶

Set the uname of ENTRY. VALUE must be a STRING.

Package

tar.

Source

entry.lisp.

Methods

Writer Method: (setf uname) ((entry entry)) ¶

automatically generated writer method

Target Slot

uname.

Method: (setf uname) :around (entry) ¶

Generic Reader: unsupported-property-value-name (condition) ¶

Package

tar.

Methods

Reader Method: unsupported-property-value-name ((condition unsupported-property-value)) ¶

Source

conditions.lisp.

Target Slot

name.

Generic Reader: unsupported-property-value-value (condition) ¶

Package

tar.

Methods

Reader Method: unsupported-property-value-value ((condition unsupported-property-value)) ¶

Source

conditions.lisp.

Target Slot

value.

Generic Function: write-entry (archive entry) ¶

Write ENTRY to ARCHIVE.

Package

tar.

Source

archive.lisp.

Methods

Method: write-entry ((archive archive) entry) ¶

---

5.1.4 Conditions

Condition: property-value-too-long ¶

Signaled when trying to WRITE-ENTRY with a property that is too long for the underlying archive type.

Package

tar.

Source

conditions.lisp.

Direct superclasses

unsupported-property-value.

Condition: required-property-missing ¶

Signaled when trying to WRITE-ENTRY with a required property that is missing.

Package

tar.

Source

conditions.lisp.

Direct superclasses

tar-error.

Direct methods

required-property-missing-name.

Direct slots

Slot: name ¶

The name of the missing property.

Initargs

:name

Readers

required-property-missing-name.

Writers

This slot is read-only.

Condition: tar-condition ¶

The base condition.

Package

tar.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses

tar-error.

Condition: tar-error ¶

The base error condition.

Package

tar.

Source

conditions.lisp.

Direct superclasses

• error.
• tar-condition.

Direct subclasses

• required-property-missing.
• unbound-property.
• unsupported-property.
• unsupported-property-value.

Condition: unsupported-property ¶

Signaled when a property is set or accessed that the underlying tar file cannot represent.

Package

tar.

Source

conditions.lisp.

Direct superclasses

tar-error.

Direct methods

unsupported-property-name.

Direct slots

Slot: name ¶

The name of the unsupported property.

Initargs

:name

Readers

unsupported-property-name.

Writers

This slot is read-only.

Condition: unsupported-property-value ¶

Signaled when trying to WRITE-ENTRY with a property that is unsupported by the underlying archive type.

Package

tar.

Source

conditions.lisp.

Direct superclasses

tar-error.

Direct subclasses

property-value-too-long.

Direct methods

• unsupported-property-value-name.
• unsupported-property-value-value.

Direct slots

Slot: name ¶

The name of the unsupported property.

Initargs

:name

Readers

unsupported-property-value-name.

Writers

This slot is read-only.

Slot: value ¶

The value of the unsupported property.

Initargs

:value

Readers

unsupported-property-value-value.

Writers

This slot is read-only.

---

5.1.5 Classes

Class: archive ¶

The base class of all archives.

Package

tar.

Source

archive.lisp.

Direct subclasses

• gnu-archive.
• ustar-archive.
• v7-archive.

Direct methods

• archive-direction.
• archive-file.
• archive-opened-stream.
• archive-supports-property-p.
• check-properties.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• close-archive.
• read-entry.
• write-entry.

Direct slots

Slot: opened-stream ¶

Initargs

:opened-stream

Readers

archive-opened-stream.

Writers

This slot is read-only.

Slot: file ¶

Initargs

:file

Readers

archive-file.

Writers

This slot is read-only.

Slot: direction ¶

Initargs

:direction

Readers

archive-direction.

Writers

This slot is read-only.

Class: block-device-entry ¶

An entry representing a block device.

Package

tar.

Source

entry.lisp.

Direct superclasses

device-entry.

Direct methods

%write-entry.

Class: character-device-entry ¶

An entry representing a character device.

Package

tar.

Source

entry.lisp.

Direct superclasses

device-entry.

Direct methods

%write-entry.

Class: directory-entry ¶

An entry representing a directory.

Package

tar.

Source

entry.lisp.

Direct superclasses

entry.

Direct methods

• %write-entry.
• %write-entry.
• entry-property-slot-names.
• (setf size).
• size.

Direct slots

Slot: size ¶

Type

integer

Initform

0

Initargs

:size

Readers

size.

Writers

(setf size).

Class: entry ¶

The base class of all entry types. Each ENTRY must contain a NAME, MODE, UID, GID, and MTIME. Other common properties are UNAME, GNAME, ATIME, and CTIME.

Package

tar.

Source

entry.lisp.

Direct subclasses

• device-entry.
• directory-entry.
• fifo-entry.
• file-entry.
• link-entry.
• unknown-entry.

Direct methods

• (setf archive).
• archive.
• (setf atime).
• atime.
• check-properties.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• (setf ctime).
• ctime.
• entry-property-slot-names.
• (setf gid).
• gid.
• (setf gname).
• gname.
• (setf mode).
• mode.
• (setf mtime).
• mtime.
• (setf name).
• name.
• (setf uid).
• uid.
• (setf uname).
• uname.

Direct slots

Slot: archive ¶

Initargs

:%archive

Readers

archive.

Writers

(setf archive).

Slot: name ¶

Type

string

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: mode ¶

Type

list

Initargs

:mode

Readers

mode.

Writers

(setf mode).

Slot: uid ¶

Type

(integer 0)

Initargs

:uid

Readers

uid.

Writers

(setf uid).

Slot: gid ¶

Type

(integer 0)

Initargs

:gid

Readers

gid.

Writers

(setf gid).

Slot: uname ¶

Type

(or string null)

Initargs

:uname

Readers

uname.

Writers

(setf uname).

Slot: gname ¶

Type

(or string null)

Initargs

:gname

Readers

gname.

Writers

(setf gname).

Slot: mtime ¶

Type

local-time:timestamp

Initargs

:mtime

Readers

mtime.

Writers

(setf mtime).

Slot: atime ¶

Type

(or local-time:timestamp null)

Initargs

:atime

Readers

atime.

Writers

(setf atime).

Slot: ctime ¶

Type

(or local-time:timestamp null)

Initargs

:ctime

Readers

ctime.

Writers

(setf ctime).

Class: fifo-entry ¶

An entry representing a FIFO.

Package

tar.

Source

entry.lisp.

Direct superclasses

entry.

Direct methods

%write-entry.

Class: file-entry ¶

An entry representing a regular file.

Package

tar.

Source

entry.lisp.

Direct superclasses

• entry.
• has-data-mixin.

Direct methods

• %write-entry.
• %write-entry.
• entry-property-slot-names.
• (setf size).
• size.

Direct slots

Slot: size ¶

Type

integer

Initargs

:size

Readers

size.

Writers

(setf size).

Class: gnu-archive ¶

An archive that uses GNU specific extensions.

Package

tar.

Source

gnu-archive.lisp.

Direct superclasses

archive.

Direct methods

• archive-supports-property-p.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.

Class: hard-link-entry ¶

An entry representing a hard link.

Package

tar.

Source

entry.lisp.

Direct superclasses

link-entry.

Direct methods

• %write-entry.
• %write-entry.

Class: pax-archive ¶

An archive as specified by POSIX. Uses multiple physical entries to represent a single logical entry when values do not fit into the standard USTAR-ARCHIVE header.

Package

tar.

Source

pax-archive.lisp.

Direct superclasses

ustar-archive.

Direct methods

• %write-entry.
• archive-default-attributes.
• archive-supports-negative-time-p.
• archive-supports-property-p.
• archive-supports-sub-seconds-p.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• check-property-for-writing.
• convert-from-physical-entry.
• convert-from-physical-entry.

Direct slots

Slot: default-attributes ¶

Readers

archive-default-attributes.

Writers

This slot is read-only.

Class: symbolic-link-entry ¶

An entry representing a symbolic link.

Package

tar.

Source

entry.lisp.

Direct superclasses

link-entry.

Direct methods

• %write-entry.
• %write-entry.

Class: ustar-archive ¶

A ustar archive that adds more fields to the header when compared to V7-ARCHIVEs.

Package

tar.

Source

ustar-archive.lisp.

Direct superclasses

archive.

Direct subclasses

pax-archive.

Direct methods

• %write-entry.
• %write-entry.
• %write-entry.
• %write-entry.
• %write-entry.
• %write-entry.
• %write-entry.
• archive-supports-negative-time-p.
• archive-supports-property-p.
• archive-supports-sub-seconds-p.
• check-property-for-writing.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• integer-max-value.
• integer-max-value.
• integer-max-value.
• integer-max-value.
• integer-max-value.
• string-max-length.
• string-max-length.
• string-max-length.
• string-max-length.

Class: v7-archive ¶

A very early archive format.

Package

tar.

Source

v7-archive.lisp.

Direct superclasses

archive.

Direct methods

• %write-entry.
• %write-entry.
• %write-entry.
• %write-entry.
• archive-supports-negative-time-p.
• archive-supports-sub-seconds-p.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• convert-from-physical-entry.
• integer-max-value.
• integer-max-value.
• integer-max-value.
• string-max-length.
• string-max-length.

---

5.1.6 Types

Type: mode-list () ¶

A list consisting of a subset of:
(:SET-USER-ID :SET-GROUP-ID :STICKY :USER-READ :USER-WRITE :USER-EXEC :GROUP-READ :GROUP-WRITE :GROUP-EXEC :OTHER-READ :OTHER-WRITE :OTHER-EXEC)

Package

tar.

Source

entry.lisp.

---

5.2.1 Constants

Constant: +mode-permissions+ ¶

Package

tar.

Source

utils.lisp.

---

5.2.2 Macros

Macro: define-entry-property (name type) ¶

Package

tar.

Source

entry.lisp.

Macro: define-optional-entry-property (name type) ¶

Package

tar.

Source

entry.lisp.

---

5.2.3 Ordinary functions

Function: call-with-ignored-unsupported-properties (thunk &optional value) ¶

Package

tar.

Source

conditions.lisp.

Function: call-with-open-archive (thunk stream-or-path &rest args &key type direction if-exists if-does-not-exist blocking-factor header-encoding compression) ¶

Package

tar.

Source

archive.lisp.

Function: call-with-truncated-unsupported-values (thunk properties) ¶

Package

tar.

Source

conditions.lisp.

Function: check-integer-max-value (entry name max-value) ¶

Package

tar.

Source

validation.lisp.

Function: check-required-property (entry name type) ¶

Package

tar.

Source

validation.lisp.

Function: check-string-length (entry name max-length) ¶

Package

tar.

Source

validation.lisp.

Function: check-timestamp (archive entry name) ¶

Package

tar.

Source

validation.lisp.

Function: maybe-truncate (string length) ¶

Package

tar.

Source

utils.lisp.

Function: mode-to-permissions (mode) ¶

Package

tar.

Source

utils.lisp.

Function: permissions-list-p (list) ¶

Package

tar.

Source

entry.lisp.

Function: permissions-to-mode (permissions) ¶

Package

tar.

Source

utils.lisp.

Function: split-name (name) ¶

Package

tar.

Source

ustar-archive.lisp.

Function: string-to-timestamp (string) ¶

Package

tar.

Source

utils.lisp.

Function: tar-file-entry-with-prefix-name (entry) ¶

Package

tar.

Source

utils.lisp.

Function: timestamp-to-string (timestamp) ¶

Package

tar.

Source

utils.lisp.

---

5.2.4 Generic functions

Generic Function: %write-entry (archive entry &rest overrides) ¶

Package

tar.

Source

archive.lisp.

Methods

Method: %write-entry ((archive v7-archive) (entry hard-link-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: %write-entry ((archive v7-archive) (entry symbolic-link-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: %write-entry ((archive v7-archive) (entry directory-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: %write-entry ((archive v7-archive) (entry file-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry character-device-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry block-device-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry fifo-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry hard-link-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry symbolic-link-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry directory-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive ustar-archive) (entry file-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: %write-entry ((archive pax-archive) entry &rest overrides) ¶

Source

pax-archive.lisp.

Generic Reader: archive-default-attributes (object) ¶

Package

tar.

Methods

Reader Method: archive-default-attributes ((pax-archive pax-archive)) ¶

automatically generated reader method

Source

pax-archive.lisp.

Target Slot

default-attributes.

Generic Reader: archive-direction (object) ¶

Package

tar.

Methods

Reader Method: archive-direction ((archive archive)) ¶

automatically generated reader method

Source

archive.lisp.

Target Slot

direction.

Generic Reader: archive-file (object) ¶

Package

tar.

Methods

Reader Method: archive-file ((archive archive)) ¶

automatically generated reader method

Source

archive.lisp.

Target Slot

file.

Generic Reader: archive-opened-stream (object) ¶

Package

tar.

Methods

Reader Method: archive-opened-stream ((archive archive)) ¶

automatically generated reader method

Source

archive.lisp.

Target Slot

opened-stream.

Generic Function: archive-supports-negative-time-p (archive) ¶

Package

tar.

Source

validation.lisp.

Methods

Method: archive-supports-negative-time-p ((archive v7-archive)) ¶

Source

v7-archive.lisp.

Method: archive-supports-negative-time-p ((archive ustar-archive)) ¶

Source

ustar-archive.lisp.

Method: archive-supports-negative-time-p ((archive pax-archive)) ¶

Source

pax-archive.lisp.

Generic Function: archive-supports-property-p (archive property) ¶

Package

tar.

Source

archive.lisp.

Methods

Method: archive-supports-property-p ((archive ustar-archive) property) ¶

Source

ustar-archive.lisp.

Method: archive-supports-property-p ((archive pax-archive) property) ¶

Source

pax-archive.lisp.

Method: archive-supports-property-p ((archive gnu-archive) property) ¶

Source

gnu-archive.lisp.

Method: archive-supports-property-p ((archive archive) property) ¶

Generic Function: archive-supports-sub-seconds-p (archive) ¶

Package

tar.

Source

validation.lisp.

Methods

Method: archive-supports-sub-seconds-p ((archive v7-archive)) ¶

Source

v7-archive.lisp.

Method: archive-supports-sub-seconds-p ((archive ustar-archive)) ¶

Source

ustar-archive.lisp.

Method: archive-supports-sub-seconds-p ((archive pax-archive)) ¶

Source

pax-archive.lisp.

Generic Function: archive-type-to-tar-file-type (type) ¶

Package

tar.

Source

archive.lisp.

Methods

Method: archive-type-to-tar-file-type ((type (eql :auto))) ¶

Method: archive-type-to-tar-file-type ((type (eql tar:v7-archive))) ¶

Method: archive-type-to-tar-file-type ((type (eql :v7))) ¶

Method: archive-type-to-tar-file-type ((type (eql tar:ustar-archive))) ¶

Method: archive-type-to-tar-file-type ((type (eql :ustar))) ¶

Method: archive-type-to-tar-file-type ((type (eql tar:pax-archive))) ¶

Method: archive-type-to-tar-file-type ((type (eql :pax))) ¶

Method: archive-type-to-tar-file-type ((type (eql tar:gnu-archive))) ¶

Method: archive-type-to-tar-file-type ((type (eql :gnu))) ¶

Generic Function: check-properties (archive entry) ¶

Check that all properties defined in ENTRY are supported by ARCHIVE.

Package

tar.

Source

validation.lisp.

Methods

Method: check-properties ((archive archive) (entry entry)) ¶

Generic Function: check-property-for-writing (archive entry name) ¶

Package

tar.

Source

validation.lisp.

Methods

Method: check-property-for-writing ((archive ustar-archive) (entry entry) (name (eql tar:name))) ¶

Source

ustar-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:gname))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:uname))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry link-entry) (name (eql tar:linkname))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:size))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:gid))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:uid))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:mode))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive pax-archive) (entry entry) (name (eql tar:name))) ¶

Source

pax-archive.lisp.

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:ctime))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:atime))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:gname))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:uname))) ¶

Method: check-property-for-writing ((archive archive) (entry link-entry) (name (eql tar:linkname))) ¶

Method: check-property-for-writing ((archive archive) (entry device-entry) (name (eql tar:devminor))) ¶

Method: check-property-for-writing ((archive archive) (entry device-entry) (name (eql tar:devmajor))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:size))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:mtime))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:gid))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:uid))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:mode))) ¶

Method: check-property-for-writing ((archive archive) (entry entry) (name (eql tar:name))) ¶

Generic Function: convert-from-physical-entry (archive physical-entry &rest overrides) ¶

Package

tar.

Source

archive.lisp.

Methods

Method: convert-from-physical-entry ((archive v7-archive) (physical-entry hard-link-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: convert-from-physical-entry ((archive v7-archive) (physical-entry symbolic-link-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: convert-from-physical-entry ((archive v7-archive) (physical-entry directory-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: convert-from-physical-entry ((archive v7-archive) (physical-entry file-entry) &rest overrides) ¶

Source

v7-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry fifo-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry block-device-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry character-device-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry hard-link-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry symbolic-link-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry directory-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive ustar-archive) (physical-entry file-entry) &rest overrides) ¶

Source

ustar-archive.lisp.

Method: convert-from-physical-entry ((archive pax-archive) (physical-entry pax-extended-attributes-entry) &rest overrides) ¶

Source

pax-archive.lisp.

Method: convert-from-physical-entry ((archive pax-archive) (physical-entry pax-global-attributes-entry) &rest overrides) ¶

Source

pax-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry fifo-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry block-device-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry character-device-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry hard-link-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry symbolic-link-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry directory-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry file-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry gnu-long-link-name-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Method: convert-from-physical-entry ((archive gnu-archive) (physical-entry gnu-long-name-entry) &rest overrides) ¶

Source

gnu-archive.lisp.

Generic Reader: data (object) ¶

Package

tar.

Methods

Reader Method: data ((has-data-mixin has-data-mixin)) ¶

automatically generated reader method

Source

entry.lisp.

Target Slot

data.

Generic Function: entry-property-slot-names (entry) ¶

Package

tar.

Source

entry.lisp.

Method Combination

append.

Options

:most-specific-first

Methods

Method: entry-property-slot-names append ((entry unknown-entry)) ¶

Method: entry-property-slot-names append ((entry device-entry)) ¶

Method: entry-property-slot-names append ((entry link-entry)) ¶

Method: entry-property-slot-names append ((entry directory-entry)) ¶

Method: entry-property-slot-names append ((entry file-entry)) ¶

Method: entry-property-slot-names append ((entry entry)) ¶

Generic Function: integer-max-value (archive name) ¶

Package

tar.

Source

validation.lisp.

Methods

Method: integer-max-value ((archive v7-archive) (name (eql tar:gid))) ¶

Source

v7-archive.lisp.

Method: integer-max-value ((archive v7-archive) (name (eql tar:uid))) ¶

Source

v7-archive.lisp.

Method: integer-max-value ((archive v7-archive) (name (eql tar:size))) ¶

Source

v7-archive.lisp.

Method: integer-max-value ((archive ustar-archive) (name (eql tar:devminor))) ¶

Source

ustar-archive.lisp.

Method: integer-max-value ((archive ustar-archive) (name (eql tar:devmajor))) ¶

Source

ustar-archive.lisp.

Method: integer-max-value ((archive ustar-archive) (name (eql tar:gid))) ¶

Source

ustar-archive.lisp.

Method: integer-max-value ((archive ustar-archive) (name (eql tar:uid))) ¶

Source

ustar-archive.lisp.

Method: integer-max-value ((archive ustar-archive) (name (eql tar:size))) ¶

Source

ustar-archive.lisp.

Generic Reader: physical-entry (object) ¶

Package

tar.

Methods

Reader Method: physical-entry ((has-data-mixin has-data-mixin)) ¶

automatically generated reader method

Source

entry.lisp.

Target Slot

physical-entry.

Generic Function: string-max-length (archive name) ¶

Package

tar.

Source

validation.lisp.

Methods

Method: string-max-length ((archive v7-archive) (name (eql tar:linkname))) ¶

Source

v7-archive.lisp.

Method: string-max-length ((archive v7-archive) (name (eql tar:name))) ¶

Source

v7-archive.lisp.

Method: string-max-length ((archive ustar-archive) (name (eql tar:linkname))) ¶

Source

ustar-archive.lisp.

Method: string-max-length ((archive ustar-archive) (name (eql tar:name))) ¶

Source

ustar-archive.lisp.

Method: string-max-length ((archive ustar-archive) (name (eql tar:gname))) ¶

Source

ustar-archive.lisp.

Method: string-max-length ((archive ustar-archive) (name (eql tar:uname))) ¶

Source

ustar-archive.lisp.

Generic Function: tar-file-to-archive-type (tar-file) ¶

Package

tar.

Source

archive.lisp.

Methods

Method: tar-file-to-archive-type ((tar-file v7-tar-file)) ¶

Method: tar-file-to-archive-type ((tar-file ustar-tar-file)) ¶

We don’t know if this will ever have PAX headers, so upgrade to PAX-ARCHIVE.

Method: tar-file-to-archive-type ((tar-file gnu-tar-file)) ¶

Generic Reader: unbound-property-name (condition) ¶

Package

tar.

Methods

Reader Method: unbound-property-name ((condition unbound-property)) ¶

Source

conditions.lisp.

Target Slot

name.

Generic Reader: unsupported-property-name (condition) ¶

Package

tar.

Methods

Reader Method: unsupported-property-name ((condition unsupported-property)) ¶

Source

conditions.lisp.

Target Slot

name.

---