dominic
/
prezto
1
0
Fork 0
Code Releases Activity

general: Update documentation better qualifying runcom paths

Browse Source 
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.
pull/1920/head
Indrajit Raychaudhuri 4 years ago committed by Indrajit Raychaudhuri
parent 424d4cb779
commit 1ff9421f7b
46 changed files with 435 additions and 338 deletions
Show Stats Download Patch File Download Diff File

63
README.md
Unescape View File

@ -21,8 +21,32 @@ version is **4.3.11**.
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto" git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
``` ```
03. Create a new Zsh configuration by copying the Zsh configuration files <details>
provided: <summary><em>Optional: Installing in <code>$XDG_CONFIG_HOME</code></em></summary>
Optionally, if you already have `$XDG_CONFIG_HOME` configured (usually as
_`$HOME/.config`_ by default) and intend to install Prezto under
_`$XDG_CONFIG_HOME/zsh`_ instead, you can clone the repository there and
configure `$ZDOTDIR` separately if not already configured.
- Clone the repository:
```console
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-${XDG_CONFIG_HOME:-$HOME/.config}/zsh}/.zprezto"
```
- Configure `$XDG_CONFIG_HOME` and `$ZDOTDIR` in _`${$HOME}/.zshenv`_:
```sh
export XDG_CONFIG_HOME="${XDG_CONFIG_HOME:=$HOME/.config}"
export ZDOTDIR="${ZDOTDIR:=$XDG_CONFIG_HOME/zsh}"
source "$ZDOTDIR/.zshenv"
```
</details>
03. Create a new Zsh configuration by copying/linking the Zsh configuration
files provided:
```console ```console
setopt EXTENDED_GLOB setopt EXTENDED_GLOB
@ -34,10 +58,10 @@ version is **4.3.11**.
**Note:** If you already have any of the given configuration files, `ln` in **Note:** If you already have any of the given configuration files, `ln` in
the above operation will cause an error. In simple cases, you can load the above operation will cause an error. In simple cases, you can load
Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
the bottom of your *${ZDOTDIR:-$HOME}/.zshrc* and keep the rest of your Zsh the bottom of your _`${ZDOTDIR:-$HOME}/.zshrc`_ and keep the rest of your
configuration intact. For more complicated setups, we recommend that you Zsh configuration intact. For more complicated setups, we recommend that you
back up your original configs and replace them with the provided Prezto back up your original configs and replace them with the provided Prezto
*runcoms*. [_`runcoms`_][10].
04. Set Zsh as your default shell: 04. Set Zsh as your default shell:
@ -50,7 +74,7 @@ version is **4.3.11**.
### Troubleshooting ### Troubleshooting
If you are not able to find certain commands after switching to Prezto, modify If you are not able to find certain commands after switching to Prezto, modify
the `PATH` variable in *${ZDOTDIR:-$HOME}/.zprofile* then open a new Zsh the `PATH` variable in _`${ZDOTDIR:-$HOME}/.zprofile`_ then open a new Zsh
terminal window or tab. terminal window or tab.
## Updating ## Updating
@ -76,33 +100,33 @@ accompanying README files to learn about what is available.
### Modules ### Modules
01. Browse */modules* to see what is available. 01. Browse [_`modules`_][9] to see what is available.
02. Load the modules you need in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new 02. Load the modules you need in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then open
Zsh terminal window or tab. a new Zsh terminal window or tab.
### Themes ### Themes
01. For a list of themes, type `prompt -l`. 01. For a list of themes, type `prompt -l`.
02. To preview a theme, type `prompt -p name`. 02. To preview a theme, type `prompt -p name`.
03. Load the theme you like in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new 03. Load the theme you like in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then
Zsh terminal window or tab. open a new Zsh terminal window or tab.
![sorin theme][2] ![sorin theme][2]
Note that the *git* module may be required for special symbols to appear, Note that the [_`git`_][11] module may be required for special symbols to
such as those on the right of the above image. Add `'git'` to the `pmodule` appear, such as those on the right of the above image. Add `'git'` to the
list (under `zstyle ':prezto:load' pmodule \` in your `pmodule` list (under `zstyle ':prezto:load' pmodule \` in your
*${ZDOTDIR:-$HOME}/.zpreztorc*) to enable this module. _`${ZDOTDIR:-$HOME}/.zpreztorc`_) to enable this module.
### External Modules ### External Modules
01. By default modules will be loaded from */modules* and */contrib*. 01. By default modules will be loaded from [_`/modules`_][9] and _`/contrib`_.
02. Additional module directories can be added to the 02. Additional module directories can be added to the
`:prezto:load:pmodule-dirs` setting in *${ZDOTDIR:-$HOME}/.zpreztorc*. `:prezto:load:pmodule-dirs` setting in _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
Note that module names need to be unique or they will cause an error when Note that module names need to be unique or they will cause an error when
loading. loading.
```console ```sh
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
``` ```
@ -129,3 +153,6 @@ This project is licensed under the MIT License.
[6]: https://git.github.io/git-reference/ [6]: https://git.github.io/git-reference/
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf [7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[8]: https://grml.org/zsh/zsh-lovers.html [8]: https://grml.org/zsh/zsh-lovers.html
[9]: modules#readme
[10]: runcoms#readme
[11]: modules/git#readme

6
modules/README.md
Unescape View File

@ -1,6 +1,6 @@
# Modules # Modules
Load modules in *~/.zpreztorc*. The order matters. Load modules in _`${ZDOTDIR:-$HOME}/.zpreztorc`_. The order matters.
```sh ```sh
zstyle ':prezto:load' pmodule 'environment' 'terminal' zstyle ':prezto:load' pmodule 'environment' 'terminal'
@ -29,11 +29,11 @@ Sets directory options and defines directory aliases.
## DNF ## DNF
Defines *dnf* aliases. Defines _dnf_ aliases.
## Dpkg ## Dpkg
Defines *dpkg* aliases and functions. Defines _dpkg_ aliases and functions.
## Editor ## Editor

40
modules/archive/README.md
Unescape View File

@ -2,6 +2,10 @@
Provides functions to create, list, and extract archives. 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 ## Functions
- `archive` creates an archive based on the provided archive name. - `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 The following archive formats are supported when the required utilities are
installed: installed:
- *.tar.gz*, *.tgz* require `tar` (optionally `pigz`). - _.tar.gz_, _.tgz_ require `tar` (optionally `pigz`).
- *.tar.bz2*, *.tbz* require `tar` (optionally `pbzip2`). - _.tar.bz2_, _.tbz_ require `tar` (optionally `pbzip2`).
- *.tar.xz*, *.txz* require `tar` with *xz* support. - _.tar.xz_, _.txz_ require `tar` with _xz_ support.
- *.tar.zma*, *.tlz* require `tar` with *lzma* support. - _.tar.zma_, _.tlz_ require `tar` with _lzma_ support.
- *.tar* requires `tar`. - _.tar_ requires `tar`.
- *.gz* requires `gunzip`. - _.gz_ requires `gunzip`.
- *.bz2* requires `bunzip2`. - _.bz2_ requires `bunzip2`.
- *.xz* requires `unxz`. - _.xz_ requires `unxz`.
- *.lzma* requires `unlzma`. - _.lzma_ requires `unlzma`.
- *.Z* requires `uncompress`. - _.Z_ requires `uncompress`.
- *.zip*, *.jar* requires `unzip`. - _.zip_, _.jar_ requires `unzip`.
- *.rar* requires `rar` (needed for `archive` support), `unrar` or `lsar` and `unar`. - _.rar_ requires `rar` (needed for `archive` support), `unrar` or `lsar` and `unar`.
- *.7z* requires `7za`. - _.7z_ requires `7za`.
- *.deb* requires `ar`, `tar`. - _.deb_ requires `ar`, `tar`.
Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them
over their traditional counterparts, `gzip` and `bzip2` respectively, to take over their traditional counterparts, `gzip` and `bzip2` respectively, to take
@ -34,14 +38,16 @@ full advantage of all available CPU cores for compression.
## Alternatives ## 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. which doesn't depend on a number of other programs being installed.
## Authors ## 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) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Matt Hamilton](https://github.com/Eriner) - [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

24
modules/autosuggestions/README.md
Unescape View File

@ -5,13 +5,16 @@ Integrates [zsh-autosuggestions][1] into Prezto, which implements the
of a previously entered command and Zsh suggests commands as you type based on of a previously entered command and Zsh suggests commands as you type based on
history and completions. history and completions.
If this module is used in conjunction with the *syntax-highlighting* module, If this module is used in conjunction with the [_`syntax-highlighting`_][3]
this module must be loaded **after** the *syntax-highlighting* module. module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
If this module is used in conjunction with the *history-substring-search* If this module is used in conjunction with the [_`history-substring-search`_][4]
module, this module must be loaded **after** the *history-substring-search* module, this module must be loaded _after_ the _`history-substring-search`_
module. module.
To elaborate, the relative order of loading the modules would be
_`autosuggestions`_, _`syntax-highlighting`_ and _`history-substring-search`_.
## Contributors ## Contributors
New features and bug fixes should be submitted to the [zsh-autosuggestions][1] New features and bug fixes should be submitted to the [zsh-autosuggestions][1]
@ -22,17 +25,18 @@ against it.
### Highlighting ### Highlighting
If colors are enabled, *autosuggestions* will automatically highlight If colors are enabled, _autosuggestions_ will automatically highlight
positive results. positive results.
To enable highlighting for this module only, add the following line to To enable highlighting for this module only, add the following line to
*~/.zpreztorc*: _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:autosuggestions' color 'yes' zstyle ':prezto:module:autosuggestions' color 'yes'
``` ```
To set the query found color, add the following line to *~/.zpreztorc*: To set the query found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:autosuggestions:color' found '' zstyle ':prezto:module:autosuggestions:color' found ''
@ -47,10 +51,12 @@ also have the `history` module enabled.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/tarruda/zsh-autosuggestions [1]: https://github.com/tarruda/zsh-autosuggestions
[2]: https://fishshell.com [2]: https://fishshell.com
[3]: https://github.com/sorin-ionescu/prezto/issues [3]: ../syntax-highlighting#readme
[4]: ../history-substring-search#readme
[5]: https://github.com/sorin-ionescu/prezto/issues

2
modules/command-not-found/README.md
Unescape View File

@ -12,7 +12,7 @@ a recent version of Homebrew installed, you might also need to tap the
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][4].* _The authors of this module should be contacted via the [issue tracker][4]._
- [Joseph Booker](https://github.com/sargas) - [Joseph Booker](https://github.com/sargas)
- [Indrajit Raychaudhuri](https://github.com/indrajitr) - [Indrajit Raychaudhuri](https://github.com/indrajitr)

21
modules/completion/README.md
Unescape View File

@ -3,7 +3,8 @@
Loads and configures <kbd>TAB</kbd> completion and provides additional Loads and configures <kbd>TAB</kbd> completion and provides additional
completions from the [zsh-completions][1] project. completions from the [zsh-completions][1] project.
This module must be loaded **after** the *utility* module. This module must be loaded late _after_ the _`utility`_ module and all other
modules that provide completion definitions.
## Options ## Options
@ -14,20 +15,20 @@ This module must be loaded **after** the *utility* module.
- `AUTO_LIST` automatically list choices on ambiguous completion. - `AUTO_LIST` automatically list choices on ambiguous completion.
- `AUTO_PARAM_SLASH` if completed parameter is a directory, add a trailing - `AUTO_PARAM_SLASH` if completed parameter is a directory, add a trailing
slash (`/`). slash (`/`).
- `EXTENDED_GLOB` needed for file modification glob modifiers with *compinit*. - `EXTENDED_GLOB` needed for file modification glob modifiers with _compinit_.
- `MENU_COMPLETE` do not autoselect the first completion entry. - `MENU_COMPLETE` do not autoselect the first completion entry.
- `FLOW_CONTROL` disable start/stop characters in shell editor. - `FLOW_CONTROL` disable start/stop characters in shell editor.
## Settings ## Settings
### Ignore */etc/hosts* Entries ### Ignore _`/etc/hosts`_ Entries
To ignore certain entries from static */etc/hosts* for host completion, add the To ignore certain entries from static _`/etc/hosts`_ for host completion, add
following lines in *~/.zpreztorc* with the IP addresses of the hosts as they the following lines in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ with the IP addresses of
appear in */etc/hosts*. Both IP address and the corresponding hostname will be the hosts as they appear in _`/etc/hosts`_. Both IP address and the associated
ignored during host completion. However, some of the entries ignored from hostname(s) will be ignored during host completion. However, some of the entries
*/etc/hosts* still might appear during completion because of their presence in ignored from _`/etc/hosts`_ still might appear during completion because of
*ssh* configuration or history). their presence in _ssh_ configuration or history).
```sh ```sh
zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \ zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \
@ -41,7 +42,7 @@ its rules and regulations. This module will be synchronized against it.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

