Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The trivial-compress Reference Manual

This is the trivial-compress Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:49:23 2023 GMT+0.

Next: Systems, Previous: The trivial-compress Reference Manual, Up: The trivial-compress Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The trivial-compress Reference Manual [Contents][Index]

2 Systems

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

trivial-compress

Previous: Systems, Up: Systems [Contents][Index]

2.1 `trivial-compress`

Compress a directory.

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/ceramic/trivial-compress

Source Control

(GIT git@github.com:ceramic/trivial-compress.git)

Bug Tracker

https://github.com/ceramic/trivial-compress/issues

License

MIT

Long Description

# trivial-compress

[![Build Status](https://travis-ci.org/ceramic/trivial-compress.svg?branch=master)](https://travis-ci.org/ceramic/trivial-compress)

Compress a directory.

# Usage

~~~lisp
(trivial-compress:tar #p"/my/files/" #p"/files.tar")

(trivial-compress:zip #p"/my/files/" #p"/files.zip")
~~~

# License

Licensed under the MIT License.

Version

0.1

Dependencies

archive (system).
zip (system).
which (system).
uiop (system).
alexandria (system).

Source

trivial-compress.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The trivial-compress Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

trivial-compress/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `trivial-compress/src`

Source

trivial-compress.asd.

Parent Component

trivial-compress (system).

Child Components

cl.lisp (file).
native.lisp (file).
trivial-compress.lisp (file).

Next: Packages, Previous: Modules, Up: The trivial-compress Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

4.1 Lisp

trivial-compress/trivial-compress.asd
trivial-compress/src/cl.lisp
trivial-compress/src/native.lisp
trivial-compress/src/trivial-compress.lisp

Next: trivial-compress/src/cl.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `trivial-compress/trivial-compress.asd`

Source: trivial-compress.asd.
Parent Component: trivial-compress (system).
ASDF Systems: trivial-compress.

Next: trivial-compress/src/native.lisp, Previous: trivial-compress/trivial-compress.asd, Up: Lisp [Contents][Index]

4.1.2 `trivial-compress/src/cl.lisp`

Source

trivial-compress.asd.

Parent Component

src (module).

Packages

trivial-compress.cl.

Public Interface

tar (function).
zip (function).

Internals

subtract-pathname (function).

Next: trivial-compress/src/trivial-compress.lisp, Previous: trivial-compress/src/cl.lisp, Up: Lisp [Contents][Index]

4.1.3 `trivial-compress/src/native.lisp`

Dependency

cl.lisp (file).

Source

trivial-compress.asd.

Parent Component

src (module).

Packages

trivial-compress.native.

Public Interface

tar (function).
zip (function).

Previous: trivial-compress/src/native.lisp, Up: Lisp [Contents][Index]

4.1.4 `trivial-compress/src/trivial-compress.lisp`

Dependency

native.lisp (file).

Source

trivial-compress.asd.

Parent Component

src (module).

Packages

trivial-compress.

Public Interface

tar (function).
zip (function).

Next: Definitions, Previous: Files, Up: The trivial-compress Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

trivial-compress
trivial-compress.native
trivial-compress.cl

Next: trivial-compress.native, Previous: Packages, Up: Packages [Contents][Index]

5.1 `trivial-compress`

The main compress interface.

Source

trivial-compress.lisp.

Use List

common-lisp.

Public Interface

tar (function).
zip (function).

Next: trivial-compress.cl, Previous: trivial-compress, Up: Packages [Contents][Index]

5.2 `trivial-compress.native`

Compress using native utilities.

Source

native.lisp.

Use List

common-lisp.

Public Interface

tar (function).
zip (function).

Previous: trivial-compress.native, Up: Packages [Contents][Index]

5.3 `trivial-compress.cl`

Compress using pure Common Lisp.

Source

cl.lisp.

Use List

common-lisp.

Public Interface

tar (function).
zip (function).

Internals

subtract-pathname (function).

Next: Indexes, Previous: Packages, Up: The trivial-compress Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: tar (directory archive) ¶

Create a tar archive from the contents of a directory.

Package: trivial-compress.
Source: trivial-compress.lisp.

Function: tar (binary directory archive) ¶

Create a tar archive from the contents of a directory.

Package: trivial-compress.native.
Source: native.lisp.

Function: tar (directory archive) ¶

Create a tar archive from the contents of a directory.

Package: trivial-compress.cl.
Source: cl.lisp.

Function: zip (directory archive) ¶

Create a zip archive from the contents of a directory.

Package: trivial-compress.
Source: trivial-compress.lisp.

Function: zip (binary directory archive) ¶

Create a zip archive from the contents of a directory.

Package: trivial-compress.native.
Source: native.lisp.

Function: zip (directory archive) ¶

Create a zip archive from the contents of a directory.

Package: trivial-compress.cl.
Source: cl.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: subtract-pathname (root pathname) ¶

root is an absolute directory, and pathname is an absolute pathname, such that pathname is inside of root. Remove the common directory components, leaving a relative pathname.

Package: trivial-compress.cl.
Source: cl.lisp.

Previous: Definitions, Up: The trivial-compress Reference Manual [Contents][Index]

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	F S T Z

	Index Entry	Section

F
	`Function, subtract-pathname`:	Private ordinary functions
	`Function, tar`:	Public ordinary functions
	`Function, tar`:	Public ordinary functions
	`Function, tar`:	Public ordinary functions
	`Function, zip`:	Public ordinary functions
	`Function, zip`:	Public ordinary functions
	`Function, zip`:	Public ordinary functions

S
	`subtract-pathname`:	Private ordinary functions

T
	`tar`:	Public ordinary functions
	`tar`:	Public ordinary functions
	`tar`:	Public ordinary functions

Z
	`zip`:	Public ordinary functions
	`zip`:	Public ordinary functions
	`zip`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F M N P S T

	Index Entry	Section

C
	`cl.lisp`:	The trivial-compress/src/cl․lisp file

F
	`File, cl.lisp`:	The trivial-compress/src/cl․lisp file
	`File, native.lisp`:	The trivial-compress/src/native․lisp file
	`File, trivial-compress.asd`:	The trivial-compress/trivial-compress․asd file
	`File, trivial-compress.lisp`:	The trivial-compress/src/trivial-compress․lisp file

M
	`Module, src`:	The trivial-compress/src module

N
	`native.lisp`:	The trivial-compress/src/native․lisp file

P
	`Package, trivial-compress`:	The trivial-compress package
	`Package, trivial-compress.cl`:	The trivial-compress․cl package
	`Package, trivial-compress.native`:	The trivial-compress․native package

S
	`src`:	The trivial-compress/src module
	`System, trivial-compress`:	The trivial-compress system

T
	`trivial-compress`:	The trivial-compress system
	`trivial-compress`:	The trivial-compress package
	`trivial-compress.asd`:	The trivial-compress/trivial-compress․asd file
	`trivial-compress.cl`:	The trivial-compress․cl package
	`trivial-compress.lisp`:	The trivial-compress/src/trivial-compress․lisp file
	`trivial-compress.native`:	The trivial-compress․native package

The trivial-compress Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 trivial-compress

3 Modules

3.1 trivial-compress/src

4 Files

4.1 Lisp

4.1.1 trivial-compress/trivial-compress.asd

4.1.2 trivial-compress/src/cl.lisp

4.1.3 trivial-compress/src/native.lisp

4.1.4 trivial-compress/src/trivial-compress.lisp

5 Packages

5.1 trivial-compress

5.2 trivial-compress.native

5.3 trivial-compress.cl

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `trivial-compress`

3.1 `trivial-compress/src`

4.1.1 `trivial-compress/trivial-compress.asd`

4.1.2 `trivial-compress/src/cl.lisp`

4.1.3 `trivial-compress/src/native.lisp`

4.1.4 `trivial-compress/src/trivial-compress.lisp`

5.1 `trivial-compress`

5.2 `trivial-compress.native`

5.3 `trivial-compress.cl`