mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-02 01:39:25 +00:00
general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
424d4cb779
commit
1ff9421f7b
@ -14,17 +14,17 @@ Sets editor specific key bindings options and variables.
|
||||
|
||||
### Key bindings
|
||||
|
||||
To enable key bindings, add the following to *~/.zpreztorc*, and replace
|
||||
'bindings' with 'emacs' or 'vi'.
|
||||
To enable key bindings, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_,
|
||||
and replace `'<bindings>'` with `'emacs'` or `'vi'`.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:editor' key-bindings 'bindings'
|
||||
zstyle ':prezto:module:editor' key-bindings '<bindings>'
|
||||
```
|
||||
|
||||
### Dot Expansion
|
||||
|
||||
To enable the auto conversion of .... to ../.., add the following to
|
||||
*~/.zpreztorc*.
|
||||
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
@ -32,8 +32,8 @@ zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
|
||||
### PS Context
|
||||
|
||||
To enable the prompt context to be set, add the following to your
|
||||
*~/.zpreztorc*.
|
||||
To enable the prompt context to be set, add the following to
|
||||
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
||||
|
||||
```sh
|
||||
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 '...'
|
||||
```
|
||||
|
||||
Then add `$editor_info[context]`, where context is *keymap*, *insert*, or
|
||||
*overwrite*, to `$PROMPT` or `$RPROMPT`.
|
||||
Then add `$editor_info[context]`, where context is _keymap_, _insert_, or
|
||||
_overwrite_, to `$PROMPT` or `$RPROMPT`.
|
||||
|
||||
## Convenience Functions
|
||||
|
||||
### bindkey-all
|
||||
|
||||
Provides a function `bindkey-all` which can be useful for checking how all of the
|
||||
keys are bound. Normal `bindkey` command will only list the keys bound for 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
|
||||
Provides a function `bindkey-all` which can be useful for checking how all of
|
||||
the keys are bound. Normal `bindkey` command will only list the keys bound for
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
## 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)
|
||||
|
||||
|
Reference in New Issue
Block a user