2
modules/directory/README.md
Unescape View File

@ -22,7 +22,7 @@ Sets directory options and defines directory aliases.
## Authors ## 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][1]._
- [James Cox](https://github.com/imajes) - [James Cox](https://github.com/imajes)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

2
modules/dnf/README.md
Unescape View File

@ -17,7 +17,7 @@ Defines [dnf][1] aliases.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

10
modules/docker/README.md
Unescape View File

@ -134,8 +134,10 @@ Defines [Docker][1] aliases and functions.
- `dkm` is short for `docker-machine` - `dkm` is short for `docker-machine`
- `dkma` Get or set the active machine - `dkma` Get or set the active machine
- `dkmcp` Copy files between machines - `dkmcp` Copy files between machines
- `dkmd` Set up the default machine ; alowing you to use `dkme` without arguments - `dkmd` Set up the default machine ; alowing you to use `dkme` without
- `dkme` Set up the environment for the Docker client (eg: `dkme staging` to toggle to staging) arguments
- `dkme` Set up the environment for the Docker client (eg: `dkme staging` to
toggle to staging)
- `dkmin` Inspect information about a machine - `dkmin` Inspect information about a machine
- `dkmip` Get the IP address of a machine - `dkmip` Get the IP address of a machine
- `dkmk` Kill a machine - `dkmk` Kill a machine
@ -175,8 +177,8 @@ Defines [Docker][1] aliases and functions.
- `dkcsc` Set number of containers for a service - `dkcsc` Set number of containers for a service
- `dkcS` Restart services - `dkcS` Restart services
- `dkcu` Create and start containers - `dkcu` Create and start containers
- `dkcU` Create and start containers in detached mode: - `dkcU` Create and start containers in detached mode: Run containers in the
Run containers in the background, print new container names background, print new container names
- `dkcV` Show the Docker-Compose version information - `dkcV` Show the Docker-Compose version information
- `dkcx` Stop services - `dkcx` Stop services

4
modules/dpkg/README.md
Unescape View File

@ -1,6 +1,6 @@
# Dpkg # Dpkg
Defines [*dpkg*][1] aliases and functions. Defines [_dpkg_][1] aliases and functions.
## Aliases ## Aliases
@ -27,7 +27,7 @@ Defines [*dpkg*][1] aliases and functions.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Daniel Bolton](https://github.com/dbb) - [Daniel Bolton](https://github.com/dbb)
- [Benjamin Boudreau](https://github.com/dreur) - [Benjamin Boudreau](https://github.com/dreur)

28
modules/editor/README.md
Unescape View File

@ -14,17 +14,17 @@ Sets editor specific key bindings options and variables.
### Key bindings ### Key bindings
To enable key bindings, add the following to *~/.zpreztorc*, and replace To enable key bindings, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_,
'bindings' with 'emacs' or 'vi'. and replace `'<bindings>'` with `'emacs'` or `'vi'`.
```sh ```sh
zstyle ':prezto:module:editor' key-bindings 'bindings' zstyle ':prezto:module:editor' key-bindings '<bindings>'
``` ```
### Dot Expansion ### Dot Expansion
To enable the auto conversion of .... to ../.., add the following to To enable the auto conversion of .... to ../.., add the following to
*~/.zpreztorc*. _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:editor' dot-expansion 'yes' zstyle ':prezto:module:editor' dot-expansion 'yes'
@ -32,8 +32,8 @@ zstyle ':prezto:module:editor' dot-expansion 'yes'
### PS Context ### PS Context
To enable the prompt context to be set, add the following to your To enable the prompt context to be set, add the following to
*~/.zpreztorc*. _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:editor' ps-context 'yes' zstyle ':prezto:module:editor' ps-context 'yes'
@ -76,26 +76,26 @@ To indicate when the editor is completing, add the following to your
zstyle ':prezto:module:editor:info:completing' format '...' zstyle ':prezto:module:editor:info:completing' format '...'
``` ```
Then add `$editor_info[context]`, where context is *keymap*, *insert*, or Then add `$editor_info[context]`, where context is _keymap_, _insert_, or
*overwrite*, to `$PROMPT` or `$RPROMPT`. _overwrite_, to `$PROMPT` or `$RPROMPT`.
## Convenience Functions ## Convenience Functions
### bindkey-all ### bindkey-all
Provides a function `bindkey-all` which can be useful for checking how all of the Provides a function `bindkey-all` which can be useful for checking how all of
keys are bound. Normal `bindkey` command will only list the keys bound for one the keys are bound. Normal `bindkey` command will only list the keys bound for
keymap, which is not as useful if you want to grep through the output. The one keymap, which is not as useful if you want to grep through the output. The
keymap's names go to stderr so when you grep through bindkey-all's output you keymap's names go to stderr so when you grep through `bindkey-all`'s output you
will still see the headings and can tell which keymap each binding goes to. will still see the headings and can tell which keymap each binding goes to.
It will also pass through arguments so you can use bindkey-all to set bindings It will also pass through arguments so you can use bindkey-all to set bindings
for all keymaps at once. If provided arguments it will *not* print out the for all keymaps at once. If provided arguments it will _not_ print out the
names of each of the keymaps, and just run the command for each keymap. names of each of the keymaps, and just run the command for each keymap.
## Authors ## 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][1]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

2
modules/emacs/README.md
Unescape View File

@ -21,7 +21,7 @@ execution of `carton`.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sebastian Wiesner](https://github.com/lunaryorn) - [Sebastian Wiesner](https://github.com/lunaryorn)

9
modules/environment/README.md
Unescape View File

@ -6,9 +6,10 @@ This module must be loaded first.
## Contributors ## Contributors
This module **MUST NOT** rely on any command not built in Zsh. This module **MUST NOT** rely on any command that is not built in Zsh.
Non-interactive environment variables should be defined in [`zshenv`][1]. Non-interactive environment variables should be defined in
[_`${ZDOTDIR:-$HOME}/.zshenv`_][1].
## Options ## Options
@ -43,9 +44,9 @@ Non-interactive environment variables should be defined in [`zshenv`][1].
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/sorin-ionescu/prezto/blob/master/runcoms/zshenv [1]: ../../runcoms#zshenv
[2]: https://github.com/sorin-ionescu/prezto/issues [2]: https://github.com/sorin-ionescu/prezto/issues

9
modules/fasd/README.md
Unescape View File

@ -5,8 +5,8 @@
directories by keeping track of files and directories that were previously directories by keeping track of files and directories that were previously
accessed. accessed.
For completion to work, this module must be loaded **after** the *completion* For shell completion to work, this module must be loaded _after_ the
module. [_`completion`_][5] module.
The Prezto Fasd configuration differs from the default. The default aliases have The Prezto Fasd configuration differs from the default. The default aliases have
been disabled. been disabled.
@ -28,7 +28,7 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][5].* _The authors of this module should be contacted via the [issue tracker][6]._
- [Wei Dai](https://github.com/clvv) - [Wei Dai](https://github.com/clvv)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
@ -37,4 +37,5 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
[2]: https://github.com/joelthelion/autojump [2]: https://github.com/joelthelion/autojump
[3]: https://github.com/rupa/z [3]: https://github.com/rupa/z
[4]: https://github.com/rupa/v [4]: https://github.com/rupa/v
[5]: https://github.com/sorin-ionescu/prezto/issues [5]: ../completion#readme
[6]: https://github.com/sorin-ionescu/prezto/issues

132
modules/git/README.md
Unescape View File

@ -3,34 +3,42 @@
Enhances the [Git][1] distributed version control system by providing aliases, Enhances the [Git][1] distributed version control system by providing aliases,
functions and by exposing repository status information to prompts. functions and by exposing repository status information to prompts.
Git **1.7.2** is the [minimum required version][7]. This module must be loaded _before_ the [_`completion`_][13] module so that the
provided completion definitions are loaded automatically by _`completion`_
module.
**Note:** Git **1.7.2** is the [minimum required version][7].
## Settings ## Settings
### Log ### Log
The format of the [git-log][8] output is configurable via the following style, To configure the format of the [git-log][8] output, add the following to
where context is *brief*, *oneline*, and *medium*, which will be passed to the _`${ZDOTDIR:-$HOME}/.zpreztorc`_, and replace `'<context>'` with `'brief'`,
`--pretty=format:` switch. `'oneline'`, and `'medium'`. This will be passed to the `--pretty=format:`
switch.
```sh ```sh
zstyle ':prezto:module:git:log:context' format '' zstyle ':prezto:module:git:log:context' format '<context>'
``` ```
### Status ### Status
Retrieving the status of a repository with submodules can take a long time. Retrieving the status of a repository with [git-submodule][9] can take a long
Submodules may be ignored when they are *dirty*, *untracked*, *all*, or *none*. time. To configure the submodules to ignore, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_, and replace `'<state>'` with `'dirty'`,
`'untracked'`, `'all'`, or `'none'`.
```sh ```sh
zstyle ':prezto:module:git:status:ignore' submodules 'all' zstyle ':prezto:module:git:status:ignore' submodules '<state>'
``` ```
This setting affects all aliases and functions that call `git-status`. This setting affects all aliases and functions that call `git-status`.
## Aliases ## Aliases
Aliases are enabled by default. You can disable them with: Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:git:alias' skip 'yes' zstyle ':prezto:module:git:alias' skip 'yes'
@ -68,15 +76,15 @@ zstyle ':prezto:module:git:alias' skip 'yes'
- `gco` checks out a branch or paths to work tree. - `gco` checks out a branch or paths to work tree.
- `gcO` checks out hunks from the index or the tree interactively. - `gcO` checks out hunks from the index or the tree interactively.
- `gcf` amends the tip of the current branch using the same log message as - `gcf` amends the tip of the current branch using the same log message as
*HEAD*. _HEAD_.
- `gcSf` amends the tip of the current branch using the same log message as - `gcSf` amends the tip of the current branch using the same log message as
*HEAD*. (Signed) _HEAD_. (Signed)
- `gcF` amends the tip of the current branch. - `gcF` amends the tip of the current branch.
- `gcSF` amends the tip of the current branch. (Signed) - `gcSF` amends the tip of the current branch. (Signed)
- `gcp` applies changes introduced by existing commits. - `gcp` applies changes introduced by existing commits.
- `gcP` applies changes introduced by existing commits without committing. - `gcP` applies changes introduced by existing commits without committing.
- `gcr` reverts existing commits by reverting patches and recording new commits. - `gcr` reverts existing commits by reverting patches and recording new commits.
- `gcR` removes the *HEAD* commit. - `gcR` removes the _HEAD_ commit.
- `gcs` displays various types of objects. - `gcs` displays various types of objects.
- `gcsS` displays commits with GPG signature. - `gcsS` displays commits with GPG signature.
- `gcl` lists lost commits. - `gcl` lists lost commits.
@ -239,13 +247,13 @@ zstyle ':prezto:module:git:alias' skip 'yes'
- `gpa` updates remote branches along with associated objects. - `gpa` updates remote branches along with associated objects.
- `gpA` updates remote branches and tags along with associated objects. - `gpA` updates remote branches and tags along with associated objects.
- `gpt` updates remote tags along with associated objects. - `gpt` updates remote tags along with associated objects.
- `gpc` updates remote refs along with associated objects and adds *origin* as - `gpc` updates remote refs along with associated objects and adds _origin_ as
an upstream reference for the current branch. an upstream reference for the current branch.
- `gpp` pulls and pushes from origin to origin. - `gpp` pulls and pushes from origin to origin.
### Rebase (r) ### Rebase (r)
- `gr` forward-ports local commits to the updated upstream head. - `gr` forward-ports local commits to the updated upstream _HEAD_.
- `gra` aborts the rebase. - `gra` aborts the rebase.
- `grc` continues the rebase after merge conflicts are resolved. - `grc` continues the rebase after merge conflicts are resolved.
- `gri` makes a list of commits to be rebased and opens the editor. - `gri` makes a list of commits to be rebased and opens the editor.
@ -288,7 +296,7 @@ zstyle ':prezto:module:git:alias' skip 'yes'
- `gSl` lists the commits of all submodules. - `gSl` lists the commits of all submodules.
- `gSm` moves a submodule. - `gSm` moves a submodule.
- `gSs` synchronizes submodules' remote URL to the value specified in - `gSs` synchronizes submodules' remote URL to the value specified in
*.gitmodules*. _.gitmodules_.
- `gSu` fetches and merges the latest changes for all submodule. - `gSu` fetches and merges the latest changes for all submodule.
- `gSx` removes a submodule. - `gSx` removes a submodule.
@ -318,7 +326,7 @@ zstyle ':prezto:module:git:alias' skip 'yes'
The following aliases may shadow system commands: The following aliases may shadow system commands:
- `gb` shadows the [GB][9]. - `gb` shadows the [GB][10].
- `gm` shadows the [GraphicsMagick image processor][11]. - `gm` shadows the [GraphicsMagick image processor][11].
- `gpt` shadows the [GUID partition table maintenance utility][4]. - `gpt` shadows the [GUID partition table maintenance utility][4].
- `gs` shadows the [Ghostscript interpreter and previewer][5]. - `gs` shadows the [Ghostscript interpreter and previewer][5].
@ -335,7 +343,7 @@ You can temporarily bypass an alias by prefixing it with a backward slash:
- `git-commit-lost` lists lost commits. - `git-commit-lost` lists lost commits.
- `git-dir` displays the path to the Git directory. - `git-dir` displays the path to the Git directory.
- `git-hub-browse` opens the [GitHub][3] repository in the default browser. - `git-hub-browse` opens the [GitHub][3] repository in the default browser.
- `git-hub-shorten-url` shortens [GitHub URLs][10]. - `git-hub-shorten-url` shortens [GitHub URLs][12].
- `git-info` exposes repository information via the `$git_info` associative - `git-info` exposes repository information via the `$git_info` associative
array. array.
- `git-root` displays the path to the working tree root. - `git-root` displays the path to the working tree root.
@ -357,26 +365,26 @@ zstyle ':prezto:module:git:info:context:subcontext' format 'string'
### Main Contexts ### Main Contexts
| Name | Format Code | Description | Name | Format Code | Description |
| --------- | :---------: | ---------------------------------------------------- | -------- | :---------: | ---------------------------------- |
| action | %s | Special action name | action | %s | Special action name |
| ahead | %A | Commits ahead of remote count | ahead | %A | Commits ahead of remote count |
| behind | %B | Commits behind of remote count | behind | %B | Commits behind of remote count |
| branch | %b | Branch name | branch | %b | Branch name |
| commit | %c | Commit hash | commit | %c | Commit hash |
| position | %p | Commits from the nearest tag count | position | %p | Commits from the nearest tag count |
| remote | %R | Remote name | remote | %R | Remote name |
| stashed | %S | Stashed states count | stashed | %S | Stashed states count |
### Concise Contexts ### Concise Contexts
| Name | Format Code | Description | Name | Format Code | Description |
| --------- | :---------: | ---------------------------------------------------- | --------- | :---------: | --------------------- |
| clean | %C | Clean state | clean | %C | Clean state |
| dirty | %D | Dirty files count | dirty | %D | Dirty files count |
| indexed | %i | Indexed files count | indexed | %i | Indexed files count |
| unindexed | %I | Unindexed files count | unindexed | %I | Unindexed files count |
| untracked | %u | Untracked files count | untracked | %u | Untracked files count |
The following contexts must be enabled with the following zstyle: The following contexts must be enabled with the following zstyle:
@ -386,31 +394,31 @@ zstyle ':prezto:module:git:info' verbose 'yes'
### Verbose Contexts ### Verbose Contexts
| Name | Format Code | Description | Name | Format Code | Description |
| --------- | :---------: | ---------------------------------------------------- | --------- | :---------: | --------------------- |
| added | %a | Added files count | added | %a | Added files count |
| clean | %C | Clean state | clean | %C | Clean state |
| deleted | %d | Deleted files count | deleted | %d | Deleted files count |
| dirty | %D | Dirty files count | dirty | %D | Dirty files count |
| modified | %m | Modified files count | modified | %m | Modified files count |
| renamed | %r | Renamed files count | renamed | %r | Renamed files count |
| unmerged | %U | Unmerged files count | unmerged | %U | Unmerged files count |
| untracked | %u | Untracked files count | untracked | %u | Untracked files count |
### Special Action Contexts ### Special Action Contexts
| Name | Format | Description | Name | Format | Description |
| -------------------- | :---------: | ----------------------------------------- | -------------------- | :----: | ---------------------------- |
| apply | value | Applying patches | apply | value | Applying patches |
| bisect | value | Binary searching for changes | bisect | value | Binary searching for changes |
| cherry-pick | value | Cherry picking | cherry-pick | value | Cherry picking |
| cherry-pick-sequence | value | Cherry picking sequence | cherry-pick-sequence | value | Cherry picking sequence |
| merge | value | Merging | merge | value | Merging |
| rebase | value | Rebasing | rebase | value | Rebasing |
| rebase-interactive | value | Rebasing interactively | rebase-interactive | value | Rebasing interactively |
| rebase-merge | value | Rebasing merge | rebase-merge | value | Rebasing merge |
| revert | value | Reverting | revert | value | Reverting |
| revert-sequence | value | Reverting sequence | revert-sequence | value | Reverting sequence |
First, format the repository state attributes. For example, to format the branch First, format the repository state attributes. For example, to format the branch
and remote names, define the following styles. and remote names, define the following styles.
@ -434,19 +442,21 @@ function.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][6].* _The authors of this module should be contacted via the [issue tracker][6]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Colin Hebert](https://github.com/ColinHebert) - [Colin Hebert](https://github.com/ColinHebert)
[1]: https://www.git-scm.com [1]: https://www.git-scm.com
[2]: https://github.com/defunkt/hub [2]: https://hub.github.com
[3]: https://www.github.com [3]: https://www.github.com
[4]: https://www.manpagez.com/man/8/gpt/ [4]: https://www.manpagez.com/man/8/gpt/
[5]: https://www.manpagez.com/man/1/gs/ [5]: https://www.manpagez.com/man/1/gs/
[6]: https://github.com/sorin-ionescu/prezto/issues [6]: https://github.com/sorin-ionescu/prezto/issues
[7]: https://github.com/sorin-ionescu/prezto/issues/219 [7]: https://github.com/sorin-ionescu/prezto/issues/219
[8]: https://www.kernel.org/pub/software/scm/git/docs/git-log.html [8]: https://git-scm.com/docs/git-log
[9]: https://getgb.io/ [9]: https://git-scm.com/docs/git-submodule
[10]: https://github.com/blog/985-git-io-github-url-shortener [10]: https://getgb.io/
[11]: https://www.manpagez.com/man/1/gm/ [11]: https://www.manpagez.com/man/1/gm/
[12]: https://github.blog/2011-11-10-git-io-github-url-shortener
[13]: ../completion#readme

13
modules/gnu-utility/README.md
Unescape View File

@ -9,14 +9,16 @@ utilities will be broken.
This module wraps GNU utilities in functions without a prefix for interactive This module wraps GNU utilities in functions without a prefix for interactive
use. use.
This module must be loaded **before** the *utility* module. This module must be loaded _before_ the [_`utility`_][1] module so that GNU
utilities enabled in this module are available for configuration in _`utility`_
module.
## Settings ## Settings
### Prefix ### Prefix
To use a different prefix, add the following to *~/.zpreztorc*, and replace 'g' To use a different prefix, add the following to
with the desired prefix: _`${ZDOTDIR:-$HOME}/.zpreztorc`_, and replace `'g'` with the desired prefix.
```sh ```sh
zstyle ':prezto:module:gnu-utility' prefix 'g' zstyle ':prezto:module:gnu-utility' prefix 'g'
@ -24,8 +26,9 @@ zstyle ':prezto:module:gnu-utility' prefix 'g'
## Authors ## 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][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/sorin-ionescu/prezto/issues [1]: ../utility#readme
[2]: https://github.com/sorin-ionescu/prezto/issues

4
modules/gpg/README.md
Unescape View File

@ -8,7 +8,7 @@ Provides for an easier use of [GPG][1] by setting up [gpg-agent][2].
To enable OpenSSH Agent protocol emulation, and make `gpg-agent` a drop-in To enable OpenSSH Agent protocol emulation, and make `gpg-agent` a drop-in
replacement for `ssh-agent`, add the following line to replacement for `ssh-agent`, add the following line to
*`~/.gnupg/gpg-agent.conf`*: _`$GNUPGHOME/gpg-agent.conf`_ or _`$$HOME/.gnupg/gpg-agent.conf`_:
```conf ```conf
enable-ssh-support enable-ssh-support
@ -19,7 +19,7 @@ module for additional processing.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][3]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

