From 3119918b11fa22e8ed3447bf38853ce5796c765d Mon Sep 17 00:00:00 2001
From: Indrajit Raychaudhuri <irc@indrajit.com>
Date: Thu, 4 May 2023 22:21:48 -0500
Subject: [PATCH] general: Documentation update for zstyle based alias skipping
support
Add documentation to surface the `zstyle` based alias skipping.
---
modules/directory/README.md | 7 +++++++
modules/emacs/README.md | 7 +++++++
modules/fasd/README.md | 7 +++++++
modules/history/README.md | 7 +++++++
modules/homebrew/README.md | 7 +++++++
modules/macports/README.md | 7 +++++++
modules/node/README.md | 7 +++++++
modules/perl/README.md | 7 +++++++
modules/python/README.md | 7 +++++++
modules/rails/README.md | 7 +++++++
modules/ruby/README.md | 7 +++++++
modules/screen/README.md | 7 +++++++
modules/tmux/README.md | 7 +++++++
13 files changed, 91 insertions(+)
diff --git a/modules/directory/README.md b/modules/directory/README.md
index 86953a47..8603d9f6 100644
--- a/modules/directory/README.md
+++ b/modules/directory/README.md
@@ -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.
diff --git a/modules/emacs/README.md b/modules/emacs/README.md
index f93304aa..8cf7bfc8 100644
--- a/modules/emacs/README.md
+++ b/modules/emacs/README.md
@@ -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.
diff --git a/modules/fasd/README.md b/modules/fasd/README.md
index 1958a739..04f9693a 100644
--- a/modules/fasd/README.md
+++ b/modules/fasd/README.md
@@ -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
diff --git a/modules/history/README.md b/modules/history/README.md
index 11c6d947..51e6e8ca 100644
--- a/modules/history/README.md
+++ b/modules/history/README.md
@@ -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
diff --git a/modules/homebrew/README.md b/modules/homebrew/README.md
index 1875e08d..77d8f377 100644
--- a/modules/homebrew/README.md
+++ b/modules/homebrew/README.md
@@ -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.
diff --git a/modules/macports/README.md b/modules/macports/README.md
index ba6143b5..15963b33 100644
--- a/modules/macports/README.md
+++ b/modules/macports/README.md
@@ -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.
diff --git a/modules/node/README.md b/modules/node/README.md
index 6ec0b75c..bc262151 100644
--- a/modules/node/README.md
+++ b/modules/node/README.md
@@ -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.
diff --git a/modules/perl/README.md b/modules/perl/README.md
index 772d0680..dd594491 100644
--- a/modules/perl/README.md
+++ b/modules/perl/README.md
@@ -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`.
diff --git a/modules/python/README.md b/modules/python/README.md
index 1695fa05..2e3b2eec 100644
--- a/modules/python/README.md
+++ b/modules/python/README.md
@@ -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`.
diff --git a/modules/rails/README.md b/modules/rails/README.md
index 129627a0..5e230e0e 100644
--- a/modules/rails/README.md
+++ b/modules/rails/README.md
@@ -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.
diff --git a/modules/ruby/README.md b/modules/ruby/README.md
index 97a09f07..fa3d1064 100644
--- a/modules/ruby/README.md
+++ b/modules/ruby/README.md
@@ -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`.
diff --git a/modules/screen/README.md b/modules/screen/README.md
index a1775f7e..b5549510 100644
--- a/modules/screen/README.md
+++ b/modules/screen/README.md
@@ -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.
diff --git a/modules/tmux/README.md b/modules/tmux/README.md
index e7ae929d..f6d375b0 100644
--- a/modules/tmux/README.md
+++ b/modules/tmux/README.md
@@ -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.