From 6525de930356b1795d94d23adcbbf25f696709e0 Mon Sep 17 00:00:00 2001 From: Armin Friedl Date: Mon, 3 Aug 2020 22:02:35 +0200 Subject: [PATCH] Update README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 0dae38a..f7686af 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,23 @@ This will extract the archive to the current folder. If the archive contains a single root folder it is just extracted as is. Otherwise xwim first creates a folder named after the archive and extracts the contents there. + +```shell +xwim /home/user/ +``` + +This will create an archive in the "platform native" format (zip on windows, +tar.gz on unix) in the current working directory. The archive contains a single +root folder `user` and is itself named `user.zip` or `user.tar.gz`. + +```shell +xwim /home/user/file.txt +``` + +This will create an archive in the "platform native" format (zip on windows, +tar.gz on unix) in the current working directory. The archive contains a single +entry `file.txt` and is itself named `file.zip` or `file.tar.gz`. + # Examples ## Single root folder named after the archive @@ -137,3 +154,12 @@ dev[at]friedl[dot]net. If you are interested in a long-term co-maintainership you can also drop me a mail for an account on https://git.friedl.net. + +# Known Issues + +- Parsing filters is unsupported + There is a somewhat long standing + [bug](https://github.com/libarchive/libarchive/issues/373) in the underlying + libarchive library. rar files might fail with `Parsing filters is + unsupported`. In case you run into this issue, the only workaround for now is + to use another extraction tool.