mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-01 23:19:25 +00:00
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.
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
424d4cb779
commit
1ff9421f7b
@ -2,6 +2,10 @@
|
||||
|
||||
Provides functions to create, list, and extract archives.
|
||||
|
||||
This module must be loaded _before_ the [_`completion`_][1] module so that the
|
||||
provided completion definitions are loaded automatically by _`completion`_
|
||||
module.
|
||||
|
||||
## Functions
|
||||
|
||||
- `archive` creates an archive based on the provided archive name.
|
||||
@ -13,20 +17,20 @@ Provides functions to create, list, and extract archives.
|
||||
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`.
|
||||
- _.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
|
||||
@ -34,14 +38,16 @@ full advantage of all available CPU cores for compression.
|
||||
|
||||
## Alternatives
|
||||
|
||||
Specifically on macOS, [The Unarchiver][1] provides a similar command line tool
|
||||
Specifically on macOS, [The Unarchiver][2] 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][1].*
|
||||
_The authors of this module should be contacted via the [issue tracker][3]._
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Matt Hamilton](https://github.com/Eriner)
|
||||
|
||||
[1]: https://theunarchiver.com/command-line
|
||||
[1]: ../completion#readme
|
||||
[2]: https://theunarchiver.com/command-line
|
||||
[3]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
Reference in New Issue
Block a user