diff --git a/docs/configuration_file_basics.xml b/docs/configuration_file_basics.xml index ea83ea3f6..a74dd74bd 100644 --- a/docs/configuration_file_basics.xml +++ b/docs/configuration_file_basics.xml @@ -284,6 +284,12 @@ ACCEPT net $FW tcp www #This is an end-of-line commentAction definition files (/etc/shorewall/action.*) + + + Macro definition files (/etc/shorewall/macro.*) — Added in + Shorewall-perl 4.1. They are ignored by Shorewall-shell 4.1 and + later. + To attach a comment to one or more rules, insert a record above the @@ -332,6 +338,24 @@ Chain loc2net (1 references) gateway:~ # + + COMMENT lines in macro files work somewhat differently from other + files. COMMENT lines in macros are ignored if COMMENT support is not + available or if there was a COMMENT in use when the top-level macro was + invoked. This allows the following: + + /usr/share/shorewall/macro.SSH: + + #ACTION SOURCE DEST PROTO DEST SOURCE RATE USER/ +# PORT(S) PORT(S) LIMIT GROUP +COMMENT SSH +PARAM - - tcp 22 + /etc/shorewall/rules:COMMENT Allow SSH from home +SSH/ALLOW net:$MYIP $FW +COMMENTThe comment line in macro.SSH will not override the + COMMENT line in the rules file and the generated rule will show /* Allow SSH from home */ when displayed through + the Shorewall show and dump commands.