shorewall_code/Shorewall-lite/manpages/shorewall-lite-vardir.xml

<?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>
  <refmeta>
    <refentrytitle>shorewall-lite-vardir</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo>Configuration Files</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>vardir</refname>

    <refpurpose>Shorewall Lite file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/shorewall-lite/vardir</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>This file does not exist by default. You may create the file if you
    want to change the directory used by Shorewall Lite to store state
    information, including compiled firewall scripts. By default, the
    directory used is <filename>/var/lib/shorewall-lite/</filename>.</para>

    <para>The file contains a single variable assignment:</para>

    <para><option>VARDIR=</option><replaceable>directory</replaceable></para>

    <para>where <replaceable>directory</replaceable> is the name of a
    directory. If you add this file, you should copy the files from
    <filename>/var/lib/shorewall-lite</filename> to the new directory before
    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>
    <title>Example</title>

    <para>VARDIR=/root/shorewall</para>
  </refsect1>

  <refsect1>
    <title>FILES</title>

    <para>/etc/shorewall-lite/vardir</para>
  </refsect1>

  <refsect1>
    <title>See ALSO</title>

    <para>shorewall(8), shorewall-accounting(5), shorewall-actions(5),
    shorewall-blacklist(5), shorewall-hosts(5), shorewall-interfaces(5),
    shorewall-ipsec(5), shorewall-maclist(5), shorewall-masq(5),
    shorewall-nat(5), shorewall-netmap(5), shorewall-params(5),
    shorewall-policy(5), shorewall-providers(5), shorewall-proxyarp(5),
    shorewall-route_rules(5), shorewall-routestopped(5), shorewall-rules(5),
    shorewall.conf(5), shorewall-tcclasses(5), shorewall-tcdevices(5),
    shorewall-tcrules(5), shorewall-tos(5), shorewall-tunnels(5),
    shorewall-zones(5)</para>
  </refsect1>
</refentry>