You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kaleb Elwert 7d5beeab51 Add comments into each of the function files to make them easier to find 8 years ago
..
functions Add comments into each of the function files to make them easier to find 8 years ago
README.md archive: add archive function 8 years ago

README.md

Archive

Provides functions to create, list, and extract archives.

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 unrar or rar.
  • .7z requires 7za.
  • .deb requires ar, tar.

Additionally, if pigz' and/or pbzip2are installed,archivewill use them over their traditional counterparts,gzipandbzip2` respectively, to take full advantage of all available CPU cores for compression.

Authors

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