2
modules/haskell/README.md
Unescape View File

@ -17,7 +17,7 @@ Install packages into per user directories with `cabal install --user`.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sebastian Wiesner](https://github.com/lunaryorn) - [Sebastian Wiesner](https://github.com/lunaryorn)

2
modules/helper/README.md
Unescape View File

@ -19,7 +19,7 @@ Provides helper functions for developing modules.
## Authors ## 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][1]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

28
modules/history-substring-search/README.md
Unescape View File

@ -5,8 +5,8 @@ Integrates [`zsh-history-substring-search`][1] into Prezto, which implements the
a previously entered command and press up and down to cycle through matching a previously entered command and press up and down to cycle through matching
commands. commands.
If this module is used in conjunction with the *syntax-highlighting* module, If this module is used in conjunction with the [_`syntax-highlighting`_][3]
this module must be loaded **after** the *syntax-highlighting* module. module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
## Contributors ## Contributors
@ -19,7 +19,7 @@ regulations. This module will be synchronized against it.
### Case Sensitivity ### Case Sensitivity
To enable case-sensitivity for this module only, add the following line to To enable case-sensitivity for this module only, add the following line to
*~/.zpreztorc*: _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:history-substring-search' case-sensitive 'yes' zstyle ':prezto:module:history-substring-search' case-sensitive 'yes'
@ -27,29 +27,32 @@ zstyle ':prezto:module:history-substring-search' case-sensitive 'yes'
### Highlighting ### Highlighting
If colors are enabled, *history-substring-search* will automatically highlight If colors are enabled, _history-substring-search_ will automatically highlight
positive results. positive results.
To enable highlighting for this module only, add the following line to To disable highlighting for this module only, add the following line to
*~/.zpreztorc*: _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:history-substring-search' color 'yes' zstyle ':prezto:module:history-substring-search' color 'no'
``` ```
To set the query found color, add the following line to *~/.zpreztorc*: To set the query found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:history-substring-search:color' found '' zstyle ':prezto:module:history-substring-search:color' found ''
``` ```
To set the query not found color, add the following line to *~/.zpreztorc*: To set the query not found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:history-substring-search:color' not-found '' zstyle ':prezto:module:history-substring-search:color' not-found ''
``` ```
To set the search globbing flags, add the following line to *~/.zpreztorc*: To set the search globbing flags, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:history-substring-search' globbing-flags '' zstyle ':prezto:module:history-substring-search' globbing-flags ''
@ -57,11 +60,12 @@ zstyle ':prezto:module:history-substring-search' globbing-flags ''
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][4]._
- [Suraj N. Kurapati](https://github.com/sunaku) - [Suraj N. Kurapati](https://github.com/sunaku)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/zsh-users/zsh-history-substring-search [1]: https://github.com/zsh-users/zsh-history-substring-search
[2]: https://fishshell.com [2]: https://fishshell.com
[3]: https://github.com/sorin-ionescu/prezto/issues [3]: ../syntax-highlighting#readme
[4]: https://github.com/sorin-ionescu/prezto/issues

20
modules/history/README.md
Unescape View File

@ -2,24 +2,26 @@
Sets [history][1] options and defines history aliases. Sets [history][1] options and defines history aliases.
**Note:** Default path of `HISTFILE` has changed from *`${ZDOTDIR:-$HOME}/.zhistory`* **Note:** Default path of `HISTFILE` has changed from
to *`${ZDOTDIR:-$HOME}/.zsh_history`*. The file will be automatically renamed if _`${ZDOTDIR:-$HOME}/.zhistory`_ to _`${ZDOTDIR:-$HOME}/.zsh_history`_. The file
possible (when the new one doesn't exist). Otherwise, if you want to preserve will be automatically renamed if possible (when the new one doesn't exist).
previous history, you will need to move them from *`${ZDOTDIR:-$HOME}/.zhistory`* Otherwise, if you want to preserve previous history, you will need to move them
to *`${ZDOTDIR:-$HOME}/.zsh_history`*. from _`${ZDOTDIR:-$HOME}/.zhistory`_ to _`${ZDOTDIR:-$HOME}/.zsh_history`_.
Alternately, you can set `HISTFILE` manually to *`${ZDOTDIR:-$HOME}/.zhistory`*. Alternately, you can set `HISTFILE` manually to _`${ZDOTDIR:-$HOME}/.zhistory`_.
## Options ## Options
- `BANG_HIST` treats the **!** character specially during expansion. - `BANG_HIST` treats the **!** character specially during expansion.
- `EXTENDED_HISTORY` writes the history file in the *:start:elapsed;command* format. - `EXTENDED_HISTORY` writes the history file in the _:start:elapsed;command_
format.
- `SHARE_HISTORY` shares history between all sessions. Note that - `SHARE_HISTORY` shares history between all sessions. Note that
`SHARE_HISTORY`, `INC_APPEND_HISTORY`, and `INC_APPEND_HISTORY_TIME` are `SHARE_HISTORY`, `INC_APPEND_HISTORY`, and `INC_APPEND_HISTORY_TIME` are
mutually exclusive. mutually exclusive.
- `HIST_EXPIRE_DUPS_FIRST` expires a duplicate event first when trimming history. - `HIST_EXPIRE_DUPS_FIRST` expires a duplicate event first when trimming history.
- `HIST_IGNORE_DUPS` does not record an event that was just recorded again. - `HIST_IGNORE_DUPS` does not record an event that was just recorded again.
- `HIST_IGNORE_ALL_DUPS` deletes an old recorded event if a new event is a duplicate. - `HIST_IGNORE_ALL_DUPS` deletes an old recorded event if a new event is a
duplicate.
- `HIST_FIND_NO_DUPS` does not display a previously found event. - `HIST_FIND_NO_DUPS` does not display a previously found event.
- `HIST_IGNORE_SPACE` does not record an event starting with a space. - `HIST_IGNORE_SPACE` does not record an event starting with a space.
- `HIST_SAVE_NO_DUPS` does not write a duplicate event to the history file. - `HIST_SAVE_NO_DUPS` does not write a duplicate event to the history file.
@ -38,7 +40,7 @@ Alternately, you can set `HISTFILE` manually to *`${ZDOTDIR:-$HOME}/.zhistory`*.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Robby Russell](https://github.com/robbyrussell) - [Robby Russell](https://github.com/robbyrussell)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

2
modules/homebrew/README.md
Unescape View File

@ -35,7 +35,7 @@ brew shellenv
## Authors ## 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][1]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Griffin Yourick](https://github.com/tough-griff) - [Griffin Yourick](https://github.com/tough-griff)

2
modules/macports/README.md
Unescape View File

@ -14,7 +14,7 @@ Defines MacPorts aliases and adds MacPorts directories to path variables.
## Authors ## 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][1]._
- [Matt Cable](https://github.com/curiousstranger) - [Matt Cable](https://github.com/curiousstranger)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

14
modules/node/README.md
Unescape View File

@ -1,24 +1,24 @@
# Node.js # Node.js
Provides utility functions for [Node.js][1], loads the Node Version Manager, and Provides utility functions for [Node.js][1], loads the Node Version Manager, and
enables [*npm*][2] completion. enables [_npm_][2] completion.
## nvm ## nvm
[*nvm*][5] allows for managing multiple, isolated Node.js installations in the [_nvm_][5] allows for managing multiple, isolated Node.js installations in the
home directory. home directory.
This will be loaded automatically if nvm is installed in `$NVM_DIR`, This will be loaded automatically if nvm is installed in `$NVM_DIR`,
*~/.nvm*, or nvm is installed with homebrew. _`~/.nvm`_, or nvm is installed with Homebrew.
## nodenv ## nodenv
[*nodenv*][6] does one thing well - it is concerned solely with switching [_nodenv_][6] does one thing well - it is concerned solely with switching
Node versions. It is simple and predictable, Just Works, and is rock solid in Node versions. It is simple and predictable, Just Works, and is rock solid in
production. nodenv is forked from the popular [*rbenv*][7]. production. nodenv is forked from the popular [_rbenv_][7].
This will be loaded automatically if nodenv is installed in `$NODENV_ROOT`, This will be loaded automatically if nodenv is installed in `$NODENV_ROOT`,
*~/.nodenv*, or `nodenv` is on the path. _`~/.nodenv`_, or `nodenv` is on the path.
## Functions ## Functions
@ -42,7 +42,7 @@ Then add `$node_info[version]` to either `$PROMPT` or `$RPROMPT` and call
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][4].* _The authors of this module should be contacted via the [issue tracker][4]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Zeh Rizzatti](https://github.com/zehrizzatti) - [Zeh Rizzatti](https://github.com/zehrizzatti)

2
modules/ocaml/README.md
Unescape View File

@ -15,7 +15,7 @@ Install packages to your local package directory with `opam install`.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][3]._
- [Sebastian Wiesner](https://github.com/lunaryorn) - [Sebastian Wiesner](https://github.com/lunaryorn)

36
modules/osx/README.md
Unescape View File

@ -2,13 +2,18 @@
Defines [macOS][1] aliases and functions. Defines [macOS][1] aliases and functions.
This module must be loaded _before_ the [_`completion`_][2] module so that the
provided completion definitions are loaded automatically by _`completion`_
module.
## Settings ## Settings
### Dash Keyword ### Dash Keyword
To change the keyword used by `mand` to open man pages in [*Dash.app*][2] from To change the keyword used by `mand` to open man pages in [_Dash.app_][3] from
its default value of 'manpages', add the following line in *~/.zpreztorc* and its default value of 'manpages', add the following line in
replace the **keyword** with the one configured in [*Dash.app*][2]. _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and replace the **keyword** with the one
configured in [_Dash.app_][3].
```sh ```sh
zstyle ':prezto:module:osx:man' dash-keyword 'keyword' zstyle ':prezto:module:osx:man' dash-keyword 'keyword'
@ -16,29 +21,30 @@ zstyle ':prezto:module:osx:man' dash-keyword 'keyword'
## Aliases ## Aliases
- `cdf` changes the current working director to the current *Finder* directory. - `cdf` changes the current working director to the current _Finder_ directory.
- `pushdf` pushes the current working directory onto the directory queue and - `pushdf` pushes the current working directory onto the directory queue and
changes the current working director to the current *Finder* directory. changes the current working director to the current _Finder_ directory.
## Functions ## Functions
- `mand` opens _man_ pages in [*Dash.app*][2]. - `mand` opens _man_ pages in [_Dash.app_][3].
- `manp` opens _man_ pages in *Preview.app*. - `manp` opens _man_ pages in _Preview.app_.
- `pfd` prints the current *Finder* directory. - `pfd` prints the current _Finder_ directory.
- `pfs` prints the current *Finder* selection. - `pfs` prints the current _Finder_ selection.
- `tab` creates a new tab (works in both _Terminal_ and [*iTerm.app*][3]). - `tab` creates a new tab (works in both _Terminal_ and [_iTerm.app_][4]).
- `ql` previews files in Quick Look. - `ql` previews files in Quick Look.
- `osx-rm-dir-metadata` deletes *.DS_Store*, *__MACOSX* cruft. - `osx-rm-dir-metadata` deletes _`.DS_Store`_, _`__MACOSX`_ cruft.
- `osx-ls-download-history` displays the macOS download history. - `osx-ls-download-history` displays the macOS download history.
- `osx-rm-download-history` deletes the macOS download history. - `osx-rm-download-history` deletes the macOS download history.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][4].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://www.apple.com/macos/ [1]: https://www.apple.com/macos/
[2]: https://kapeli.com/dash [2]: ../completion#readme
[3]: https://www.iterm2.com/ [3]: https://kapeli.com/dash
[4]: https://github.com/sorin-ionescu/prezto/issues [4]: https://www.iterm2.com/
[5]: https://github.com/sorin-ionescu/prezto/issues

