# `Storehouse.Archive.Tar`
[🔗](https://github.com/hattoriai/storehouse/blob/v0.2.0/lib/storehouse/archive/tar.ex#L1)

The tar format of `Storehouse.Archive`: for Unix tools and backups,
gzipped (`.tar.gz`) or not, made as a stream.

  * `:compression` - `:auto` (the default) gzips the archive when most
    of its bytes shrink; `:compress` always, `:none` never.
  * Names longer than tar's own, or not ASCII, and files past 8 GB have
    a pax header (POSIX.1-2001), which every tar of this century reads.

A tar's header gives a file's size before its bytes, so every file's
size is known before: a file of unknown size (`{:stream, …}`,
`{:call, …}`) gives an `ArgumentError`. It is not encrypted:
`:password` gives one too.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
