SimpleArchiver/README.md
Stephen Seo cf032cd9c1
All checks were successful
Run Unit Tests / build-and-run-unit-tests (push) Successful in 7s
Update README.md
2024-10-04 21:28:29 +09:00

2 KiB

Simple Archiver

This program is not yet almost finished! Basic functionality is implemented and only some advanced features are missing. You can track progress here.

This program exists because I could not get tar or ar to compile with Cosmopolitan. Thus, this archiver will be written with support for Cosmopolitan in mind. This means sticking to the C programming language and possibly using Cosmopolitan-specfic API calls.

Usage

Usage flags:
-c : create archive file
-x : extract archive file
-t : examine archive file
-f <filename> : filename to work on
  Use "-f -" to work on stdout when creating archive or stdin when reading archive
  NOTICE: "-f" is not affected by "-C"!
-C <dir> : Change current working directory before archiving/extracting
--compressor <full_compress_cmd> : requires --decompressor
--decompressor <full_decompress_cmd> : requires --compressor
  Specifying "--decompressor" when extracting overrides archive file's stored decompressor cmd
--overwrite-create : allows overwriting an archive file
--overwrite-extract : allows overwriting when extracting
--no-abs-symlink : do not store absolute paths for symlinks
--temp-files-dir <dir> : where to store temporary files created when compressing (defaults to current working directory)
--write-version <version> : Force write version file format (default 1)
--chunk-min-size <bytes> : v1 file format minimum chunk size (default 4194304 or 4MiB)
-- : specifies remaining arguments are files to archive/extract
If creating archive file, remaining args specify files to archive.
If extracting archive file, remaining args specify files to extract.

Note that --compressor and --decompressor cmds must accept data from stdin and return processed data to stdout.

LICENSE Information

Uses the ISC License.