github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-05 02:55:31 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Vinícius Miguel 2021-03-24 19:04:14 -03:00 committed by GitHub
parent 9ea18659e5
commit b343e7872c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,6 +1,6 @@
# ouch (_work in progress_)
`ouch` is the Obvious Unified Compression (and decompression) Helper.
`ouch` is the Obvious Unified Compression (_and decompression_) Helper.
| Supported formats | .tar | .zip | .tar.{.lz*,.gz, .bz} | .zip.{.lz*, .gz, .bz*} | .bz | .gz | .lz, .lzma |
@ -37,22 +37,24 @@ OPTIONS:
$ ouch -i file{1..5}.zip another_file.tar.gz yet_another_file.tar.bz
```
When no output file is supplied, `ouch` infers that it must decompress all of its input files. This will error if any of the input files are not decompressible.
When no output file is supplied, `ouch` infers that it must decompress all of its input files into the current folder. This will error if any of the input files are not decompressible.
#### Decompressing a bunch of files into a folder
```bash
$ ouch -i file{1..5}.tar.gz -o some-folder
# Decompresses file1.tar.gz, file2.tar.gz, file3.tar.gz, file4.tar.gz and file5.tar.gz to some-folder
$ ouch -i file{1..3}.tar.gz videos.tar.bz2 -o some-folder
# Decompresses file1.tar.gz, file2.tar.gz, file3.tar.gz and videos.tar.bz2 to some-folder
# The folder `ouch` saves to will be created if it doesn't already exist
```
When the output file is not a compressed file, `ouch` will check if all input files are decompressible and infer that it must decompress them into the output file.
When the output file is not a compressed file, `ouch` will check if all input files are decompressible and infer that it must decompress them into the output folder.
#### Compressing files
```bash
$ ouch -i file{1..20} -o archive.tar
$ ouch -i Videos/ Movies/ -o media.tar.lzma
$ ouch -i src/ Cargo.toml Cargo.lock -o my_project.tar.gz
```
### Error scenarios
@ -66,6 +68,15 @@ error: file 'some-file' is not decompressible.
`ouch` cannot infer `some-file`'s compression format since it lacks an extension. Likewise, `ouch` cannot infer that the output file given is a compressed file, so it shows the user an error.
```bash
$ ouch -i file other-file -o files.gz
error: cannot compress multiple files directly to Gzip.
Try using an intermediate archival method such as Tar.
Example: filename.tar.gz
```
Similar errors are shown if the same scenario is applied to `.lz/.lzma` and `.bz/.bz2`.
## Installation
### Runtime dependencies
@ -108,3 +119,15 @@ cd ouch && cargo run --release
```
I also recommend stripping the release binary. `ouch`'s release binary (at the time of writing) only takes up a megabyte in space when stripped.
## Supported operating systems
`ouch` _should_ be cross-platform but is currently only tested (and developed) on Linux, on both x64-64 and ARM.
## Limitations
`ouch` does encoding and decoding in-memory, so decompressing very large files with `ouch` is not advisable.
## Contributions
Any contributions and suggestions are welcome!