Stephen Seo
2a63793bcd
All checks were successful
Run Unit Tests / build-and-run-unit-tests (push) Successful in 13s
47 lines
2.4 KiB
Markdown
47 lines
2.4 KiB
Markdown
# Simple Archiver
|
|
|
|
This program ~~is not yet~~ ~~almost~~ basically finished! ~~Basic~~ Necessary
|
|
functionality is implemented and only ~~some advanced features are missing~~
|
|
some extra features are not yet implemented. You can track progress
|
|
[here](https://git.seodisparate.com/stephenseo/SimpleArchiver/projects/3).
|
|
|
|
This program exists because I could not get `tar` or `ar` to compile with
|
|
[Cosmopolitan](https://justine.lol/cosmopolitan/index.html). 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 and cmd must use stdin/stdout
|
|
--decompressor <full_decompress_cmd> : requires --compressor and cmd must use stdin/stdout
|
|
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)
|
|
--no-pre-sort-files : do NOT pre-sort files by size (by default enabled so that the first file is the largest)
|
|
-- : 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.
|
|
|
|
## Changes
|
|
|
|
See the [Changelog](https://git.seodisparate.com/stephenseo/SimpleArchiver/src/branch/main/Changelog.md).
|
|
|
|
## LICENSE Information
|
|
|
|
Uses the [ISC License](https://choosealicense.com/licenses/isc/).
|