OC-misc/mtar
Izaya 1f5c0b013e updated liblz16 and libmtar to use string.(un)pack and support bigger files 2021-05-26 17:49:42 +10:00
..
OpenOS/usr updated liblz16 and libmtar to use string.(un)pack and support bigger files 2021-05-26 17:49:42 +10:00
README.md Updated README to include libmtar documentation and added type annotations to libmtar 2020-05-31 14:54:53 +10:00
libmtar.lua updated liblz16 and libmtar to use string.(un)pack and support bigger files 2021-05-26 17:49:42 +10:00

README.md

mtar - Minitel Archiver

mtar is a file format for storing multiple files in a single file, much like tar, cpio or zip.

File format

mtar archive files consist of a number of file entries, in the following format:

  • 2 bytes file name length
  • the file name
  • 2 bytes file content length
  • the file contents

Archives are terminated either by the end of file, or a record with a name length of zero.

libmtar

libmtar is the reference implementation of mtar. It provides two functions:

  • libmtar.genHeader(string: name, number: len): string
    Generates an mtar file header for a file called name that is len bytes long.
  • libmtar.iter(table: stream): function
    Given buffer stream, returns an iterator suitable for use with for that returns, for each iteration, the file name, a function to read from the file, and the length of the file.