9
modules/pacman/README.md
Unescape View File

@ -15,11 +15,12 @@ supported by Archlinux. It is currently recommended to manually build AUR
packages using the [provided instructions][3]. The [aurutils][4] project has a packages using the [provided instructions][3]. The [aurutils][4] project has a
set of small utilities to make this easier. set of small utilities to make this easier.
To enable a Pacman frontend, add the following line to *~/.zpreztorc*, To enable a different Pacman frontend, add the following to
substituting *pacman_frontend* with the name of the frontend: _`${ZDOTDIR:-$HOME}/.zpreztorc`_, and replace `'<frontend>'` with the name
of the preferred frontend.
```sh ```sh
zstyle ':prezto:module:pacman' frontend 'pacman_frontend' zstyle ':prezto:module:pacman' frontend '<frontend>'
``` ```
## Aliases ## Aliases
@ -52,7 +53,7 @@ zstyle ':prezto:module:pacman' frontend 'pacman_frontend'
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][5].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Benjamin Boudreau](https://github.com/dreur) - [Benjamin Boudreau](https://github.com/dreur)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

12
modules/perl/README.md
Unescape View File

@ -6,11 +6,11 @@ Enables local [Perl][1] module installation on macOS and defines aliases.
Perl versions older than 5.14 do not support the local installation of Perl Perl versions older than 5.14 do not support the local installation of Perl
modules natively. This module allows for local installation of Perl modules on modules natively. This module allows for local installation of Perl modules on
macOS in *`~/Library/Perl/5.12`* by altering the environment. macOS in _`~/Library/Perl/5.12`_ by altering the environment.
### Usage ### Usage
For Perl versions older than 5.14, install *`local::lib`*. For Perl versions older than 5.14, install _`local::lib`_.
```console ```console
curl -L -C - -O http://search.cpan.org/CPAN/authors/id/A/AP/APEIRON/local-lib-1.008004.tar.gz curl -L -C - -O http://search.cpan.org/CPAN/authors/id/A/AP/APEIRON/local-lib-1.008004.tar.gz
@ -20,7 +20,7 @@ perl Makefile.PL --bootstrap=$HOME/Library/Perl/5.12
make && make test && make install make && make test && make install
``` ```
Install *cpanminus*: Install _cpanminus_:
```console ```console
curl -L http://cpanmin.us | perl - --self-upgrade curl -L http://cpanmin.us | perl - --self-upgrade
@ -33,10 +33,10 @@ management of multiple, isolated Perl installations in the home directory.
## plenv ## plenv
Yet another alternative is [*plenv*][3]. This is inspired from *rbenv* and Yet another alternative is [_plenv_][3]. This is inspired from _rbenv_ and
enables switching between multiple binary installations. enables switching between multiple binary installations.
The subcommands of *plenv* is similar with *rbenv*. The subcommands of _plenv_ is similar with _rbenv_.
## Aliases ## Aliases
@ -96,7 +96,7 @@ Then add `$perl_info[version]` to `$PROMPT` or `$RPROMPT` and call
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][4].* _The authors of this module should be contacted via the [issue tracker][4]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

