nixos-firewall-tool: add man page

2024-12-28 17:33:30 +00:00
parent d9fd3dce7a
commit d57da575ef
2 changed files with 18 additions and 0 deletions
@@ -0,0 +1,17 @@
+.TH nixos-firewall-tool 1
+.SH NAME
+nixos-firewall-tool \- a tool to temporarily manipulate the NixOS firewall
+.SH SYNOPSIS
+nixos-firewall-tool \fIsubcommand\fR
+
+Open TCP port:
+  nixos-firewall-tool open tcp 8888
+
+Open UDP port:
+  nixos-firewall-tool open udp 51820
+
+Show all firewall rules:
+  nixos-firewall-tool show
+
+Reset firewall configuration to system settings:
+  nixos-firewall-tool reset
@@ -24,6 +24,7 @@ stdenvNoCC.mkDerivation rec {

  installPhase = ''
    installBin nixos-firewall-tool
+    installManPage nixos-firewall-tool.1
    installShellCompletion nixos-firewall-tool.{bash,fish}
  '';