dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-11-16 09:41:12 +00:00
Code Issues Releases Wiki Activity
347441abdf
prezto/modules/editor/README.md

103 lines
2.7 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Editor
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
general: Miscellaneous documentation updates - Add missing documentation for options and environment variables - Rearrange definition and documentation of 'Options', 'Variables' and 'Aliases' in a consistent order
2018-10-12 08:55:55 +00:00
Sets editor specific key bindings options and variables.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Options
general: Miscellaneous documentation updates - Add missing documentation for options and environment variables - Rearrange definition and documentation of 'Options', 'Variables' and 'Aliases' in a consistent order
2018-10-12 08:55:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `BEEP` beep on error in line editor.
general: Miscellaneous documentation updates - Add missing documentation for options and environment variables - Rearrange definition and documentation of 'Options', 'Variables' and 'Aliases' in a consistent order
2018-10-12 08:55:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Variables
general: Miscellaneous documentation updates - Add missing documentation for options and environment variables - Rearrange definition and documentation of 'Options', 'Variables' and 'Aliases' in a consistent order
2018-10-12 08:55:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `WORDCHARS` treat a given set of characters as part of a word.
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Settings
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
### Key bindings
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To enable key bindings, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_,
and replace `'<bindings>'` with `'emacs'` or `'vi'`.
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
zstyle ':prezto:module:editor' key-bindings '<bindings>'
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
### Dot Expansion
To enable the auto conversion of .... to ../.., add the following to
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor' dot-expansion 'yes'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
Adds additional support for PS prompt context expansion
2017-04-02 19:09:58 +00:00
### PS Context
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To enable the prompt context to be set, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
Adds additional support for PS prompt context expansion
2017-04-02 19:09:58 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor' ps-context 'yes'
```
Adds additional support for PS prompt context expansion
2017-04-02 19:09:58 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Theming
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
To indicate when the editor is in the primary keymap (emacs or viins), add
the following to your `theme_prompt_setup` function.
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor:info:keymap:primary' format '>>>'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
To indicate when the editor is in the primary keymap (emacs or viins) insert
mode, add the following to your `theme_prompt_setup` function.
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor:info:keymap:primary:insert' format 'I'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
To indicate when the editor is in the primary keymap (emacs or viins) overwrite
mode, add the following to your `theme_prompt_setup` function.
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor:info:keymap:primary:overwrite' format 'O'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
To indicate when the editor is in the alternate keymap (vicmd), add the
following to your `theme_prompt_setup` function.
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor:info:keymap:alternate' format '<<<'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
To indicate when the editor is completing, add the following to your
`theme_prompt_setup` function.
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:editor:info:completing' format '...'
```
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +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.
2021-05-05 17:59:01 +00:00
Then add `$editor_info[context]`, where context is _keymap_, _insert_, or
_overwrite_, to `$PROMPT` or `$RPROMPT`.
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Convenience Functions
[editor] Add bindkey-all function to show all bound keys (#1358) * [editor] Add bindkey-all function to show all bound keys Function which allows you to see all the bound keys for all of the different keymaps. It does accept arguments and passes them through to bindkey -m "$keymap" so you could set a shortcut to all keymaps as well if you wished. Makes it much easier to see and grep what keys are bound to each of the different keymaps. When no arguments are given it will print keymap headers to stderr, if given arguments it will not print anything extra to the screen. * [editor] Update README to include information about bindkey-all funct.
2017-07-06 06:05:31 +00:00
### bindkey-all
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
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
[editor] Add bindkey-all function to show all bound keys (#1358) * [editor] Add bindkey-all function to show all bound keys Function which allows you to see all the bound keys for all of the different keymaps. It does accept arguments and passes them through to bindkey -m "$keymap" so you could set a shortcut to all keymaps as well if you wished. Makes it much easier to see and grep what keys are bound to each of the different keymaps. When no arguments are given it will print keymap headers to stderr, if given arguments it will not print anything extra to the screen. * [editor] Update README to include information about bindkey-all funct.
2017-07-06 06:05:31 +00:00
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
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
for all keymaps at once. If provided arguments it will _not_ print out the
Fix typo
2017-08-16 18:47:58 +00:00
names of each of the keymaps, and just run the command for each keymap.
[editor] Add bindkey-all function to show all bound keys (#1358) * [editor] Add bindkey-all function to show all bound keys Function which allows you to see all the bound keys for all of the different keymaps. It does accept arguments and passes them through to bindkey -m "$keymap" so you could set a shortcut to all keymaps as well if you wished. Makes it much easier to see and grep what keys are bound to each of the different keymaps. When no arguments are given it will print keymap headers to stderr, if given arguments it will not print anything extra to the screen. * [editor] Update README to include information about bindkey-all funct.
2017-07-06 06:05:31 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Authors
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +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.
2021-05-05 17:59:01 +00:00
_The authors of this module should be contacted via the [issue tracker][1]._
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[Fix #103] Add documentation for editor
2013-05-18 20:49:09 +00:00
Update documentation - Fix an old link to the wrong issue tracker - Add documentation to the history module about migration from oh-my-zsh Closes #1766
2020-01-20 15:50:42 +00:00
[1]: https://github.com/sorin-ionescu/prezto/issues
Reference in New Issue Copy Permalink