From c28c5edd214d409742158a713ee438cc1d68e277 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Thu, 31 May 2012 23:06:24 -0400 Subject: [PATCH] [Fix #99] Add documentation for archive --- modules/archive/README.md | 41 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 modules/archive/README.md diff --git a/modules/archive/README.md b/modules/archive/README.md new file mode 100644 index 0000000..c997ddb --- /dev/null +++ b/modules/archive/README.md @@ -0,0 +1,41 @@ +Archive +======= + +Provides functions to extract and list popular archive formats. + +Functions +--------- + + - `extract` extracts the contents of one or more archives. + - `ls-archive` lists the contents of one or more archives. + +Supported Formats +----------------- + +The following archive formats are supported when the required utilities are +installed: + + - *.tar.gz*, *.tgz* require `tar`. + - *.tar.bz2*, *.tbz* require `tar`. + - *.tar.xz*, *.txz* require `tar` with *xz* support. + - *.tar.zma*, *.tlz* require `tar` with *lzma* support. + - *.tar* requires `tar`. + - *.gz* requires `gunzip`. + - *.bz2* requires `bunzip2`. + - *.xz* requires `unxz`. + - *.lzma* requires `unlzma`. + - *.Z* requires `uncompress`. + - *.zip* requires `unzip`. + - *.rar* requires `unrar`. + - *.7z* requires `7za`. + - *.deb* requires `ar`, `tar`. + +Authors +------- + +*The authors of this module should be contacted via the [issue tracker][1].* + + - [Sorin Ionescu](https://github.com/sorin-ionescu) + +[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues +