diff --git a/Shorewall/manpages/shorewall-conntrack.xml b/Shorewall/manpages/shorewall-conntrack.xml index 954efeab4..1b1cfdfa0 100644 --- a/Shorewall/manpages/shorewall-conntrack.xml +++ b/Shorewall/manpages/shorewall-conntrack.xml @@ -54,7 +54,7 @@ format. - FORMAT + [?]FORMAT format @@ -62,7 +62,9 @@ role="bold">1,2 or 3. - Format 3 was introduced in Shorewall 4.5.10. + Format 3 was introduced in Shorewall 4.5.10. The optional '?' was + introduced in Shorewall 4.5.11 and ?FORMAT is the preferred form; the form + without the '?' is deprecated. Comments may be attached to Netfilter rules generated from entries in this file through the use of COMMENT lines. These lines begin with the diff --git a/Shorewall/manpages/shorewall-interfaces.xml b/Shorewall/manpages/shorewall-interfaces.xml index 1bdc65b7b..88dfa12b0 100644 --- a/Shorewall/manpages/shorewall-interfaces.xml +++ b/Shorewall/manpages/shorewall-interfaces.xml @@ -52,9 +52,12 @@ The format is specified by a line as follows:
- FORMAT {1|2} + [?]FORMAT {1|2}
+ The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is + the preferred form; the form without the '?' is deprecated. + The columns in the file are as follows. @@ -652,7 +655,7 @@ loc eth2 - sfilter=(net[,...]) + role="bold">sfilter=(net[,...]) Added in Shorewall 4.4.20. This option provides an diff --git a/Shorewall/manpages/shorewall-tcrules.xml b/Shorewall/manpages/shorewall-tcrules.xml index a5f3ede9a..1592036f2 100644 --- a/Shorewall/manpages/shorewall-tcrules.xml +++ b/Shorewall/manpages/shorewall-tcrules.xml @@ -63,9 +63,12 @@ The format is specified by a line as follows:
- FORMAT {1|2} + [?]FORMAT {1|2}
+ The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is + the preferred form; the form without the '?' is deprecated. + The columns in the file are as follows (where the column name is followed by a different name in parentheses, the different name is used in the alternate specification syntax). diff --git a/Shorewall6/manpages/shorewall6-conntrack.xml b/Shorewall6/manpages/shorewall6-conntrack.xml index 87b5d304e..904af77c8 100644 --- a/Shorewall6/manpages/shorewall6-conntrack.xml +++ b/Shorewall6/manpages/shorewall6-conntrack.xml @@ -54,7 +54,7 @@ format. - FORMAT + [?]FORMAT format @@ -62,7 +62,9 @@ role="bold">1,2 or 3. - Format 3 was introduced in Shorewall 4.5.10. + Format 3 was introduced in Shorewall 4.5.10. The optional '?' was + introduced in Shorewall 4.5.11 and ?FORMAT is the preferred form; the form + without the '?' is deprecated. Comments may be attached to Netfilter rules generated from entries in this file through the use of COMMENT lines. These lines begin with the diff --git a/Shorewall6/manpages/shorewall6-interfaces.xml b/Shorewall6/manpages/shorewall6-interfaces.xml index 4bec1e968..f66b0a0e8 100644 --- a/Shorewall6/manpages/shorewall6-interfaces.xml +++ b/Shorewall6/manpages/shorewall6-interfaces.xml @@ -52,9 +52,12 @@ The format is specified by a line as follows:
- FORMAT {1|2} + [?]FORMAT {1|2}
+ The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is + the preferred form; the form without the '?' is deprecated. + The columns in the file are as follows. @@ -412,7 +415,7 @@ loc eth2 - sfilter=(net[,...]) + role="bold">sfilter=(net[,...]) Added in Shorewall 4.4.20. At this writing (spring diff --git a/Shorewall6/manpages/shorewall6-tcrules.xml b/Shorewall6/manpages/shorewall6-tcrules.xml index ead47a938..94d855d99 100644 --- a/Shorewall6/manpages/shorewall6-tcrules.xml +++ b/Shorewall6/manpages/shorewall6-tcrules.xml @@ -63,9 +63,12 @@ The format is specified by a line as follows:
- FORMAT {1|2} + [?]FORMAT {1|2}
+ The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is + the preferred form; the form without the '?' is deprecated. + The columns in the file are as follows (where the column name is followed by a different name in parentheses, the different name is used in the alternate specification syntax). diff --git a/docs/Actions.xml b/docs/Actions.xml index e0de78efa..addf7e410 100644 --- a/docs/Actions.xml +++ b/docs/Actions.xml @@ -350,6 +350,11 @@ ACCEPT - - tcp 135,139,445 FORMAT 2 + Beginning with Shorewall 4.5.11, the preferred format is as shown + below, and the above format is deprecated. + + ?FORMAT 2 + When using Shorewall 4.4.16 or later, there are no restrictions regarding which targets can be used within your action. diff --git a/docs/Macros.xml b/docs/Macros.xml index c79817047..240c8f2a0 100644 --- a/docs/Macros.xml +++ b/docs/Macros.xml @@ -286,6 +286,11 @@ ACCEPT fw loc tcp 135,139,445 FORMAT 2 + Beginning with Shorewall 4.5.11, the preferred format is as shown + below, and the above format is deprecated. + + ?FORMAT 2 + There are no restrictions regarding the ACTIONs that can be performed in a macro. diff --git a/docs/configuration_file_basics.xml b/docs/configuration_file_basics.xml index 38e73ef51..7e1dd5b59 100644 --- a/docs/configuration_file_basics.xml +++ b/docs/configuration_file_basics.xml @@ -1086,6 +1086,75 @@ SHELL cat /etc/shorewall/rules.d/*.rules 2> /dev/null || true +
+ ?FORMAT Directive + + A number of different files support multiple formats. Prior to + Shorewall 4.5.11, the format was specified by a line having 'FORMAT' as + the first token. This requires each of the file processors to handle + FORMAT separately. + + In Shorewall 4.5.11, the ?FORMAT Directive was created to centralize + processing of FORMAT directives. The old entries, while still supported, + are now deprecated. + + The format directive is as follows: + + + + ?FORMAT format + + + Where format is an integer. In all cases, the default format + is 1. The following table shows the files that have different + formats and the supported formats for each. + + + + + + + + + FILE + + FORMATS + + + + action files (action.*) + + 1 and 2 + + + + conntrack + + 1, 2 and 3 + + + + interfaces + + 1 and 2 + + + + macro files (macro.*) + + 1 and 2 + + + + tcrules + + 1 and 2 + + + + +
+
CONFIG_PATH