summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorRob Ede <robjtede@gmail.com>2016-09-08 00:18:26 +0100
committerRob Ede <robjtede@gmail.com>2016-09-08 00:18:26 +0100
commita64d018a9d483e0535d6d77d10c9ff2771d0cb41 (patch)
treefc65db8e6c9fb433873d690c3b5c7f4ebc39a173 /plugins
parente12f8e64ea1fe2871296f8acf541446a56cf5994 (diff)
downloadzsh-a64d018a9d483e0535d6d77d10c9ff2771d0cb41.tar.gz
zsh-a64d018a9d483e0535d6d77d10c9ff2771d0cb41.tar.bz2
zsh-a64d018a9d483e0535d6d77d10c9ff2771d0cb41.zip
add readme
Diffstat (limited to 'plugins')
-rw-r--r--plugins/firewalld/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/firewalld/readme.md b/plugins/firewalld/readme.md
index e69de29bb..611ad6de0 100644
--- a/plugins/firewalld/readme.md
+++ b/plugins/firewalld/readme.md
@@ -0,0 +1,22 @@
+# FirewallD Plugin
+
+This plugin adds some aliases and functions for FirewallD using the `firewalld-cmd` command. To use it, add firewalld to your plugins array.
+
+```
+plugins=(... firewalld)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| :---- | :----------------------------------- | :--------------------------- |
+| fw | `firewall-cmd` | Shorthand |
+| fwr | `firewall-cmd --reload` | Reload current configuration |
+| fwp | `firewall-cmd --permanent` | Create permanent rule |
+| fwrp | `firewall-cmd --runtime-to-permanent` | Save current configuration |
+
+## Functions
+
+| Function | Description |
+| :------- | :--------------------------------------------------------- |
+| fwl | Lists configuration from all active zones and direct rules |