diff --git a/doc/manpages/qvm-firewall.rst b/doc/manpages/qvm-firewall.rst index f84a7ce3..a90fba78 100644 --- a/doc/manpages/qvm-firewall.rst +++ b/doc/manpages/qvm-firewall.rst @@ -6,7 +6,7 @@ Synopsis -------- -:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* add [--before=*RULE_NUMBER*] *RULE* +:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* add [--before=*RULE_NUMBER*] *RULE* [comment=*comment*] :command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* del [--rule-no=*RULE_NUMBER*] [*RULE*] @@ -42,6 +42,12 @@ Options Show program's version number and exit +Comments +-------- + +When **adding** a rule free form text comments can be appended using **comment**. + + Actions description ------------------- diff --git a/qubesadmin/tools/qvm_firewall.py b/qubesadmin/tools/qvm_firewall.py index 979fd6be..4c6d1d1c 100644 --- a/qubesadmin/tools/qvm_firewall.py +++ b/qubesadmin/tools/qvm_firewall.py @@ -107,6 +107,10 @@ def __call__(self, _parser, namespace, values, option_string=None): expire the rule is automatically removed at the time given as seconds since 1/1/1970, or +seconds (e.g. +300 for a rule to expire in 5 minutes) + +Comments: + Rules can be annotated with free form text on creation using [comment=] + """ parser = qubesadmin.tools.QubesArgumentParser(vmname_nargs=1, epilog=epilog,