The tar Reference Manual

1 Introduction
2 Systems
- 2.1 tar
3 Files
- 3.1 Lisp
4 Packages
- 4.1 tar
5 Definitions
- 5.1 Exported definitions
- 5.2 Internal definitions
Appendix A Indexes

The tar Reference Manual

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

1 Introduction

This project provides a high level interface for interacting with tar archives. It consists of several systems that provide different levels of functionality.

NOTE: In order to load tar/create on Windows you need a version of osicat with commits from this PR.

Quickstart

If you want to extract a tar archive, without caring about preserving all the metadata, run the following:

(asdf:load-system "tar/simple-extract")

(tar:with-open-archive (a "/path/to/file.tar")
  (tar-simple-extract:simple-extract-archive a :directory "/path/to/extraction/point/"))

If you want to extract a tar archive, attempting to preserve symbolic links and as much metadata as possible, evaluate the following:

(asdf:load-system "tar/extract")

(tar:with-open-archive (a "/path/to/file.tar")
  (tar-extract:extract-archive a :directory "/path/to/extraction/point/"))

If you want to create a tar archive, attempting to preserve symbolic links and as much metadata as possible, evaluate the following:

(asdf:load-system "tar/create")

(let ((*default-pathname-defaults* #p"/path/to/parent/"))
  (tar:with-open-archive (a "/path/to/file.tar" :direction :output)
    (tar-create:create-archive a '("directory/") :recursep t)))

Systems

tar

The tar system is a thin layer on top of the tar-file system. While tar-file is focused on reading and writing physical entries, tar places an emphasis on reading and writing logical entries.

The practical effect of this is that when using tar, any single object stored in a tar archive (regular file, symlink, etc.) is always represented as a single entry (tar:file-entry, tar:symbolic-link-entry, etc.). This is in contrast to tar-file where a regular file with a long name could be either unrepresentable, a single tar-file:file-entry with a ustar header, a tar-file:pax-extended-attributes-entry followed by a tar-file:file-entry, or a tar-file:gnu-long-name-entry followed by a tar-file:file-entry. tar takes care of generating and interpreting the correct sequence of physical entries, depending on the type of the archive being used.

While this system is useful for reading and writing tar archives, its primary purpose is for the inspection of archives and creating archives whose content does not come directly from the file system. For file system integration, see the remaining systems.

tar/simple-extract

The tar/simple-extract system provides functionality to extract a tar archive to your filesystem. Unfortunately, faithfully extracting tar files onto the filesystem is a complex task and is impossible to perform using only the functionality mandated by the Common Lisp specification.

Therefore, this system does not try to faithfully reproduce the contents of the tar file. This means that it should work on any CL implementation that tar and tar-file does, but the cost is there is information loss.

This system does not support extracting the following entry types:

Symbolic links. They can be skipped or dereferenced.
Hard links. They can be skipped or dereferenced.
Character devices. They can be skipped.
Block devices. They can be skipped.
FIFO. They can be skipped.

Additionally, metadata such as file owner, permissions, and modification time are not set.

It is recommended that this extraction method is used only to extract an archive to an empty folder. If that is done with default settings, the extraction process should be fairly safe and predictable. Otherwise, you run the risk of existing symlinks being followed and overwriting arbitrary files on your machine.

tar/extract

The tar/extract system attempts to provide full extraction functionality. As such, it is a much more complex beast and likely does not work on all implementation/OS combinations. Patches are always welcome to make it more portable.

This system does not support extracting the following entry types on Windows:

Symbolic links. They can be skipped or dereferenced.
Hard links. They can be skipped or dereferenced.
Character devices. They can be skipped.
Block devices. They can be skipped.
FIFO. They can be skipped.

While it is possible to create symbolic links on Windows, it requires special user permissions and many Windows applications are not designed with symlinks in mind. This makes it both very unlikely that an arbitrary user can create symlinks and very likely that the creation of symlinks would pose a risk to other applications running on the same machine. Hard link support is also possible, but I've rarely seen it and need to do more research before attempting to support it.

While there is much less information loss when extracting an archive using this system, that comes at the cost of increased security concerns when given an untrusted archive as input. For example, a typical attack vector is to write a symlink that points to an arbitrary file on your system and then using that symlink to modify the target.

The goal of this system is to provide default extraction options so that it is safe to extract an untrusted archive into an empty directory and have no way for the extraction process to modify any file that exists outside of that directory. Bug reports and patches are always welcome if you find this goal is not met.

The safety goal is paramount, and as such, the performance of this system is likely not the best. A primary reason is that we want to be robust to the different file systems that are out there (e.g., case insensitive or unicode normalizing), so we (currently) do not rely on caches to determine if a path is safe to write to. The result is that there are many syscalls that happen during extraction. There are probably ways this can be improved and patches are always welcome.

tar/create

The tar/create system produces a tar file from your file system that faithfully reproduces all the metadata. It is a fairly complex beast and might not work on all implementation/OS combinations. Patches are always welcome to make it more portable.

See the docstring for tar-create:create-archive to understand its options.

FAQ

Can I create/extract compressed tar files?

Yes! It supports transparent gzip comporession. On input streams, the first few bytes are examined for magic bytes. On output streams, the pathname is used as a hint. You can override this behavior using the :compression argument to with-open-archive or open-archive.

2 Systems

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

2.1 `tar`

Author

Eric Timmons <eric@timmons.dev>

License

MIT

Description

A high level interface for tar archives

Version

0.2.3

Dependencies

alexandria
babel
local-time
split-sequence
tar-file (at least version 0.2.0)
uiop
40ants-doc

Source

tar.asd (file)

Components

archive.lisp (file)
conditions.lisp (file)
entry.lisp (file)
gnu-archive.lisp (file)
package.lisp (file)
pax-archive.lisp (file)
ustar-archive.lisp (file)
utils.lisp (file)
v7-archive.lisp (file)
validation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `tar.asd`

Location: /home/quickref/quicklisp/dists/quicklisp/software/cl-tar-20220220-git/tar.asd
Systems: tar (system)

3.1.2 `tar/archive.lisp`

Dependency

package.lisp (file)

Parent

tar (system)

Location

archive.lisp

Exported Definitions

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

Internal Definitions

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

3.1.3 `tar/conditions.lisp`

Dependency

package.lisp (file)

Parent

tar (system)

Location

conditions.lisp

Exported Definitions

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

Internal Definitions

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

3.1.4 `tar/entry.lisp`

Dependencies

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

Parent

tar (system)

Location

entry.lisp

Exported Definitions

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

Internal Definitions

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

3.1.5 `tar/gnu-archive.lisp`

Dependencies

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

Parent

tar (system)

Location

gnu-archive.lisp

Exported Definitions

gnu-archive (class)

Internal Definitions

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`

Parent: tar (system)
Location: package.lisp
Packages: tar

3.1.7 `tar/pax-archive.lisp`

Dependencies

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

Parent

tar (system)

Location

pax-archive.lisp

Exported Definitions

pax-archive (class)

Internal Definitions

%write-entry (method)
archive-default-attributes (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)

Parent

tar (system)

Location

ustar-archive.lisp

Exported Definitions

ustar-archive (class)

Internal Definitions

%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)

Parent

tar (system)

Location

utils.lisp

Internal Definitions

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

Parent

tar (system)

Location

v7-archive.lisp

Exported Definitions

v7-archive (class)

Internal Definitions

%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)

Parent

tar (system)

Location

validation.lisp

Internal Definitions

archive-supports-negative-time-p (generic function)
archive-supports-sub-seconds-p (generic function)
check-integer-max-value (function)
check-properties (generic function)
check-properties (method)
check-property-for-writing (generic function)
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)
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-required-property (function)
check-string-length (function)
check-timestamp (function)
integer-max-value (generic function)
string-max-length (generic function)

4 Packages

Packages are listed by definition order.

4.1 `tar`

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

archive (generic function)
archive (method)
(setf archive) (method)
(setf archive) (generic function)
archive (class)
atime (generic function)
atime (method)
(setf atime) (method)
atime (method)
(setf atime) (method)
(setf atime) (generic function)
block-device-entry (class)
character-device-entry (class)
close-archive (generic function)
close-archive (method)
ctime (generic function)
ctime (method)
(setf ctime) (method)
ctime (method)
(setf ctime) (method)
(setf ctime) (generic function)
devmajor (generic function)
devmajor (method)
(setf devmajor) (method)
(setf devmajor) (generic function)
devminor (generic function)
devminor (method)
(setf devminor) (method)
(setf devminor) (generic function)
directory-entry (class)
do-entries (macro)
entry (class)
fifo-entry (class)
file-entry (class)
gid (generic function)
gid (method)
(setf gid) (method)
(setf gid) (generic function)
gname (generic function)
gname (method)
(setf gname) (method)
gname (method)
(setf gname) (method)
(setf gname) (generic function)
gnu-archive (class)
hard-link-entry (class)
ignore-unsupported-property (function)
linkname (generic function)
linkname (method)
(setf linkname) (method)
(setf linkname) (generic function)
make-entry-stream (generic function)
make-entry-stream (method)
mode (generic function)
mode (method)
(setf mode) (method)
(setf mode) (generic function)
mode-list (type)
mtime (generic function)
mtime (method)
(setf mtime) (method)
(setf mtime) (generic function)
name (generic function)
name (method)
(setf name) (method)
(setf name) (generic function)
open-archive (function)
pax-archive (class)
property-value-too-long (condition)
read-entry (generic function)
read-entry (method)
required-property-missing (condition)
required-property-missing-name (generic function)
required-property-missing-name (method)
size (generic function)
size (method)
(setf size) (method)
size (method)
(setf size) (method)
size (method)
(setf size) (method)
(setf size) (generic function)
symbolic-link-entry (class)
tar-condition (condition)
tar-error (condition)
truncate-value (function)
uid (generic function)
uid (method)
(setf uid) (method)
(setf uid) (generic function)
uname (generic function)
uname (method)
(setf uname) (method)
uname (method)
(setf uname) (method)
(setf uname) (generic function)
unsupported-property (condition)
unsupported-property-value (condition)
unsupported-property-value-name (generic function)
unsupported-property-value-name (method)
unsupported-property-value-value (generic function)
unsupported-property-value-value (method)
ustar-archive (class)
v7-archive (class)
with-ignored-unsupported-properties (macro)
with-open-archive (macro)
with-truncated-unsupported-values (macro)
write-entry (generic function)
write-entry (method)

Internal Definitions

%write-entry (generic function)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
%write-entry (method)
+mode-permissions+ (constant)
archive-default-attributes (generic function)
archive-default-attributes (method)
archive-direction (generic function)
archive-direction (method)
archive-file (generic function)
archive-file (method)
archive-opened-stream (generic function)
archive-opened-stream (method)
archive-supports-negative-time-p (generic function)
archive-supports-negative-time-p (method)
archive-supports-negative-time-p (method)
archive-supports-negative-time-p (method)
archive-supports-property-p (generic function)
archive-supports-property-p (method)
archive-supports-property-p (method)
archive-supports-property-p (method)
archive-supports-property-p (method)
archive-supports-sub-seconds-p (generic function)
archive-supports-sub-seconds-p (method)
archive-supports-sub-seconds-p (method)
archive-supports-sub-seconds-p (method)
archive-type-to-tar-file-type (generic function)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
archive-type-to-tar-file-type (method)
call-with-ignored-unsupported-properties (function)
call-with-open-archive (function)
call-with-truncated-unsupported-values (function)
check-integer-max-value (function)
check-properties (generic function)
check-properties (method)
check-property-for-writing (generic function)
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)
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)
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-required-property (function)
check-string-length (function)
check-timestamp (function)
convert-from-physical-entry (generic function)
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)
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)
convert-from-physical-entry (method)
convert-from-physical-entry (method)
convert-from-physical-entry (method)
convert-from-physical-entry (method)
data (generic function)
data (method)
define-entry-property (macro)
define-optional-entry-property (macro)
device-entry (class)
entry-property-slot-names (generic function)
entry-property-slot-names (method)
entry-property-slot-names (method)
entry-property-slot-names (method)
entry-property-slot-names (method)
entry-property-slot-names (method)
entry-property-slot-names (method)
has-data-mixin (class)
integer-max-value (generic function)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
integer-max-value (method)
link-entry (class)
maybe-truncate (function)
mode-to-permissions (function)
permissions-list-p (function)
permissions-to-mode (function)
physical-entry (generic function)
physical-entry (method)
split-name (function)
string-max-length (generic function)
string-max-length (method)
string-max-length (method)
string-max-length (method)
string-max-length (method)
string-max-length (method)
string-max-length (method)
string-to-timestamp (function)
tar-file-entry-with-prefix-name (function)
tar-file-to-archive-type (generic function)
tar-file-to-archive-type (method)
tar-file-to-archive-type (method)
tar-file-to-archive-type (method)
timestamp-to-string (function)
unbound-property (condition)
unbound-property-name (generic function)
unbound-property-name (method)
unknown-entry (class)
unsupported-property-name (generic function)
unsupported-property-name (method)

5 Definitions

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

5.1 Exported definitions

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 (file)

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 (file)

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 (file)

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 (file)

5.1.2 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 (file)

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 (file)

Function: truncate-value &optional CONDITION

Truncate the value and write it to the archive.

Package: tar
Source: conditions.lisp (file)

5.1.3 Generic functions

Generic Function: archive OBJECT

Generic Function: (setf archive) NEW-VALUE OBJECT

Package

• Introduction		What tar is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The tar.asd file
• The tar/archive.lisp file
• The tar/conditions.lisp file
• The tar/entry.lisp file
• The tar/gnu-archive.lisp file
• The tar/package.lisp file
• The tar/pax-archive.lisp file
• The tar/ustar-archive.lisp file
• The tar/utils.lisp file
• The tar/v7-archive.lisp file
• The tar/validation.lisp file

• Exported macros
• Exported functions
• Exported generic functions
• Exported conditions
• Exported classes
• Exported types

• Internal constants
• Internal macros
• Internal functions
• Internal generic functions
• Internal conditions
• Internal classes

• Concept index
• Function index
• Variable index
• Data type index

	Index Entry	Section

F
	File, Lisp, `tar.asd`:	The tar․asd file
	File, Lisp, `tar/archive.lisp`:	The tar/archive․lisp file
	File, Lisp, `tar/conditions.lisp`:	The tar/conditions․lisp file
	File, Lisp, `tar/entry.lisp`:	The tar/entry․lisp file
	File, Lisp, `tar/gnu-archive.lisp`:	The tar/gnu-archive․lisp file
	File, Lisp, `tar/package.lisp`:	The tar/package․lisp file
	File, Lisp, `tar/pax-archive.lisp`:	The tar/pax-archive․lisp file
	File, Lisp, `tar/ustar-archive.lisp`:	The tar/ustar-archive․lisp file
	File, Lisp, `tar/utils.lisp`:	The tar/utils․lisp file
	File, Lisp, `tar/v7-archive.lisp`:	The tar/v7-archive․lisp file
	File, Lisp, `tar/validation.lisp`:	The tar/validation․lisp file

L
	Lisp File, `tar.asd`:	The tar․asd file
	Lisp File, `tar/archive.lisp`:	The tar/archive․lisp file
	Lisp File, `tar/conditions.lisp`:	The tar/conditions․lisp file
	Lisp File, `tar/entry.lisp`:	The tar/entry․lisp file
	Lisp File, `tar/gnu-archive.lisp`:	The tar/gnu-archive․lisp file
	Lisp File, `tar/package.lisp`:	The tar/package․lisp file
	Lisp File, `tar/pax-archive.lisp`:	The tar/pax-archive․lisp file
	Lisp File, `tar/ustar-archive.lisp`:	The tar/ustar-archive․lisp file
	Lisp File, `tar/utils.lisp`:	The tar/utils․lisp file
	Lisp File, `tar/v7-archive.lisp`:	The tar/v7-archive․lisp file
	Lisp File, `tar/validation.lisp`:	The tar/validation․lisp file

T
	`tar.asd`:	The tar․asd file
	`tar/archive.lisp`:	The tar/archive․lisp file
	`tar/conditions.lisp`:	The tar/conditions․lisp file
	`tar/entry.lisp`:	The tar/entry․lisp file
	`tar/gnu-archive.lisp`:	The tar/gnu-archive․lisp file
	`tar/package.lisp`:	The tar/package․lisp file
	`tar/pax-archive.lisp`:	The tar/pax-archive․lisp file
	`tar/ustar-archive.lisp`:	The tar/ustar-archive․lisp file
	`tar/utils.lisp`:	The tar/utils․lisp file
	`tar/v7-archive.lisp`:	The tar/v7-archive․lisp file
	`tar/validation.lisp`:	The tar/validation․lisp file

	Index Entry	Section

+
	`+mode-permissions+`:	Internal constants

A
	`archive`:	Exported classes
	`atime`:	Exported classes

C
	`Constant, +mode-permissions+`:	Internal constants
	`ctime`:	Exported classes

D
	`data`:	Internal classes
	`default-attributes`:	Exported classes
	`devmajor`:	Internal classes
	`devminor`:	Internal classes
	`direction`:	Exported classes

F
	`file`:	Exported classes

G
	`gid`:	Exported classes
	`gname`:	Exported classes

L
	`linkname`:	Internal classes

M
	`mode`:	Exported classes
	`mtime`:	Exported classes

N
	`name`:	Exported conditions
	`name`:	Exported conditions
	`name`:	Exported conditions
	`name`:	Exported classes
	`name`:	Internal conditions

O
	`opened-stream`:	Exported classes

P
	`physical-entry`:	Internal classes

S
	`size`:	Exported classes
	`size`:	Exported classes
	`size`:	Internal classes
	`Slot, archive`:	Exported classes
	`Slot, atime`:	Exported classes
	`Slot, ctime`:	Exported classes
	`Slot, data`:	Internal classes
	`Slot, default-attributes`:	Exported classes
	`Slot, devmajor`:	Internal classes
	`Slot, devminor`:	Internal classes
	`Slot, direction`:	Exported classes
	`Slot, file`:	Exported classes
	`Slot, gid`:	Exported classes
	`Slot, gname`:	Exported classes
	`Slot, linkname`:	Internal classes
	`Slot, mode`:	Exported classes
	`Slot, mtime`:	Exported classes
	`Slot, name`:	Exported conditions
	`Slot, name`:	Exported conditions
	`Slot, name`:	Exported conditions
	`Slot, name`:	Exported classes
	`Slot, name`:	Internal conditions
	`Slot, opened-stream`:	Exported classes
	`Slot, physical-entry`:	Internal classes
	`Slot, size`:	Exported classes
	`Slot, size`:	Exported classes
	`Slot, size`:	Internal classes
	`Slot, uid`:	Exported classes
	`Slot, uname`:	Exported classes
	`Slot, value`:	Exported conditions

U
	`uid`:	Exported classes
	`uname`:	Exported classes

V
	`value`:	Exported conditions

The tar Reference Manual

Table of Contents

The tar Reference Manual

1 Introduction

Quickstart

Systems

tar

tar/simple-extract

tar/extract

tar/create

FAQ

Can I create/extract compressed tar files?

2 Systems

2.1 tar

3 Files

3.1 Lisp

3.1.1 tar.asd

3.1.2 tar/archive.lisp

3.1.3 tar/conditions.lisp

3.1.4 tar/entry.lisp

3.1.5 tar/gnu-archive.lisp

3.1.6 tar/package.lisp

3.1.7 tar/pax-archive.lisp

3.1.8 tar/ustar-archive.lisp

3.1.9 tar/utils.lisp

3.1.10 tar/v7-archive.lisp

3.1.11 tar/validation.lisp

4 Packages

4.1 tar

5 Definitions

5.1 Exported definitions

5.1.1 Macros

5.1.2 Functions

5.1.3 Generic functions

5.1.4 Conditions

5.1.5 Classes

5.1.6 Types

5.2 Internal definitions

5.2.1 Constants

5.2.2 Macros

5.2.3 Functions

5.2.4 Generic functions

5.2.5 Conditions

5.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `tar`

3.1.1 `tar.asd`

3.1.2 `tar/archive.lisp`

3.1.3 `tar/conditions.lisp`

3.1.4 `tar/entry.lisp`

3.1.5 `tar/gnu-archive.lisp`

3.1.6 `tar/package.lisp`

3.1.7 `tar/pax-archive.lisp`

3.1.8 `tar/ustar-archive.lisp`

3.1.9 `tar/utils.lisp`

3.1.10 `tar/v7-archive.lisp`

3.1.11 `tar/validation.lisp`

4.1 `tar`