Deprecate the vardir file.

This commit is contained in:
Tom Eastep 2012-04-05 08:03:31 -07:00
parent 6fb2fcbc8a
commit 334394a5d4
2 changed files with 48 additions and 1 deletions

View File

@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry> <refentry>
<refmeta> <refmeta>
<refentrytitle>shorewall-lite-vardir</refentrytitle> <refentrytitle>shorewall-lite-vardir</refentrytitle>
@ -34,6 +36,28 @@
directory. If you add this file, you should copy the files from directory. If you add this file, you should copy the files from
<filename>/var/lib/shorewall-lite</filename> to the new directory before <filename>/var/lib/shorewall-lite</filename> to the new directory before
performing a <command>shorewall-lite restart</command>.</para> performing a <command>shorewall-lite restart</command>.</para>
<note>
<para>Beginning with Shorewall 4.5.2, use of this file is deprecated in
favor of specifying VARDIR in the <filename>shorewallrc</filename> file
used during installation of Shorewall Core. While the name of the
variable remains VARDIR, the meaning is slightly different. When set in
shorewallrc, Shorewall Lite, will create a directory under the specified
path name to hold state information.</para>
<para>Example:</para>
<blockquote>
<para>VARDIR=<filename><filename>/opt/var/lib/</filename></filename></para>
<para>The state directory for Shorewall Lite will be
/opt/var/lib/shorewall-lite/.</para>
</blockquote>
<para> When VARDIR is set in /etc/shorewall-lite/vardir, Shorewall Lite
will save its state in the <replaceable>directory</replaceable>
specified.</para>
</note>
</refsect1> </refsect1>
<refsect1> <refsect1>
@ -61,4 +85,4 @@
shorewall-tcrules(5), shorewall-tos(5), shorewall-tunnels(5), shorewall-tcrules(5), shorewall-tos(5), shorewall-tunnels(5),
shorewall-zones(5)</para> shorewall-zones(5)</para>
</refsect1> </refsect1>
</refentry> </refentry>

View File

@ -36,6 +36,29 @@
directory. If you add this file, you should copy the files from directory. If you add this file, you should copy the files from
<filename>/var/lib/shorewall6-lite</filename> to the new directory before <filename>/var/lib/shorewall6-lite</filename> to the new directory before
performing a <command>shorewall6-lite restart</command>.</para> performing a <command>shorewall6-lite restart</command>.</para>
<note>
<para>Beginning with Shorewall 4.5.2, use of this file is deprecated in
favor of specifying VARDIR in the <filename>shorewallrc</filename> file
used during installation of Shorewall Core. While the name of the
variable remains VARDIR, the meaning is slightly different. When set in
shorewallrc, Shorewall6 Lite will create a directory under the specified
path name to hold state information.</para>
<para>Example:</para>
<blockquote>
<para>VARDIR=<filename>/opt/var/lib/</filename></para>
<para>The state directory for Shorewall Lite will be
<filename>/opt/var/lib/shorewall6-lite</filename>.</para>
</blockquote>
<para>When VARDIR is set in
<filename>/etc/shorewall6-lite/vardir</filename>, Shorewall Lite will
save its state in the <replaceable>directory</replaceable>
specified.</para>
</note>
</refsect1> </refsect1>
<refsect1> <refsect1>