shorewall_code/docs/Manpages.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article>
  <!--$Id: template.xml 5908 2007-04-12 23:04:36Z teastep $-->

  <articleinfo>
    <title>Shorewall 4.0 Manpages</title>

    <authorgroup>
      <author>
        <firstname>Tom</firstname>

        <surname>Eastep</surname>
      </author>
    </authorgroup>

    <pubdate><?dbtimestamp format="Y/m/d"?></pubdate>

    <copyright>
      <year>2007</year>

      <holder>Thomas M. Eastep</holder>
    </copyright>

    <legalnotice>
      <para>Permission is granted to copy, distribute and/or modify this
      document under the terms of the GNU Free Documentation License, Version
      1.2 or any later version published by the Free Software Foundation; with
      no Invariant Sections, with no Front-Cover, and with no Back-Cover
      Texts. A copy of the license is included in the section entitled
      <quote><ulink url="GnuCopyright.htm">GNU Free Documentation
      License</ulink></quote>.</para>
    </legalnotice>
  </articleinfo>

  <warning>
    <para>These manpages are for Shorewall 4.0 only. They describe features
    and options not available on earlier releases.</para>
  </warning>

  <note>
    <para>The docbook to manpage translation tool that we are using has some
    indentation issues which require us to choose between correct output of
    the man command and correctly-indented HTML. We've chosen in favor of the
    man command so some of the manpages accessed through the links below have
    indentation problems. We're working to resolve these issues and ask for
    your patience.</para>
  </note>

  <section id="Section5">
    <title>Section 5 — Files and Concepts</title>

    <simplelist>
      <member><ulink
      url="manpages/shorewall-accounting.html">accounting</ulink> - Define IP
      accounting rules.</member>

      <member><ulink url="manpages/shorewall-actions.html">actions</ulink> -
      Declare user-defined actions.</member>

      <member><ulink url="manpages/shorewall-blacklist.html">blacklist</ulink>
      - Static blacklisting.</member>

      <member><ulink url="manpages/shorewall-ecn.html">ecn</ulink> - Disabling
      Explicit Congestion Notification</member>

      <member><ulink url="manpages/shorewall-exclusion.html">exclusion</ulink>
      - Excluding hosts from a network or zone</member>

      <member><ulink url="manpages/shorewall-hosts.html">hosts</ulink> -
      Define multiple zones accessed through a single interface</member>

      <member><ulink url="shorewall-interfaces.html">interfaces</ulink> -
      Define the interfaces on the system and optionally associate them with
      zones.</member>

      <member><ulink url="manpages/shorewall-maclist.html">maclist</ulink> -
      Define MAC verification.</member>

      <member><ulink url="manpages/shorewall-masq.html">masq</ulink> - Define
      Masquerade/SNAT</member>

      <member><ulink url="manpages/shorewall-modules.html">modules</ulink> -
      Specify which kernel modules to load.</member>

      <member><ulink url="manpages/shorewall-nat.html">nat</ulink> - Define
      one-to-one NAT.</member>

      <member><ulink url="manpages/shorewall-nesting.html">nesting</ulink> -
      How to define nested zones.</member>

      <member><ulink url="manpages/shorewall-netmap.html">netmap</ulink> - How
      to map addresses from one net to another.</member>

      <member><ulink url="manpages/shorewall-params.html">params</ulink> -
      Assign values to shell variables used in other files.</member>

      <member><ulink url="manpages/shorewall-policy.html">policy</ulink> -
      Define high-level policies for connections between zones.</member>

      <member><ulink url="manpages/shorewall-providers.html">providers</ulink>
      - Define routing tables, usually for mutliple internet links.</member>

      <member><ulink url="manpages/shorewall-proxyarp.html">proxyarp</ulink> -
      Define Proxy ARP.</member>

      <member><ulink url="manpages/shorewall-rfc1918.html">rfc1918</ulink> -
      Specify address ranges affected by the <option>norfc1918</option>
      interface option.</member>

      <member><ulink
      url="manpages/shorewall-route_rules.html">route_rules</ulink> - Define
      routing rules.</member>

      <member><ulink
      url="manpages/shorewall-routestopped.html">routestopped</ulink> -
      Specify connections to be permitted when Shorewall is in the stopped
      state.</member>

      <member><ulink url="manpages/shorewall-rules.html">rules</ulink> -
      Specify exceptions to policies, including DNAT and REDIRECT.</member>

      <member><ulink url="manpages/shorewall-tcclasses.html">tcclasses</ulink>
      - Define htb classes for traffic shaping.</member>

      <member><ulink url="manpages/shorewall-tcdevices.html">tcdevices</ulink>
      - Specify speed of devices for traffic shaping.</member>

      <member><ulink url="manpages/shorewall-tcrules.html">tcrules</ulink> -
      Define packet marking rules, usually for traffic shaping.</member>

      <member><ulink url="manpages/shorewall-tos.html">tos</ulink> - Define
      TOS field manipulation.</member>

      <member><ulink url="manpages/shorewall-tunnels.html">tunnels</ulink> -
      Define VPN connections with endpoints on the firewall.</member>

      <member><ulink url="manpages/shorewall.conf.html">shorewall.conf</ulink>
      - Specify values for global Shorewall options.</member>

      <member><ulink
      url="manpages/shorewall.conf.html">shorewall-lite.conf</ulink> - Specify
      values for global Shorewall Lite options.</member>

      <member><ulink url="manpages/shorewall-vardir.html">vardir</ulink> -
      Redefine the directory where Shorewall keeps its state
      information.</member>

      <member><ulink
      url="manpages/shorewall-lite-vardir.html">vardir-lite</ulink> - Redefine
      the directory where Shorewall Lite keeps its state information.</member>

      <member><ulink url="manpages/shorewall-zones.html">zones</ulink> -
      Declare Shorewall zones.l</member>
    </simplelist>
  </section>

  <section id="Section8">
    <title>Section 8 — Administrative Commands</title>

    <simplelist>
      <member><ulink url="manpages/shorewall.html">shorewall</ulink> -
      /sbin/shorewall command syntax and semantics.</member>

      <member><ulink url="manpages/shorewall-lite.html">shorewall-lite</ulink>
      - /sbin/shorewall-lite command syntax and semantics.</member>
    </simplelist>
  </section>
</article>