The trivial-compress Reference Manual

Next: , Previous: , 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 Mon Aug 15 06:02:42 2022 GMT+0.

Table of Contents


1 Introduction

trivial-compress

Build Status

Compress a directory.

Usage

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

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

License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.


2 Systems

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


Previous: , 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

Copyright (c) 2016 Fernando Borretti

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


3 Modules

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


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

3.1 trivial-compress/src

Source

trivial-compress.asd.

Parent Component

trivial-compress (system).

Child Components

4 Files

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


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

4.1 Lisp


Next: , Previous: , 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.


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


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

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

5 Packages

Packages are listed by definition order.


5.1 trivial-compress

The main compress interface.

Source

trivial-compress.lisp.

Use List

common-lisp.

Public Interface
  • tar (function).
  • zip (function).

5.2 trivial-compress.native

Compress using native utilities.

Source

native.lisp.

Use List

common-lisp.

Public Interface
  • tar (function).
  • zip (function).

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


6 Definitions

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


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

6.1 Public Interface


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.


6.2 Internals


Previous: , 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.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables