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 Mon Aug 15 06:02:42 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The trivial-compress Reference Manual, Up: The trivial-compress Reference Manual [Contents][Index]
1 Introduction
trivial-compress
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: Modules, Previous: Introduction, Up: The trivial-compress Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 trivial-compress
Compress a directory.
- Maintainer
Fernando Borretti <eudoxiahp@gmail.com>
- Author
Fernando Borretti <eudoxiahp@gmail.com>
- Home Page
- Source Control
(GIT git@github.com:ceramic/trivial-compress.git)
- Bug Tracker
- License
MIT
- Long Description
# trivial-compress
[](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
- 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.
3.1 trivial-compress/src
- Source
- 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.
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
- Parent Component
trivial-compress (system).
- ASDF Systems
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
- Parent Component
src (module).
- Packages
- Public Interface
- 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
Previous: trivial-compress/src/native.lisp, Up: Lisp [Contents][Index]
4.1.4 trivial-compress/src/trivial-compress.lisp
- Dependency
native.lisp (file).
- Source
- Parent Component
src (module).
- Packages
- Public Interface
Next: Definitions, Previous: Files, Up: The trivial-compress Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
Next: trivial-compress.native, Previous: Packages, Up: Packages [Contents][Index]
5.1 trivial-compress
The main compress interface.
- Source
- Use List
common-lisp.
- Public Interface
Next: trivial-compress.cl, Previous: trivial-compress, Up: Packages [Contents][Index]
5.2 trivial-compress.native
Compress using native utilities.
- Source
- Use List
common-lisp.
- Public Interface
Previous: trivial-compress.native, Up: Packages [Contents][Index]
5.3 trivial-compress.cl
Compress using pure Common Lisp.
- Source
- Use List
common-lisp.
- Public Interface
- 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.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
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
- Source
- Function: tar (binary directory archive) ¶
-
Create a tar archive from the contents of a directory.
- Package
- Source
- Function: tar (directory archive) ¶
-
Create a tar archive from the contents of a directory.
- Package
- Source
- Function: zip (directory archive) ¶
-
Create a zip archive from the contents of a directory.
- Package
- Source
- Function: zip (binary directory archive) ¶
-
Create a zip archive from the contents of a directory.
- Package
- Source
- Function: zip (directory archive) ¶
-
Create a zip archive from the contents of a directory.
- Package
- Source
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
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
- Source
Previous: Definitions, Up: The trivial-compress Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | F S T Z |
|---|
| Jump to: | F S T Z |
|---|
A.4 Data types
| Jump to: | C F M N P S T |
|---|
| Jump to: | C F M N P S T |
|---|