History

Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.	2021-05-21 12:31:02 -05:00
..
functions	archive: Remove unnecessary interpreter directive	2021-05-02 03:01:32 -05:00
README.md	general: Update documentation better qualifying runcom paths	2021-05-21 12:31:02 -05:00

Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths

Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.

2021-05-21 12:31:02 -05:00

functions

archive: Remove unnecessary interpreter directive

2021-05-02 03:01:32 -05:00

README.md

general: Update documentation better qualifying runcom paths

2021-05-21 12:31:02 -05:00

README.md

Archive

Provides functions to create, list, and extract archives.

This module must be loaded before the completion module so that the provided completion definitions are loaded automatically by completion module.

Functions

archive creates an archive based on the provided archive name.
lsarchive lists the contents of one or more archives.
unarchive extracts 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 (optionally pigz).
.tar.bz2, .tbz require tar (optionally pbzip2).
.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, .jar requires unzip.
.rar requires rar (needed for archive support), unrar or lsar and unar.
.7z requires 7za.
.deb requires ar, tar.

Additionally, if pigz and/or pbzip2 are installed, archive will use them over their traditional counterparts, gzip and bzip2 respectively, to take full advantage of all available CPU cores for compression.

Alternatives

Specifically on macOS, The Unarchiver provides a similar command line tool which doesn't depend on a number of other programs being installed.

Authors

The authors of this module should be contacted via the issue tracker.