summaryrefslogtreecommitdiff
path: root/plugins/firewalld/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-12-27 02:37:27 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-12-27 02:37:27 +0100
commit67b5bfaaa316212221a01d4fe2eedcd0fc64c230 (patch)
tree5c6f76ef95b48a7c7acf6c9c3d0b1c2e2fd53b62 /plugins/firewalld/README.md
parent8ea20fdca794a2a2c2f39cebd1e1861f9f0c6fbb (diff)
downloadzsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.gz
zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.bz2
zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.zip
Rename some plugin READMEs for consistency
Diffstat (limited to 'plugins/firewalld/README.md')
-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
new file mode 100644
index 000000000..8b5bc74d4
--- /dev/null
+++ 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.
+
+```zsh
+plugins=(... firewalld)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| :---- | :----------------------------------------- | :--------------------------- |
+| fw | `sudo firewall-cmd` | Shorthand |
+| fwr | `sudo firewall-cmd --reload` | Reload current configuration |
+| fwp | `sudo firewall-cmd --permanent` | Create permanent rule |
+| fwrp | `sudo firewall-cmd --runtime-to-permanent` | Save current configuration |
+
+## Functions
+
+| Function | Description |
+| :------- | :--------------------------------------------------------- |
+| fwl | Lists configuration from all active zones and direct rules |