18
modules/prompt/README.md
Unescape View File

@ -6,19 +6,19 @@ Loads prompt [themes][1].
### Prompt Theme ### Prompt Theme
To select a prompt theme, add the following to *~/.zpreztorc*, and replace To select a prompt theme, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_,
**name** with the name of the theme you wish to load. Setting it to **random** and replace `'<name>'` with the name of the theme you wish to load. Setting it
will load a random theme. to `'random'` will load a random theme every time.
```sh ```sh
zstyle ':prezto:module:prompt' theme 'name' zstyle ':prezto:module:prompt' theme '<name>'
``` ```
### Prompt Display Length ### Prompt Display Length
To change working directory prompt display length from 'short', set the To change working directory prompt display length from 'short', set the
following to 'long' (without `~` expansion) or 'full' (with `~` expansion) in following to 'long' (without `~` expansion) or 'full' (with `~` expansion) in
*~/.zpreztorc*. _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:prompt' pwd-length 'short' zstyle ':prezto:module:prompt' pwd-length 'short'
@ -37,13 +37,13 @@ zstyle ':prezto:module:prompt' show-return-val 'no'
A prompt theme is an autoloadable function file with a special name, A prompt theme is an autoloadable function file with a special name,
`prompt_name_setup`, placed anywhere in `$fpath`, but for the purpose of this `prompt_name_setup`, placed anywhere in `$fpath`, but for the purpose of this
project, themes **should** be placed in the *modules/prompt/functions* project, themes **should** be placed in the _modules/prompt/functions_
directory. directory.
### Required Variables ### Required Variables
To ensure that your function works with the editor-info module you'll need to To ensure that your function works with the editor-info module you'll need to
set the following variable in *~/.zpreztorc*: set the following variable in _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
# Tell prezto we can manage this prompt # Tell prezto we can manage this prompt
@ -119,7 +119,7 @@ function prompt_name_preview {
### Hook Functions ### Hook Functions
There are many Zsh [hook][2] functions, but mostly the *precmd* hook will be There are many Zsh [hook][2] functions, but mostly the _precmd_ hook will be
used. used.
#### `prompt_name_precmd` #### `prompt_name_precmd`
@ -156,7 +156,7 @@ patched fonts][5] which should fix most font issues.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][3]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

