extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2024-11-15 04:04:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clean up conditional include documentation.

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2012-04-06 11:50:22 -07:00
parent 53395e788d
commit f85321e201
1 changed files with 31 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/configuration_file_basics.xml
View File

@ -1453,7 +1453,7 @@ SHELL cat /etc/shorewall/rules.d/*.rules 2&gt; /dev/null || true</programlisting
<para>The general form is:</para>
<programlisting>?IF [!] <replaceable>$variable
<programlisting>?IF <replaceable>$variable
</replaceable>&lt;lines to be included if $variable is non-empty and non-zero&gt;
@ -1486,22 +1486,41 @@ SHELL cat /etc/shorewall/rules.d/*.rules 2&gt; /dev/null || true</programlisting
</variablelist>
<para>Unless <replaceable>variable</replaceable> is one of these
pre-defined ones, it is searched for in the compiler's environmental
variables, in variables set in <filename>/etc/shorewall/params</filename>,
and in options set in <filename>/etc/shorewall/shorewall.conf</filename>
in that order. If the <replaceable>variable</replaceable> is still not
found and it begins with '__', then those leading characters are stripped
off and the result is searched for in the defined
<firstterm>capabilities</firstterm>. The current set of capabilities may
be obtained by the command <command>shorewall show capabilities</command>
(the capability names are in parentheses).</para>
pre-defined ones, it is searched for in the following places in the order
listed:</para>
<itemizedlist>
<listitem>
<para>the compiler's environmental variables.</para>
</listitem>
<listitem>
<para>variables set in
<filename>/etc/shorewall/params</filename>.</para>
</listitem>
<listitem>
<para>options set in
<filename>/etc/shorewall/shorewall.conf</filename>.</para>
</listitem>
<listitem>
<para>options set in the <filename>shorewallrc</filename> file when
Shorewall Core was installed.</para>
</listitem>
</itemizedlist>
<para>If the <replaceable>variable</replaceable> is still not found and it
begins with '__', then those leading characters are stripped off and the
result is searched for in the defined <firstterm>capabilities</firstterm>.
The current set of capabilities may be obtained by the command
<command>shorewall show capabilities</command> (the capability names are
in parentheses).</para>
<para>If it is not found in any of those places, the
<replaceable>variable</replaceable> is assumed to have a value of 0
(false).</para>
<para>If "!" is present, the result value is inverted.</para>
<para>The setting in <filename>/etc/shorewall/params</filename> by be
overridden at runtime, provided the setting in
<filename>/etc/shorewall/params</filename> is done like this:</para>