Skip to content

Commit

Permalink
Update the basic readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
minfrin committed Apr 24, 2016
1 parent 7693ee4 commit 0e69c51
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# tarmux
A tool to multiplex and demultiplex streams from pipes to tar and back again.

Tarmux attempts to solve the problem of handling streamed data where there
is insufficient temporary space on disk to hold the data, as is forced by
tar.

In the simplest invocation, tarmux takes a stream from stdin, and creates
a tar file consisting of sequential numbered file fragments one after the
other. This can be reversed by the tardemux tool, which will untar the
fragments and reassemble the stream to stdout.

The tardemux tool only reads a single tar stream before exiting. This allows
multiple streams to be concatenated in the same stream, and then split out
by each invocation of tardemux.

# about tarmux

Tarmux is written for speed in portable C, and is tested on MacOSX, Redhat
and Ubuntu. Tar mux depends on libarchive http://www.libarchive.org/.
Packaging is available for RPM and Debian/Ubuntu systems.

0 comments on commit 0e69c51

Please sign in to comment.