summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorAswath K <aswath.sana@gmail.com>2018-10-05 03:11:34 +0530
committerMarc Cornellà <marc.cornella@live.com>2018-10-04 23:41:34 +0200
commit2cb7bc7357ff70382bf15a775b534fd0fe559969 (patch)
treed928b2008d5b40806ba2319a35189b2a044aea48 /plugins
parent759f682088073f1df2665abc541fb8d77ff9c4db (diff)
downloadzsh-2cb7bc7357ff70382bf15a775b534fd0fe559969.tar.gz
zsh-2cb7bc7357ff70382bf15a775b534fd0fe559969.tar.bz2
zsh-2cb7bc7357ff70382bf15a775b534fd0fe559969.zip
Add READMEs to plugins: yum, mosh, themes (#7229)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/mosh/README.md9
-rw-r--r--plugins/themes/README.md18
-rw-r--r--plugins/yum/README.md28
3 files changed, 55 insertions, 0 deletions
diff --git a/plugins/mosh/README.md b/plugins/mosh/README.md
new file mode 100644
index 000000000..4bbecf478
--- /dev/null
+++ b/plugins/mosh/README.md
@@ -0,0 +1,9 @@
+# Mosh Plugin
+
+This plugin allows SSH tab completion for [mosh](https://mosh.org/) hostnames.
+
+To use it, add `mosh` to the plugins array in your zshrc file:
+
+```
+plugins=(... mosh)
+```
diff --git a/plugins/themes/README.md b/plugins/themes/README.md
new file mode 100644
index 000000000..408e357e0
--- /dev/null
+++ b/plugins/themes/README.md
@@ -0,0 +1,18 @@
+# Themes Plugin
+
+This plugin allows you to change ZSH theme on the go.
+
+To use it, add `themes` to the plugins array in your zshrc file:
+
+```
+plugins=(... themes)
+```
+
+## Usage
+
+`theme <theme_name>` - Changes the ZSH theme to specified theme.
+
+`theme ` - Changes the ZSH theme to some random theme.
+
+`lstheme ` - Lists installed ZSH themes.
+
diff --git a/plugins/yum/README.md b/plugins/yum/README.md
new file mode 100644
index 000000000..5053d4d42
--- /dev/null
+++ b/plugins/yum/README.md
@@ -0,0 +1,28 @@
+# Yum plugin
+
+This plugin adds useful aliases for common [Yum](http://yum.baseurl.org/) commands.
+
+To use it, add `yum` to the plugins array in your zshrc file:
+
+```
+plugins=(... yum)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|-----------------------------------|------------------------------|
+| ys | `yum search` | Search package |
+| yp | `yum info` | Show package info |
+| yl | `yum list` | List packages |
+| ygl | `yum grouplist` | List package groups |
+| yli | `yum list installed` | Print all installed packages |
+| ymc | `yum makecache` | Rebuild the yum package list |
+| yu | `sudo yum update` | Upgrade packages |
+| yi | `sudo yum install` | Install package |
+| ygi | `sudo yum groupinstall` | Install package group |
+| yr | `sudo yum remove` | Remove package |
+| ygr | `sudo yum groupremove` | Remove pagage group |
+| yrl | `sudo yum remove --remove-leaves` | Remove package and leaves |
+| yc | `sudo yum clean all` | Clean yum cache |
+