From 2845ffb4bb853b62eed5c3685710ecc7cddd17e0 Mon Sep 17 00:00:00 2001
From: Tom Eastep <teastep@shorewall.net>
Date: Thu, 14 Feb 2013 09:35:31 -0800
Subject: [PATCH] Document perl_action_tcp_helper

Signed-off-by: Tom Eastep <teastep@shorewall.net>
---
 docs/Actions.xml | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/docs/Actions.xml b/docs/Actions.xml
index 5f5cb9472..5c97c366e 100644
--- a/docs/Actions.xml
+++ b/docs/Actions.xml
@@ -948,10 +948,51 @@ bar:debug</programlisting>
           </note>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term>Shorewall::Rules::perl_action_tcp_helper( $target, $proto
+        )</term>
+
+        <listitem>
+          <para>This function is similar to
+          Shorewall::Rules::perl_action_helper but is taylored for specifying
+          options to "-p tcp".</para>
+
+          <para>To use this function, you must include:</para>
+
+          <simplelist>
+            <member><emphasis role="bold">use
+            Shorewall::Rules;</emphasis></member>
+          </simplelist>
+
+          <para>Arguments are:</para>
+
+          <variablelist>
+            <varlistentry>
+              <term>$target</term>
+
+              <listitem>
+                <para>The target of the rule. Legal values are anything that
+                can appear in the TARGET column of in an action body and may
+                include log level, tag, and parameters.</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>$proto</term>
+
+              <listitem>
+                <para>The '-p' part of the rule to be generated (e.g., "-p tcp
+                --tcp-flags RST RST").</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </listitem>
+      </varlistentry>
     </variablelist>
 
-    <para>For an example of using these services, look at the standard action
-    <filename>/usr/share/shorewall/action.TCPFlags</filename>.</para>
+    <para>For examples of using these services, look at the standard actions
+    in <filename>/usr/share/shorewall/action.*</filename>.</para>
   </section>
 
   <section id="Extension">