SimpleArchiver/README.md

38 lines
1.7 KiB
Markdown
Raw Normal View History

# Simple Archiver
2024-07-24 06:21:04 +00:00
This program ~~is not yet~~ almost finished! Basic functionality is implemented
and only some advanced features are missing. You can track progress
2024-06-29 07:00:59 +00:00
[here](https://git.seodisparate.com/stephenseo/SimpleArchiver/projects/3).
2024-06-27 08:21:59 +00:00
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.
2024-07-24 06:22:39 +00:00
## 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
--compressor <full_compress_cmd> : requires --decompressor
--decompressor <full_decompress_cmd> : requires --compressor
2024-07-24 06:27:05 +00:00
Specifying "--decompressor" when extracting overrides archive file's stored decompressor cmd
2024-07-24 06:22:39 +00:00
--overwrite-create : allows overwriting an archive file
--overwrite-extract : allows overwriting when extracting
--no-abs-symlink : do not store absolute paths for symlinks
2024-07-25 01:46:00 +00:00
--temp-files-dir <dir> : where to store temporary files created when compressing (defaults to current working directory)
2024-07-24 06:22:39 +00:00
-- : 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.
2024-07-24 06:24:44 +00:00
Note that `--compressor` and `--decompressor` cmds must accept data from stdin
and return processed data to stdout.
## LICENSE Information
Uses the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0).