6
modules/prompt/functions/prompt_cloud_setup
Unescape View File

@ -9,7 +9,7 @@
# - The prompt is prefixed by a character sequence of your choice. # - The prompt is prefixed by a character sequence of your choice.
# - Only displays the current directory instead of the full path. # - Only displays the current directory instead of the full path.
# - Displays the current branch when in a git project (this requires loading # - Displays the current branch when in a git project (this requires loading
# the git module before prompt in ~/.zpreztorc). # the git module before prompt in ${ZDOTDIR:-$HOME}/.zpreztorc).
# - Displays a character at the end of the prompt when in a git project with # - Displays a character at the end of the prompt when in a git project with
# "dirty" files. # "dirty" files.
# #
@ -17,7 +17,7 @@
# This prompt's prefix symbol and colors are customizable: # This prompt's prefix symbol and colors are customizable:
# prompt cloud [<symbol>] [<color1>] [<color2>] # prompt cloud [<symbol>] [<color1>] [<color2>]
# #
# In ~/.zpreztorc: # In ${ZDOTDIR:-$HOME}/.zpreztorc:
# zstyle ':prezto:module:prompt' theme 'cloud' \ # zstyle ':prezto:module:prompt' theme 'cloud' \
# ['<symbol>'] \ # ['<symbol>'] \
# ['<color1>'] \ # ['<color1>'] \
@ -53,7 +53,7 @@ This prompt's prefix symbol and colors are customizable:
prompt cloud [<symbol>] [<color1>] [<color2>] prompt cloud [<symbol>] [<color1>] [<color2>]
In ~/.zpreztorc: In ${ZDOTDIR:-$HOME}/.zpreztorc:
zstyle ':prezto:module:prompt' theme 'cloud' ['<symbol>'] ['<color1>'] ['<color2>'] zstyle ':prezto:module:prompt' theme 'cloud' ['<symbol>'] ['<color1>'] ['<color2>']
If these options are not provided, the symbol defaults to ☁ with colors cyan If these options are not provided, the symbol defaults to ☁ with colors cyan

2
modules/prompt/init.zsh
Unescape View File

@ -18,7 +18,7 @@ WARNING: Prezto does not support 'powerlevel9k' anymore as it has
been deprecated and is not supported by its author. been deprecated and is not supported by its author.
Consider migrating to 'powerlevel10k' instead by setting: Consider migrating to 'powerlevel10k' instead by setting:
zstyle ':prezto:module:prompt' theme 'powerlevel10k' zstyle ':prezto:module:prompt' theme 'powerlevel10k'
in ~/.zpreztorc. in ${${ZDOTDIR:-$HOME}/#$HOME/~}/.zpreztorc.
Switching to prezto default prompt 'sorin'..." Switching to prezto default prompt 'sorin'..."
EOW EOW
prompt 'sorin' prompt 'sorin'

31
modules/python/README.md
Unescape View File

@ -5,14 +5,16 @@ Enables local Python and local Python package installation.
## Settings ## Settings
This module supports virtual environments from conda and This module supports virtual environments from conda and
[*virtualenvwrapper*][2]. By default, only *virtualenvwrapper* is enabled. To [_virtualenvwrapper_][2]. By default, only _virtualenvwrapper_ is enabled. To
disable *virtualenvwrapper*, add the following to *~/.zpreztorc*. disable _virtualenvwrapper_, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on' zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on'
``` ```
Conda support is enabled by adding the following to *~/.zpreztorc*. Conda support can be enabled by adding the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:python' conda-init 'on' zstyle ':prezto:module:python' conda-init 'on'
@ -22,18 +24,18 @@ Caution: using conda and virtualenvwrapper at the same time may cause conflicts.
## Local Python Installation ## Local Python Installation
[*pyenv*][4] builds and installs multiple Python versions locally in the home [_pyenv_][4] builds and installs multiple Python versions locally in the home
directory. directory.
This module prepends the *pyenv* directory to the path variable to enable the This module prepends the _pyenv_ directory to the path variable to enable the
execution of `pyenv`. execution of `pyenv`.
### Usage ### Usage
Install Python versions with `pyenv install` into *~/.pyenv/versions*. Install Python versions with `pyenv install` into _`~/.pyenv/versions`_.
This will be loaded automatically if pyenv is installed to `$PYENV_ROOT`, This will be loaded automatically if pyenv is installed to `$PYENV_ROOT`,
*~/.pyenv*, or if the `pyenv` command is on the path. _`~/.pyenv`_, or if the `pyenv` command is on the path.
## Local Package Installation ## Local Package Installation
@ -50,7 +52,7 @@ Install packages into the per user site directory with `pip install --user`.
## virtualenvwrapper ## virtualenvwrapper
[*virtualenvwrapper*][2] is a frontend to the popular [*virtualenv*][3] utility. [_virtualenvwrapper_][2] is a frontend to the popular [_virtualenv_][3] utility.
`virtualenv` creates isolated Python environments and `virtualenvwrapper` `virtualenv` creates isolated Python environments and `virtualenvwrapper`
provides convenient shell functions to create, switch, and manage them. provides convenient shell functions to create, switch, and manage them.
@ -59,14 +61,15 @@ provides convenient shell functions to create, switch, and manage them.
Install `virtualenvwrapper`. Install `virtualenvwrapper`.
Virtual environments are stored in *~/.virtualenvs*. Virtual environments are stored in _`~/.virtualenvs`_.
There are configuration variables that have to be set to enable certain features. There are configuration variables that have to be set to enable certain
If you wish to use these features, export the variables in [`zshenv`][6]. features. If you wish to use these features, export the variables in
[_`${ZDOTDIR:-$HOME}/.zshenv`_][6].
The variable `$PROJECT_HOME` tells `virtualenvwrapper` where to place project The variable `$PROJECT_HOME` tells `virtualenvwrapper` where to place project
working directories. It must be set and the directory created before `mkproject` working directories. It must be set and the directory created before `mkproject`
is used. Replace *Developer* with your projects directory. is used. Replace _Developer_ with your projects directory.
```sh ```sh
export PROJECT_HOME="$HOME/Developer" export PROJECT_HOME="$HOME/Developer"
@ -144,7 +147,7 @@ python version/
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][5].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Sebastian Wiesner](https://github.com/lunaryorn) - [Sebastian Wiesner](https://github.com/lunaryorn)
@ -154,4 +157,4 @@ python version/
[3]: https://pypi.org/project/virtualenv/ [3]: https://pypi.org/project/virtualenv/
[4]: https://github.com/yyuu/pyenv [4]: https://github.com/yyuu/pyenv
[5]: https://github.com/sorin-ionescu/prezto/issues [5]: https://github.com/sorin-ionescu/prezto/issues
[6]: https://github.com/sorin-ionescu/prezto/blob/master/runcoms/zshenv [6]: ../../runcoms#zshenv

2
modules/rails/README.md
Unescape View File

@ -21,7 +21,7 @@ Defines [Ruby on Rails][1] aliases.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Robby Russell](https://github.com/robbyrussell) - [Robby Russell](https://github.com/robbyrussell)
- [Jake Bell](https://github.com/theunraveler) - [Jake Bell](https://github.com/theunraveler)

14
modules/rsync/README.md
Unescape View File

@ -2,20 +2,20 @@
Defines [rsync][1] aliases. Defines [rsync][1] aliases.
macOS users are encouraged to use *rsync* from [Homebrew][2] or [MacPorts][3], macOS users are encouraged to use _rsync_ from [Homebrew][2] or [MacPorts][3],
which has additional enhancements including patches from [Bombich][4]. which has additional enhancements including patches from [Bombich][4].
## Aliases ## Aliases
- `rsync-copy` copies files and directories from *source* to *destination*. - `rsync-copy` copies files and directories from _source_ to _destination_.
- `rsync-move` moves files and directories from *source* to *destination*. - `rsync-move` moves files and directories from _source_ to _destination_.
- `rsync-update` updates files and directories on *destination*. - `rsync-update` updates files and directories on _destination_.
- `rsync-synchronize` synchronizes files and directories between *source* and - `rsync-synchronize` synchronizes files and directories between _source_ and
*destination*. _destination_.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][5].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

18
modules/ruby/README.md
Unescape View File

@ -6,11 +6,11 @@ aliases.
## Local Gem Installation ## Local Gem Installation
When a Ruby version manager is not detected, local gems are installed in When a Ruby version manager is not detected, local gems are installed in
*~/.gems*; otherwise, they are installed according to the manager. _`~/.gems`_; otherwise, they are installed according to the manager.
## rvm ## rvm
An alternative to the above is to use [The Ruby Version Manager (*rvm*)][2], An alternative to the above is to use [The Ruby Version Manager (_rvm_)][2],
which allows for managing multiple, isolated Ruby installations and gem sets in which allows for managing multiple, isolated Ruby installations and gem sets in
the home directory. the home directory.
@ -22,26 +22,26 @@ it is not first in `$PATH`.
## rbenv ## rbenv
An alternative RVM is to use [*rbenv*][3], which allows for switching between An alternative RVM is to use [_rbenv_][3], which allows for switching between
multiple, isolated Ruby installations in the home directory. multiple, isolated Ruby installations in the home directory.
While it is not as feature rich as RVM, it is not loaded into the shell and is While it is not as feature rich as RVM, it is not loaded into the shell and is
not known to cause conflicts with shell scripts. not known to cause conflicts with shell scripts.
This will be loaded automatically if *rbenv* is installed to `$RBENV_ROOT`, This will be loaded automatically if _rbenv_ is installed to `$RBENV_ROOT`,
*~/.rbenv*, or if the `rbenv` command is on the path. _`~/.rbenv`_, or if the `rbenv` command is on the path.
## chruby ## chruby
Yet another alternative is [*chruby*][4], which is simpler than both *rvm* and Yet another alternative is [_chruby_][4], which is simpler than both _rvm_ and
*rbenv*. _rbenv_.
### Settings ### Settings
#### Auto-Switch #### Auto-Switch
To enable auto switching the Ruby version on directory change based on the To enable auto switching the Ruby version on directory change based on the
`.ruby-version` file, add the following line to *~/.zpreztorc*: `.ruby-version` file, add the following line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:ruby:chruby' auto-switch 'yes' zstyle ':prezto:module:ruby:chruby' auto-switch 'yes'
@ -94,7 +94,7 @@ Then add `$ruby_info[version]` to `$PROMPT` or `$RPROMPT` and call
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][6].* _The authors of this module should be contacted via the [issue tracker][6]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

