The trivial-extract Reference Manual

This is the trivial-extract Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:55:58 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-extract

Extract .tar/.tar.gz/.zip files.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/eudoxia0/trivial-extract

Source Control

(GIT git@github.com:eudoxia0/trivial-extract.git)

Bug Tracker

https://github.com/eudoxia0/trivial-extract/issues

License

MIT

Long Description

# trivial-extract

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

You have an archive. Maybe it’s a ‘.tar‘, or a ‘.tar.gz‘, or ‘.zip‘. You don’t
know and don’t care. You want its contents out.

When available, ‘trivial-extract‘ uses the native decompression utilities
(e.g. ‘tar‘, ‘unzip‘), which are usually faster than the Common Lisp versions.

# Usage

Contents are extracted to the file’s containing directory. All functions return
‘t‘ on success.

~~~lisp
;; Best effort, do what I mean
(trivial-extract:extract #p"~/path/to/file.{tar|tar.gz|zip}")

;; Content-specific
(trivial-extract:extract-tar #p"~/file.tar")
(trivial-extract:extract-gzip #p"~/file.tar.gz")
(trivial-extract:extract-zip #p"~/file.zip")
~~~

# License

Copyright (c) 2014-2015 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

Version

0.1

Dependencies
  • archive (system).
  • zip (system).
  • deflate (system).
  • which (system).
  • cl-fad (system).
  • uiop (system).
  • alexandria (system).
Source

trivial-extract.asd.

Child Component

src (module).


3 Modules

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


3.1 trivial-extract/src

Source

trivial-extract.asd.

Parent Component

trivial-extract (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 trivial-extract/trivial-extract.asd

Source

trivial-extract.asd.

Parent Component

trivial-extract (system).

ASDF Systems

trivial-extract.


4.1.2 trivial-extract/src/cl.lisp

Source

trivial-extract.asd.

Parent Component

src (module).

Packages

trivial-extract.cl.

Public Interface
Internals

gunzip (function).


4.1.3 trivial-extract/src/native.lisp

Source

trivial-extract.asd.

Parent Component

src (module).

Packages

trivial-extract.native.

Public Interface

4.1.4 trivial-extract/src/trivial-extract.lisp

Source

trivial-extract.asd.

Parent Component

src (module).

Packages

trivial-extract.

Public Interface
Internals

try-except (macro).


5 Packages

Packages are listed by definition order.


5.1 trivial-extract

Source

trivial-extract.lisp.

Use List

common-lisp.

Public Interface
Internals

try-except (macro).


5.2 trivial-extract.cl

Pure Common Lisp extraction.

Source

cl.lisp.

Use List

common-lisp.

Public Interface
Internals

gunzip (function).


5.3 trivial-extract.native

Decompression using native command line utilities.

Source

native.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: extract (pathname)

Best-effort extraction.

Package

trivial-extract.

Source

trivial-extract.lisp.

Function: extract-gzip (pathname)

Extract a .tar.gz file to its containing directory.

Package

trivial-extract.

Source

trivial-extract.lisp.

Function: extract-gzip (pathname)

Extract a .tar.gz file to its containing directory.

Package

trivial-extract.cl.

Source

cl.lisp.

Function: extract-gzip (binary pathname)

Extract a .tar.gz file to its containing directory.

Package

trivial-extract.native.

Source

native.lisp.

Function: extract-tar (pathname)

Extract a tarball to its containing directory.

Package

trivial-extract.

Source

trivial-extract.lisp.

Function: extract-tar (pathname)

Extract a tarball to its containing directory.

Package

trivial-extract.cl.

Source

cl.lisp.

Function: extract-tar (binary pathname)

Extract a tarball to its containing directory.

Package

trivial-extract.native.

Source

native.lisp.

Function: extract-zip (pathname)

Extract a .zip file to its containing directory.

Package

trivial-extract.

Source

trivial-extract.lisp.

Function: extract-zip (pathname)

Extract a .zip file to its containing directory.

Package

trivial-extract.cl.

Source

cl.lisp.

Function: extract-zip (binary pathname)

Extract a .zip file to its containing directory.

Package

trivial-extract.native.

Source

native.lisp.


6.2 Internals


6.2.1 Macros

Macro: try-except (try on-failure)
Package

trivial-extract.

Source

trivial-extract.lisp.


6.2.2 Ordinary functions

Function: gunzip (tar-gz-file tar-file)

Extract a .tar.gz file into a .tar archive.

Package

trivial-extract.cl.

Source

cl.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables