SimpleArchiver/README.md

48 lines
2.3 KiB
Markdown
Raw Normal View History

# Simple Archiver
2024-10-08 04:31:26 +00:00
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
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
2024-07-26 03:42:43 +00:00
NOTICE: "-f" is not affected by "-C"!
-C <dir> : Change current working directory before archiving/extracting
2024-10-08 01:55:24 +00:00
--compressor <full_compress_cmd> : requires --decompressor and cmd must use stdin/stdout
--decompressor <full_decompress_cmd> : requires --compressor and cmd must use stdin/stdout
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-10-04 12:28:29 +00:00
--write-version <version> : Force write version file format (default 1)
--chunk-min-size <bytes> : v1 file format minimum chunk size (default 4194304 or 4MiB)
2024-10-08 06:20:21 +00:00
--pre-sort-files : pre-sorts files by size so that the first file is the largest
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.
2024-10-08 05:05:20 +00:00
## Changes
See the [Changelog](https://git.seodisparate.com/stephenseo/SimpleArchiver/src/branch/main/Changelog.md).
## LICENSE Information
2024-08-30 02:35:17 +00:00
Uses the [ISC License](https://choosealicense.com/licenses/isc/).