The trivial-extract Reference Manual

Table of Contents

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

The trivial-extract Reference Manual

This is the trivial-extract Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:26:47 2018 GMT+0.


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

1 Introduction

trivial-extract

Build Status

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.

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


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-extract

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

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

Description

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

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
Source

trivial-extract.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-extract/src

Parent

trivial-extract (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-extract.asd

Location

trivial-extract.asd

Systems

trivial-extract (system)


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

4.1.2 trivial-extract/src/cl.lisp

Parent

src (module)

Location

src/cl.lisp

Packages

trivial-extract.cl

Exported Definitions
Internal Definitions

gunzip (function)


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

4.1.3 trivial-extract/src/native.lisp

Parent

src (module)

Location

src/native.lisp

Packages

trivial-extract.native

Exported Definitions

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

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

Parent

src (module)

Location

src/trivial-extract.lisp

Packages

trivial-extract

Exported Definitions
Internal Definitions

try-except (macro)


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

5 Packages

Packages are listed by definition order.


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

5.1 trivial-extract.cl

Pure Common Lisp extraction.

Source

cl.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

gunzip (function)


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

5.2 trivial-extract.native

Decompression using native command line utilities.

Source

native.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.3 trivial-extract

Source

trivial-extract.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

try-except (macro)


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: extract PATHNAME

Best-effort extraction.

Package

trivial-extract

Source

trivial-extract.lisp (file)

Function: extract-gzip PATHNAME

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

Package

trivial-extract.cl

Source

cl.lisp (file)

Function: extract-gzip BINARY PATHNAME

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

Package

trivial-extract.native

Source

native.lisp (file)

Function: extract-gzip PATHNAME

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

Package

trivial-extract

Source

trivial-extract.lisp (file)

Function: extract-tar PATHNAME

Extract a tarball to its containing directory.

Package

trivial-extract.cl

Source

cl.lisp (file)

Function: extract-tar BINARY PATHNAME

Extract a tarball to its containing directory.

Package

trivial-extract.native

Source

native.lisp (file)

Function: extract-tar PATHNAME

Extract a tarball to its containing directory.

Package

trivial-extract

Source

trivial-extract.lisp (file)

Function: extract-zip PATHNAME

Extract a .zip file to its containing directory.

Package

trivial-extract.cl

Source

cl.lisp (file)

Function: extract-zip BINARY PATHNAME

Extract a .zip file to its containing directory.

Package

trivial-extract.native

Source

native.lisp (file)

Function: extract-zip PATHNAME

Extract a .zip file to its containing directory.

Package

trivial-extract

Source

trivial-extract.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Macros

Macro: try-except TRY ON-FAILURE
Package

trivial-extract

Source

trivial-extract.lisp (file)


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

6.2.2 Functions

Function: gunzip TAR-GZ-FILE TAR-FILE

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

Package

trivial-extract.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-extract.asd: The trivial-extract<dot>asd file
File, Lisp, trivial-extract/src/cl.lisp: The trivial-extract/src/cl<dot>lisp file
File, Lisp, trivial-extract/src/native.lisp: The trivial-extract/src/native<dot>lisp file
File, Lisp, trivial-extract/src/trivial-extract.lisp: The trivial-extract/src/trivial-extract<dot>lisp file

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

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

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

Jump to:   F   L   M   T  

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

A.2 Functions

Jump to:   E   F   G   M   T  
Index Entry  Section

E
extract: Exported functions
extract-gzip: Exported functions
extract-gzip: Exported functions
extract-gzip: Exported functions
extract-tar: Exported functions
extract-tar: Exported functions
extract-tar: Exported functions
extract-zip: Exported functions
extract-zip: Exported functions
extract-zip: Exported functions

F
Function, extract: Exported functions
Function, extract-gzip: Exported functions
Function, extract-gzip: Exported functions
Function, extract-gzip: Exported functions
Function, extract-tar: Exported functions
Function, extract-tar: Exported functions
Function, extract-tar: Exported functions
Function, extract-zip: Exported functions
Function, extract-zip: Exported functions
Function, extract-zip: Exported functions
Function, gunzip: Internal functions

G
gunzip: Internal functions

M
Macro, try-except: Internal macros

T
try-except: Internal macros

Jump to:   E   F   G   M   T  

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-extract: The trivial-extract package
Package, trivial-extract.cl: The trivial-extract<dot>cl package
Package, trivial-extract.native: The trivial-extract<dot>native package

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

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

Jump to:   P   S   T