Browse Source

Add READMEs to plugins: yum, mosh, themes (#7229)

Aswath K 5 years ago
parent
commit
2cb7bc7357
3 changed files with 55 additions and 0 deletions
  1. 9 0
      plugins/mosh/README.md
  2. 18 0
      plugins/themes/README.md
  3. 28 0
      plugins/yum/README.md

+ 9 - 0
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)
+```

+ 18 - 0
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.
+

+ 28 - 0
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              |
+