summaryrefslogtreecommitdiff
path: root/plugins/ufw
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-07 18:08:35 +0200
committerGitHub <noreply@github.com>2019-10-07 18:08:35 +0200
commit13d889470e8f09f5bfa15afe4e14d2c2c10e3885 (patch)
treedf564b83bed62a887bc2149721cf9a039979cbb1 /plugins/ufw
parent5efe52d991ab1f2596c3aa7766c981412c621fd7 (diff)
parenta3b63aa6ab948c1be278fbea6046cf09f69d3c42 (diff)
downloadzsh-13d889470e8f09f5bfa15afe4e14d2c2c10e3885.tar.gz
zsh-13d889470e8f09f5bfa15afe4e14d2c2c10e3885.tar.bz2
zsh-13d889470e8f09f5bfa15afe4e14d2c2c10e3885.zip
ufw: add README (#8227)
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