switch-coreboot/util/lar
Stefan Reinauer 02a4d350c6 fix more warnings.
Signed-off-by: Stefan Reinauer <stepan@coresystems.de>
Acked-by: Ronald G. Minnich <rminnich@gmail.com>



git-svn-id: svn://coreboot.org/repository/LinuxBIOSv3@99 f3766cd6-281f-0410-b1cd-43a5c92072e9
2007-02-23 12:36:45 +00:00
..
create.c Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
create.h Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
example.c Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
extract.c Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
extract.h Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
lar.c Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
lar.h Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
lib.c Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
lib.h Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
list.c Add a first bit of a framework. Builds the following parts, in 2007-01-29 22:09:50 +00:00
list.h Use the same format for the lar license headers as in the rest of the 2006-11-10 17:06:53 +00:00
Makefile fix more warnings. 2007-02-23 12:36:45 +00:00
README Whitespace fixes (trivial). 2006-11-09 18:51:12 +00:00

LinuxBIOS Archiver: lar
-----------------------

Table of Contents
  - Introduction
  - Usage
  - Archive format
  - TODO
  - ChangeLog


Introduction
------------

This is a simple archiver, similar to cpio, ar or tar.

Design goals were
  - minimum overhead
  - maximum fault tolerance
  - simplicity

For a usage example see example.c.

For questions contact Stefan Reinauer <stepan@coresystems.de>.


Usage
-----

Create archive archive.lar containing files file1 ... fileN

  $ lar c archive.lar file1 ... fileN

Extract files from archive.lar

  $ lar x archive.lar [file1 ... fileN]

List files in archive:

  $ lar l archive.lar


Archive format
--------------

The rough format is:

 |--------------|
 |  header      |
 |--------------|
 |  data        |
 |--------------|
 |  header      |
 |--------------|
 |  data        |
 |--------------|
  ...

Headers have to be 16 byte aligned.

 |--------------------|
 |  magic (8byte)     |
 |--------------------|
 |  length (4byte)    |
 |--------------------|
 |  checksum (4byte)  |
 |--------------------|
 | offset to blob (4b)|
 |--------------------|
 | "path name"        | <-- null terminated, aligned to 16b
 |--------------------|
 | blob (aligned 16b) |
 |--------------------|


TODO
----

  - Reading flash layouts
  - This does not enforce any alignment yet
  - Alignment enforcing will be optional


License
-------

This program is licensed under the terms of the GPL, version 2.


ChangeLog
---------

2006/10/9
  - Initial version