The trivial-compress Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 12:41:13 2018 GMT+0.


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

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.


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

2 Systems

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


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

2.1 trivial-compress

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

Description

Compress a directory.

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
Source

trivial-compress.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 trivial-compress/src

Parent

trivial-compress (system)

Location

src/

Components

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

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 files   [Contents][Index]

4.1.1 trivial-compress.asd

Location

trivial-compress.asd

Systems

trivial-compress (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 trivial-compress/src/cl.lisp

Parent

src (module)

Location

src/cl.lisp

Packages

trivial-compress.cl

Exported Definitions
Internal Definitions

subtract-pathname (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 trivial-compress/src/native.lisp

Dependency

cl.lisp (file)

Parent

src (module)

Location

src/native.lisp

Packages

trivial-compress.native

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

native.lisp (file)

Parent

src (module)

Location

src/trivial-compress.lisp

Packages

trivial-compress

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 trivial-compress.cl

Compress using pure Common Lisp.

Source

cl.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

subtract-pathname (function)


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

5.2 trivial-compress.native

Compress using native utilities.

Source

native.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.3 trivial-compress

The main compress interface.

Source

trivial-compress.lisp (file)

Use List

common-lisp

Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: tar DIRECTORY ARCHIVE

Create a tar archive from the contents of a directory.

Package

trivial-compress.cl

Source

cl.lisp (file)

Function: tar BINARY DIRECTORY ARCHIVE

Create a tar archive from the contents of a directory.

Package

trivial-compress.native

Source

native.lisp (file)

Function: tar DIRECTORY ARCHIVE

Create a tar archive from the contents of a directory.

Package

trivial-compress

Source

trivial-compress.lisp (file)

Function: zip DIRECTORY ARCHIVE

Create a zip archive from the contents of a directory.

Package

trivial-compress.cl

Source

cl.lisp (file)

Function: zip BINARY DIRECTORY ARCHIVE

Create a zip archive from the contents of a directory.

Package

trivial-compress.native

Source

native.lisp (file)

Function: zip DIRECTORY ARCHIVE

Create a zip archive from the contents of a directory.

Package

trivial-compress

Source

trivial-compress.lisp (file)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

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


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, trivial-compress.asd: The trivial-compress<dot>asd file
File, Lisp, trivial-compress/src/cl.lisp: The trivial-compress/src/cl<dot>lisp file
File, Lisp, trivial-compress/src/native.lisp: The trivial-compress/src/native<dot>lisp file
File, Lisp, trivial-compress/src/trivial-compress.lisp: The trivial-compress/src/trivial-compress<dot>lisp file

L
Lisp File, trivial-compress.asd: The trivial-compress<dot>asd file
Lisp File, trivial-compress/src/cl.lisp: The trivial-compress/src/cl<dot>lisp file
Lisp File, trivial-compress/src/native.lisp: The trivial-compress/src/native<dot>lisp file
Lisp File, trivial-compress/src/trivial-compress.lisp: The trivial-compress/src/trivial-compress<dot>lisp file

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

T
trivial-compress.asd: The trivial-compress<dot>asd file
trivial-compress/src: The trivial-compress/src module
trivial-compress/src/cl.lisp: The trivial-compress/src/cl<dot>lisp file
trivial-compress/src/native.lisp: The trivial-compress/src/native<dot>lisp file
trivial-compress/src/trivial-compress.lisp: The trivial-compress/src/trivial-compress<dot>lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

Jump to:   F   S   T   Z  
Index Entry  Section

F
Function, subtract-pathname: Internal functions
Function, tar: Exported functions
Function, tar: Exported functions
Function, tar: Exported functions
Function, zip: Exported functions
Function, zip: Exported functions
Function, zip: Exported functions

S
subtract-pathname: Internal functions

T
tar: Exported functions
tar: Exported functions
tar: Exported functions

Z
zip: Exported functions
zip: Exported functions
zip: Exported functions

Jump to:   F   S   T   Z  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, trivial-compress: The trivial-compress package
Package, trivial-compress.cl: The trivial-compress<dot>cl package
Package, trivial-compress.native: The trivial-compress<dot>native package

S
System, trivial-compress: The trivial-compress system

T
trivial-compress: The trivial-compress system
trivial-compress: The trivial-compress package
trivial-compress.cl: The trivial-compress<dot>cl package
trivial-compress.native: The trivial-compress<dot>native package

Jump to:   P   S   T