general: Documentation update for zstyle based alias skipping support

Add documentation to surface the `zstyle` based alias skipping.
This commit is contained in:
Indrajit Raychaudhuri 2023-05-04 22:21:48 -05:00
parent 5ca892d6af
commit 8ee9d1bbfe
13 changed files with 91 additions and 0 deletions

View file

@ -17,6 +17,13 @@ Sets directory options and defines directory aliases.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:directory:alias' skip 'yes'
```
- `d` prints the contents of the directory stack.
- `1 ... 9` changes the directory to the **n** previous one.

View file

@ -12,6 +12,13 @@ execution of `carton`.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:emacs:alias' skip 'yes'
```
### Carton
- `cai` installs dependencies.

View file

@ -19,6 +19,13 @@ instead of the bundled version.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:fasd:alias' skip 'yes'
```
- `j` changes the current working directory interactively.
## Completion

View file

@ -36,6 +36,13 @@ Alternately, you can set `HISTFILE` manually to _`${ZDOTDIR:-$HOME}/.zhistory`_.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:history:alias' skip 'yes'
```
- `history-stat` lists the ten most used commands
## Settings

View file

@ -12,6 +12,13 @@ brew shellenv
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:homebrew:alias' skip 'yes'
```
### Homebrew Core
- `brewc` cleans outdated brews and their cached archives.

View file

@ -4,6 +4,13 @@ Defines MacPorts aliases and adds MacPorts directories to path variables.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:macports:alias' skip 'yes'
```
- `portc` cleans the files used to build ports.
- `porti` installs a port.
- `ports` searches for a port.

View file

@ -29,6 +29,13 @@ _`$XDG_CONFIG_HOME/nvm`_, _`~/.nvm`_, or is installed with homebrew.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:node:alias' skip 'yes'
```
### npm
- `npmi` install a package.

View file

@ -40,6 +40,13 @@ The subcommands of _plenv_ is similar with _rbenv_.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:perl:alias' skip 'yes'
```
### General
- `pl` is short for `perl`.

View file

@ -124,6 +124,13 @@ zstyle ':prezto:module:python:virtualenv' initialize 'no'
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:python:alias' skip 'yes'
```
- `py` is short for `python`.
- `py2` is short for `python2`.
- `py3` is short for `python3`.

View file

@ -4,6 +4,13 @@ Defines [Ruby on Rails][1] aliases.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:rails:alias' skip 'yes'
```
- `ror` is short for `rails`.
- `rorc` starts the Rails console.
- `rordc` starts the Rails console connected to the database.

View file

@ -54,6 +54,13 @@ dependencies, with [Bundler][5].
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:ruby:alias' skip 'yes'
```
### General
- `rb` is short for `ruby`.

View file

@ -24,6 +24,13 @@ zstyle ':prezto:module:screen:auto-start' remote 'yes'
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:screen:alias' skip 'yes'
```
- `scr` is short for `screen`.
- `scrl` lists sessions/socket directory.
- `scrn` starts a new session.

View file

@ -53,6 +53,13 @@ Read [iTerm2 and tmux Integration][7] for more information.
## Aliases
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:tmux:alias' skip 'yes'
```
- `tmuxa` attaches or switches to a tmux session.
- `tmuxl` lists sessions managed by the tmux server.