summaryrefslogtreecommitdiff
path: root/plugins/perms
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/perms
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
Diffstat (limited to 'plugins/perms')
-rw-r--r--plugins/perms/README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/plugins/perms/README.md b/plugins/perms/README.md
index 324b3f3cc..ae7a36b9d 100644
--- a/plugins/perms/README.md
+++ b/plugins/perms/README.md
@@ -1,9 +1,15 @@
-## Perms
+# Perms plugin
-Plugin to handle some unix filesystem permissions quickly
+Plugin to handle some unix filesystem permissions quickly.
-### Usage
+To use it, add `perms` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... perms)
+```
+
+## Usage
* `set755` recursively sets all given directories (default to .) to octal 755.
* `set644` recursively sets all given files (default to .) to octal 644.
-* `fixperms` is a wrapper around `set755` and `set644` applied to a specified directory or the current directory otherwise. It also prompts prior to execution unlike the other two aliases.
+* `fixperms` is a wrapper around `set755` and `set644` applied to a specified directory or the current directory otherwise. It also prompts prior to execution unlike the other two aliases.