Skip to content

Commit

Permalink
README: make the decompressors list clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
dimkr committed Jan 20, 2020
1 parent 8614f24 commit fa75613
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,17 @@ It is designed to be portable across different devices, therefore it avoids mach

## Implementation

papaw consists of a small executable (~15-40K) containing [XZ Embedded](https://tukaani.org/xz/embedded.html), the [LZMA SDK](https://www.7-zip.org/sdk.html) decompressor, the [Zstandard](https://github.com/facebook/zstd) decompressor or the [miniz](https://github.com/richgel999/miniz) decompressor. It extracts a compressed executable appended to it by the papawify script.
papaw consists of a small executable (~15-40K) containing a decompressor. It extracts a compressed executable appended to it by the papawify script.

The payload executable is extracted to a temporary file. When running as root, this is done by mounting a tmpfs file system and lazily unmounting it before the extraction.

## Supported Decompressors

* [XZ Embedded](https://tukaani.org/xz/embedded.html) (the default)
* The [LZMA SDK](https://www.7-zip.org/sdk.html) decompressor
* The [Zstandard](https://github.com/facebook/zstd) decompressor
* [miniz](https://github.com/richgel999/miniz)

## Usage

papaw uses [Meson](http://mesonbuild.com/) as its build system. To pack an executable using papaw, build papaw, then use papawify to pack the executable.
Expand Down

0 comments on commit fa75613

Please sign in to comment.