6
modules/screen/README.md
Unescape View File

@ -9,14 +9,14 @@ Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
Starts a GNU Screen session automatically when Zsh is launched. Starts a GNU Screen session automatically when Zsh is launched.
To enable this feature when launching Zsh in a local terminal, add the following To enable this feature when launching Zsh in a local terminal, add the following
line to *~/.zpreztorc*: line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:screen:auto-start' local 'yes' zstyle ':prezto:module:screen:auto-start' local 'yes'
``` ```
To enable this feature when launching Zsh in a SSH connection, add the following To enable this feature when launching Zsh in a SSH connection, add the following
line to *~/.zpreztorc*: line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:screen:auto-start' remote 'yes' zstyle ':prezto:module:screen:auto-start' remote 'yes'
@ -31,7 +31,7 @@ zstyle ':prezto:module:screen:auto-start' remote 'yes'
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Georges Discry](https://github.com/gdiscry) - [Georges Discry](https://github.com/gdiscry)

2
modules/spectrum/README.md
Unescape View File

@ -79,7 +79,7 @@ Use `$BG[none]`, `$FG[none]`, or `$FX[none]` to turn off formatting.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [P.C. Shyamshankar](https://github.com/sykora) - [P.C. Shyamshankar](https://github.com/sykora)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

7
modules/ssh/README.md
Unescape View File

@ -1,12 +1,13 @@
# SSH # SSH
Provides for an easier use of [SSH][1] by setting up [*ssh-agent*][2]. Provides for an easier use of [SSH][1] by setting up [_ssh-agent_][2].
## Settings ## Settings
### Identities ### Identities
To load multiple identities, add the following line to *~/.zpreztorc*: To load multiple identities, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:ssh:load' identities 'id_rsa' 'id_dsa' 'id_github' zstyle ':prezto:module:ssh:load' identities 'id_rsa' 'id_dsa' 'id_github'
@ -14,7 +15,7 @@ zstyle ':prezto:module:ssh:load' identities 'id_rsa' 'id_dsa' 'id_github'
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][3]._
[Sorin Ionescu](https://github.com/sorin-ionescu) [Sorin Ionescu](https://github.com/sorin-ionescu)

28
modules/syntax-highlighting/README.md
Unescape View File

@ -2,14 +2,14 @@
Integrates [zsh-syntax-highlighting][1] into Prezto. Integrates [zsh-syntax-highlighting][1] into Prezto.
This module should be loaded before the *prompt* module. This module must be loaded _before_ the _`prompt`_ module.
Additionally, if this module is used in conjunction with the Additionally, if this module is used in conjunction with the
*history-substring-search* module, this module must be loaded **before** the [_`history-substring-search`_][2] module, this module must be loaded _before_
*history-substring-search* module. the _`history-substring-search`_ module.
To elaborate: The relative order of loading the modules would be To elaborate, the relative order of loading the modules would be
'syntax-highlighting', 'history-substring-search' and 'prompt'. _`syntax-highlighting`_, _`history-substring-search`_ and _`prompt`_.
## Contributors ## Contributors
@ -22,7 +22,7 @@ This module will be synchronized against it.
### Highlighting ### Highlighting
To enable highlighting for this module only, add the following line to To enable highlighting for this module only, add the following line to
*~/.zpreztorc*: _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:syntax-highlighting' color 'yes' zstyle ':prezto:module:syntax-highlighting' color 'yes'
@ -30,10 +30,11 @@ zstyle ':prezto:module:syntax-highlighting' color 'yes'
### Highlighters ### Highlighters
Syntax highlighting is accomplished by pluggable [highlighters][2]. This module Syntax highlighting is accomplished by pluggable [highlighters][3]. This module
only enables the *main* highlighter by default. only enables the _main_ highlighter by default.
To enable all highlighters, add the following to *~/.zpreztorc*: To enable all highlighters, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:syntax-highlighting' highlighters \ zstyle ':prezto:module:syntax-highlighting' highlighters \
@ -50,7 +51,7 @@ zstyle ':prezto:module:syntax-highlighting' highlighters \
Each syntax highlighter defines styles used to highlight tokens. Each syntax highlighter defines styles used to highlight tokens.
To highlight, for example, builtins, commands, and functions in blue instead of To highlight, for example, builtins, commands, and functions in blue instead of
green, add the following to *~/.zpreztorc*: green, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:syntax-highlighting' styles \ zstyle ':prezto:module:syntax-highlighting' styles \
@ -61,10 +62,11 @@ zstyle ':prezto:module:syntax-highlighting' styles \
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][3].* _The authors of this module should be contacted via the [issue tracker][4]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/zsh-users/zsh-syntax-highlighting [1]: https://github.com/zsh-users/zsh-syntax-highlighting
[2]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters [2]: ../history-substring-search#readme
[3]: https://github.com/sorin-ionescu/prezto/issues [3]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
[4]: https://github.com/sorin-ionescu/prezto/issues

7
modules/terminal/README.md
Unescape View File

@ -7,7 +7,7 @@ Sets terminal window and tab titles.
### Auto-Title ### Auto-Title
To auto set the terminal window and tab titles with the current command or To auto set the terminal window and tab titles with the current command or
directory, add the following to *~/.zpreztorc*: directory, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:terminal' auto-title 'yes' zstyle ':prezto:module:terminal' auto-title 'yes'
@ -23,7 +23,8 @@ zstyle ':prezto:module:terminal' auto-title 'always'
### Title formats ### Title formats
To format terminal window and tab titles, add the following to *~/.zpreztorc*: To format terminal window and tab titles, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh ```sh
zstyle ':prezto:module:terminal:window-title' format '%n@%m: %s' zstyle ':prezto:module:terminal:window-title' format '%n@%m: %s'
@ -44,7 +45,7 @@ For a list of sequences, see [Expansion of Prompt Sequences][1].
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Olaf Conradi](https://github.com/oohlaf) - [Olaf Conradi](https://github.com/oohlaf)

14
modules/tmux/README.md
Unescape View File

@ -1,6 +1,6 @@
# Tmux # Tmux
Defines [*tmux*][1] aliases and provides for auto launching it at start-up. Defines [_tmux_][1] aliases and provides for auto launching it at start-up.
## Settings ## Settings
@ -9,14 +9,14 @@ Defines [*tmux*][1] aliases and provides for auto launching it at start-up.
Starts a tmux session automatically when Zsh is launched. Starts a tmux session automatically when Zsh is launched.
To enable this feature when launching Zsh in a local terminal, add the following To enable this feature when launching Zsh in a local terminal, add the following
line to *~/.zpreztorc*: line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:tmux:auto-start' local 'yes' zstyle ':prezto:module:tmux:auto-start' local 'yes'
``` ```
To enable this feature when launching Zsh in a SSH connection, add the following To enable this feature when launching Zsh in a SSH connection, add the following
line to *~/.zpreztorc*: line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:tmux:auto-start' remote 'yes' zstyle ':prezto:module:tmux:auto-start' remote 'yes'
@ -34,7 +34,7 @@ zstyle ':prezto:module:tmux:session' name '<YOUR DEFAULT SESSION NAME>'
With `auto-start` enabled, you may want to control how multiple sessions are With `auto-start` enabled, you may want to control how multiple sessions are
managed. The `destroy-unattached` option of tmux controls if the unattached managed. The `destroy-unattached` option of tmux controls if the unattached
sessions must be kept alive, making sessions available for later use, configured sessions must be kept alive, making sessions available for later use, configured
in *tmux.conf*: in _tmux.conf_:
```conf ```conf
set-option -g destroy-unattached [on | off] set-option -g destroy-unattached [on | off]
@ -43,7 +43,7 @@ set-option -g destroy-unattached [on | off]
#### iTerm2 Integration #### iTerm2 Integration
[iTerm2][6] offers significant integration with tmux. This can be enabled by [iTerm2][6] offers significant integration with tmux. This can be enabled by
adding the following line to *~/.zpreztorc*: adding the following line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:tmux:iterm' integrate 'yes' zstyle ':prezto:module:tmux:iterm' integrate 'yes'
@ -61,7 +61,7 @@ Read [iTerm2 and tmux Integration][7] for more information.
On macOS, launching tmux can cause the error **launch_msg(...): Socket is not On macOS, launching tmux can cause the error **launch_msg(...): Socket is not
connected** to be displayed, which can be fixed by installing connected** to be displayed, which can be fixed by installing
[reattach-to-user-namespace][3], available in [Homebrew][4], and adding the [reattach-to-user-namespace][3], available in [Homebrew][4], and adding the
following to *tmux.conf*: following to _tmux.conf_:
```conf ```conf
set-option -g default-command "reattach-to-user-namespace -l $SHELL -l" set-option -g default-command "reattach-to-user-namespace -l $SHELL -l"
@ -72,7 +72,7 @@ about this and Prezto has already been [opened][2].
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][5].* _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Colin Hebert](https://github.com/ColinHebert) - [Colin Hebert](https://github.com/ColinHebert)

55
modules/utility/README.md
Unescape View File

@ -2,46 +2,63 @@
Defines general aliases and functions. Defines general aliases and functions.
This module must be loaded _before_ the [_`completion`_][1] module so that the
provided completion definitions are loaded automatically by _`completion`_
module.
**Note:** Some of the utilities configured in this module might be provided via **Note:** Some of the utilities configured in this module might be provided via
GNU utilities with incompatible arguments on non-GNU systems. In such cases, GNU utilities with incompatible arguments on non-GNU systems. In such cases,
using [*`gnu-utility`*][1] module is recommended and it must be loaded using [_`gnu-utility`_][2] module is recommended and it must be loaded
**before** this module. _before_ this module.
To elaborate, the relative order of loading the modules would be
_`gnu-utility`_, _`utility`_ and _`completion`_.
## Settings ## Settings
### Highlighting ### Highlighting
If you have enabled color globally in *~/.zpreztorc*, you may disable it for If you have enabled color globally in _`${ZDOTDIR:-$HOME}/.zpreztorc`_, you may
certain commands. disable it selectively for certain commands.
To disable `ls` color, add the following line to *~/.zpreztorc*; when coloring To disable `ls` color, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
is disabled, type indicators (`\*`, `/`, `=>`, `@`, `=`, `|`, `%`) will be When coloring is disabled, type indicators (`\*`, `/`, `=>`, `@`, `=`, `|`, `%`)
appended to entries. will be appended to entries.
```sh ```sh
zstyle ':prezto:module:utility:ls' color 'no' zstyle ':prezto:module:utility:ls' color 'no'
``` ```
To disable GNU coreutils `ls` to list directories grouped first, add the To disable GNU coreutils `ls` to list directories grouped first, add the
following line to *~/.zpreztorc*: following line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility:ls' dirs-first 'no' zstyle ':prezto:module:utility:ls' dirs-first 'no'
``` ```
To disable `diff` highlighting, add the following line to *~/.zpreztorc*: To disable `grep` highlighting, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:utility:grep' color 'no'
```
To disable `diff` highlighting, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility:diff' color 'no' zstyle ':prezto:module:utility:diff' color 'no'
``` ```
To disable `wdiff` highlighting, add the following line to *~/.zpreztorc*: To disable `wdiff` highlighting, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility:wdiff' color 'no' zstyle ':prezto:module:utility:wdiff' color 'no'
``` ```
To disable `make` highlighting, add the following line to *~/.zpreztorc*: To disable `make` highlighting, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility:make' color 'no' zstyle ':prezto:module:utility:make' color 'no'
@ -66,7 +83,8 @@ zstyle ':prezto:module:utility:make' color 'no'
- `mysql` - `mysql`
- `rm` - `rm`
To disable all spelling corrections, add the following line to *~/.zpreztorc*: To disable all spelling corrections, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility' correct 'no' zstyle ':prezto:module:utility' correct 'no'
@ -136,7 +154,7 @@ zstyle ':prezto:module:utility' correct 'no'
By default, `cp`,`ln`, `mv` and `rm` are aliased to their interactive variants. By default, `cp`,`ln`, `mv` and `rm` are aliased to their interactive variants.
If this is not desired, it can be disabled by adding the following line to If this is not desired, it can be disabled by adding the following line to
*~/.zpreztorc*: _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh ```sh
zstyle ':prezto:module:utility' safe-ops 'no'. zstyle ':prezto:module:utility' safe-ops 'no'.
@ -157,7 +175,7 @@ In addition, the following aliases have been added:
### General ### General
- `slit` prints columns *1, 2, 3 ... n*. - `slit` prints columns _1, 2, 3 ... n_.
### Files and Directories ### Files and Directories
@ -173,7 +191,7 @@ In addition, the following aliases have been added:
- `diff` highlights diff output (requires `colordiff`). - `diff` highlights diff output (requires `colordiff`).
- `make` highlights make output (requires `colormake`). - `make` highlights make output (requires `colormake`).
- `wdiff` highlights wdiff output (requires `wdiff `or `git`). - `wdiff` highlights wdiff output (requires `wdiff` or `git`).
### Resource usage ### Resource usage
@ -186,11 +204,12 @@ In addition, the following aliases have been added:
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][3]._
- [Robby Russell](https://github.com/robbyrussell) - [Robby Russell](https://github.com/robbyrussell)
- [Suraj N. Kurapati](https://github.com/sunaku) - [Suraj N. Kurapati](https://github.com/sunaku)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: ../gnu-utility#readme [1]: ../completion#readme
[2]: https://github.com/sorin-ionescu/prezto/issues [2]: ../gnu-utility#readme
[3]: https://github.com/sorin-ionescu/prezto/issues

6
modules/wakeonlan/README.md
Unescape View File

@ -4,13 +4,13 @@ This module provides a wrapper around the [wakeonlan][1] tool.
## Usage ## Usage
To use this wrapper, create the *`~/.wakeonlan`* directory, and place in it one To use this wrapper, create the _`~/.wakeonlan`_ directory, and place in it one
file for each device you would like to be able to wake. Give the file a name file for each device you would like to be able to wake. Give the file a name
that describes the device, such as its hostname. that describes the device, such as its hostname.
Each file should contain a line with the MAC address of the target device and Each file should contain a line with the MAC address of the target device and
the network broadcast address. For instance, there might be a file the network broadcast address. For instance, there might be a file
`*~/.wakeonlan/leto`* with the following contents: _`~/.wakeonlan/leto`_ with the following contents:
```conf ```conf
00:11:22:33:44:55:66 192.168.0.255 00:11:22:33:44:55:66 192.168.0.255
@ -27,7 +27,7 @@ For more information on the configuration file format, read the
## Authors ## Authors
*The authors of this module should be contacted via [issue tracker][3].* _The authors of this module should be contacted via [issue tracker][3]._
- [Paul Dann](https://github.com/giddie) - [Paul Dann](https://github.com/giddie)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

4
modules/yum/README.md
Unescape View File

@ -1,6 +1,6 @@
# Yum # Yum
Defines [*yum*][1] aliases. Defines [_yum_][1] aliases.
## Aliases ## Aliases
@ -17,7 +17,7 @@ Defines [*yum*][1] aliases.
## Authors ## Authors
*The authors of this module should be contacted via the [issue tracker][2].* _The authors of this module should be contacted via the [issue tracker][2]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)

41
runcoms/README.md
Unescape View File

@ -14,19 +14,19 @@ not defined, Zsh will use the user's home directory.
## File Descriptions ## File Descriptions
The configuration files are read in the following order: The [configuration files][1] are read in the following order:
01. */etc/zshenv* 01. *`/etc/zshenv`*
02. *~/.zshenv* 02. *`${ZDOTDIR:-$HOME}/.zshenv`*
03. */etc/zprofile* 03. *`/etc/zprofile`*
04. *~/.zprofile* 04. *`${ZDOTDIR:-$HOME}/.zprofile`*
05. */etc/zshrc* 05. *`/etc/zshrc`*
06. *~/.zshrc* 06. *`${ZDOTDIR:-$HOME}/.zshrc`*
07. *~/.zpreztorc* 07. *`${ZDOTDIR:-$HOME}/.zpreztorc`*
08. */etc/zlogin* 08. *`/etc/zlogin`*
09. *~/.zlogin* 09. *`${ZDOTDIR:-$HOME}/.zlogin`*
10. *~/.zlogout* 10. *`${ZDOTDIR:-$HOME}/.zlogout`*
11. */etc/zlogout* 11. *`/etc/zlogout`*
### zshenv ### zshenv
@ -36,7 +36,7 @@ small as possible and should only define environment variables.
### zprofile ### zprofile
This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added
for [KornShell][1] fans. See the description of *zlogin* below for what it may for [KornShell][2] fans. See the description of *zlogin* below for what it may
contain. contain.
*zprofile* and *zlogin* are not meant to be used together but can be done so. *zprofile* and *zlogin* are not meant to be used together but can be done so.
@ -54,7 +54,7 @@ This file configures Prezto.
This file is sourced by login shells after *zshrc*. Thus, it should contain This file is sourced by login shells after *zshrc*. Thus, it should contain
commands that need to execute at login. It is usually used for messages such as commands that need to execute at login. It is usually used for messages such as
[*fortune*][2], [*msgs*][3], or for the creation of files. [*fortune*][3], [*msgs*][4], or for the creation of files.
This is not the file to define aliases, functions, shell options, and key This is not the file to define aliases, functions, shell options, and key
bindings. It should not change the shell environment. bindings. It should not change the shell environment.
@ -66,11 +66,12 @@ displaying messages and for deletion of files.
## Authors ## Authors
*The authors of these files should be contacted via the [issue tracker][4].* *The authors of these files should be contacted via the [issue tracker][5].*
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://www.kornshell.com [1]: http://zsh.sourceforge.net/Intro/intro_3.html#SEC3
[2]: https://en.wikipedia.org/wiki/Fortune_(Unix) [2]: https://www.kornshell.com
[3]: https://www.manpagez.com/man/1/msgs [3]: https://en.wikipedia.org/wiki/Fortune_(Unix)
[4]: https://github.com/sorin-ionescu/prezto/issues [4]: https://www.manpagez.com/man/1/msgs
[5]: https://github.com/sorin-ionescu/prezto/issues

2
runcoms/zpreztorc
Unescape View File

@ -52,7 +52,7 @@ zstyle ':prezto:load' pmodule \
# Completions # Completions
# #
# Set the entries to ignore in static */etc/hosts* for host completion. # Set the entries to ignore in static '/etc/hosts' for host completion.
# zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \ # zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \
# '0.0.0.0' '127.0.0.1' # '0.0.0.0' '127.0.0.1'

Write Preview
Loading…
Cancel
Save