summaryrefslogtreecommitdiff
path: root/plugins/ufw
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-10-09 20:16:18 -0600
committerTuowen Zhao <ztuowen@gmail.com>2019-10-09 20:16:18 -0600
commit112a85697481cae663ff281b74fdc1f72a67b294 (patch)
treee7f6f938fda886c87d296711d853bcc9833b9ec2 /plugins/ufw
parent09829ba30c269e35bddf44a21f3357efd31e686f (diff)
parent710a3d5a1e2888a4dfb1769f8f1edd8a590eee22 (diff)
downloadzsh-112a85697481cae663ff281b74fdc1f72a67b294.tar.gz
zsh-112a85697481cae663ff281b74fdc1f72a67b294.tar.bz2
zsh-112a85697481cae663ff281b74fdc1f72a67b294.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/ufw')
-rw-r--r--plugins/ufw/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/ufw/README.md b/plugins/ufw/README.md
new file mode 100644
index 000000000..ac377cd17
--- /dev/null
+++ b/plugins/ufw/README.md
@@ -0,0 +1,18 @@
+# UFW plugin
+
+This plugin adds completion for managing everybody's favorite Uncomplicated Firewall (UFW),
+a simple interface for managing iptables. Learn more about [`UFW`](https://wiki.ubuntu.com/UncomplicatedFirewall).
+
+To use it, add ufw to the plugins array of your zshrc file:
+```
+plugins=(... ufw)
+```
+
+Some of the commands include:
+
+* `allow <port>/<optional: protocol>` add an allow rule
+* `default` set default policy
+* `delete <port>/<optional: protocol>` delete RULE
+* `deny <port>/<optional: protocol>` add deny rule
+* `disable` disables the firewall
+* `enable` enables the firewall