Răsfoiți Sursa

nat_traversal: added section ids in docs

Daniel-Constantin Mierla 8 ani în urmă
părinte
comite
642dcef142
1 a modificat fișierele cu 23 adăugiri și 23 ștergeri
  1. 23 23
      src/modules/nat_traversal/doc/nat_traversal_admin.xml

+ 23 - 23
src/modules/nat_traversal/doc/nat_traversal_admin.xml

@@ -10,9 +10,9 @@
 <!-- Module's Admin Guide -->
 <!-- Module's Admin Guide -->
 
 
 <chapter>
 <chapter>
-  
+
   <title>&adminguide;</title>
   <title>&adminguide;</title>
-  
+
   <section>
   <section>
   <title>Overview</title>
   <title>Overview</title>
     <para>
     <para>
@@ -33,7 +33,7 @@
       and hasn't been adapted to support IPv6 session keepalives.
       and hasn't been adapted to support IPv6 session keepalives.
     </para>
     </para>
   </section>
   </section>
-  
+
   <section>
   <section>
   <title>Keepalive functionality</title>
   <title>Keepalive functionality</title>
     <section>
     <section>
@@ -230,7 +230,7 @@
               <emphasis>REGISTER</emphasis> - called before save_location() or
               <emphasis>REGISTER</emphasis> - called before save_location() or
               t_relay() (depending on whether the proxy that received the
               t_relay() (depending on whether the proxy that received the
               REGISTER is also handling registration for that subscriber or
               REGISTER is also handling registration for that subscriber or
-              not). It will determine from either the stateless reply 
+              not). It will determine from either the stateless reply
               generated by save_location() or the TM relayed reply if the
               generated by save_location() or the TM relayed reply if the
               registration was successful and what is its expiration time. If
               registration was successful and what is its expiration time. If
               the registration was successful it will mark the given NAT
               the registration was successful it will mark the given NAT
@@ -280,7 +280,7 @@
               if they are behind NAT. This is done by detecting if any of the
               if they are behind NAT. This is done by detecting if any of the
               destination endpoints already has a keepalive entry for the
               destination endpoints already has a keepalive entry for the
               register condition. If so, a dialog condition will be added to
               register condition. If so, a dialog condition will be added to
-              that entry thus preserving that endpoint visibility even if the 
+              that entry thus preserving that endpoint visibility even if the
               registration expires during the dialog or is moved to another
               registration expires during the dialog or is moved to another
               proxy. During the call setup stage, multiple entries for the
               proxy. During the call setup stage, multiple entries for the
               callee may be added with the dialog condition if parallel
               callee may be added with the dialog condition if parallel
@@ -354,8 +354,8 @@
       </para>
       </para>
     </section>
     </section>
   </section>
   </section>
-  
-  <section>
+
+  <section id="nat_traversal.p.keepalive_interval">
   <title>Exported parameters</title>
   <title>Exported parameters</title>
     <section>
     <section>
     <title><varname>keepalive_interval</varname> (integer)</title>
     <title><varname>keepalive_interval</varname> (integer)</title>
@@ -379,8 +379,8 @@ modparam("nat_traversal", "keepalive_interval", 90)
         </programlisting>
         </programlisting>
       </example>
       </example>
     </section>
     </section>
-  
-    <section>
+
+    <section id="nat_traversal.p.keepalive_method">
     <title><varname>keepalive_method</varname> (string)</title>
     <title><varname>keepalive_method</varname> (string)</title>
       <para>
       <para>
         What SIP method to use to send keepalive messages. Typical methods
         What SIP method to use to send keepalive messages. Typical methods
@@ -416,8 +416,8 @@ modparam("nat_traversal", "keepalive_method", "OPTIONS")
         </programlisting>
         </programlisting>
       </example>
       </example>
     </section>
     </section>
-  
-    <section>
+
+    <section id="nat_traversal.p.keepalive_from">
     <title><varname>keepalive_from</varname> (string)</title>
     <title><varname>keepalive_from</varname> (string)</title>
       <para>
       <para>
         Indicates what SIP URI to use in the From header of the keepalive
         Indicates what SIP URI to use in the From header of the keepalive
@@ -441,8 +441,8 @@ modparam("nat_traversal", "keepalive_from", "sip:[email protected]")
         </programlisting>
         </programlisting>
       </example>
       </example>
     </section>
     </section>
-  
-    <section>
+
+    <section id="nat_traversal.p.keepalive_extra_headers">
     <title><varname>keepalive_extra_headers</varname> (string)</title>
     <title><varname>keepalive_extra_headers</varname> (string)</title>
       <para>
       <para>
         Specifies extra headers that should be added to the keepalive messages
         Specifies extra headers that should be added to the keepalive messages
@@ -464,8 +464,8 @@ modparam("nat_traversal", "keepalive_extra_headers", "User-Agent: &kamailio;\r\n
         </programlisting>
         </programlisting>
       </example>
       </example>
     </section>
     </section>
-  
-    <section>
+
+    <section id="nat_traversal.p.keepalive_state_file">
     <title><varname>keepalive_state_file</varname> (string)</title>
     <title><varname>keepalive_state_file</varname> (string)</title>
       <para>
       <para>
         Specifies a filename where information about the NAT endpoints and the
         Specifies a filename where information about the NAT endpoints and the
@@ -497,10 +497,10 @@ modparam("nat_traversal", "keepalive_state_file", "/var/run/kamailio/keepalive_s
         </programlisting>
         </programlisting>
       </example>
       </example>
     </section>
     </section>
-  
+
   </section>
   </section>
 
 
-  <section>
+  <section id="nat_traversal.f.client_nat_test">
   <title>Exported functions</title>
   <title>Exported functions</title>
     <section>
     <section>
     <title>
     <title>
@@ -517,7 +517,7 @@ modparam("nat_traversal", "keepalive_state_file", "/var/run/kamailio/keepalive_s
         <itemizedlist>
         <itemizedlist>
         <listitem><para>
         <listitem><para>
           1 - tests if client has a private IP address (as defined by RFC1918)
           1 - tests if client has a private IP address (as defined by RFC1918)
-              or one from shared address space (RFC6598) in the Contact field 
+              or one from shared address space (RFC6598) in the Contact field
               of the SIP message.
               of the SIP message.
         </para></listitem>
         </para></listitem>
         <listitem><para>
         <listitem><para>
@@ -527,7 +527,7 @@ modparam("nat_traversal", "keepalive_state_file", "/var/run/kamailio/keepalive_s
         </para></listitem>
         </para></listitem>
         <listitem><para>
         <listitem><para>
           4 - tests if client has a private IP address (as defined by RFC1918)
           4 - tests if client has a private IP address (as defined by RFC1918)
-              or one from shared address space (RFC6598) in the top Via field 
+              or one from shared address space (RFC6598) in the top Via field
               of the SIP message.
               of the SIP message.
         </para></listitem>
         </para></listitem>
         </itemizedlist>
         </itemizedlist>
@@ -554,7 +554,7 @@ if (client_nat_test("3")) {
       </example>
       </example>
     </section>
     </section>
 
 
-    <section>
+    <section id="nat_traversal.f.fix_contact">
     <title>
     <title>
     <function moreinfo="none">fix_contact()</function>
     <function moreinfo="none">fix_contact()</function>
     </title>
     </title>
@@ -580,7 +580,7 @@ if (client_nat_test("3")) {
       </example>
       </example>
     </section>
     </section>
 
 
-    <section>
+    <section id="nat_traversal.f.nat_keepalive">
     <title>
     <title>
     <function moreinfo="none">nat_keepalive()</function>
     <function moreinfo="none">nat_keepalive()</function>
     </title>
     </title>
@@ -651,7 +651,7 @@ if ((method=="REGISTER" || method=="SUBSCRIBE" ||
   </section>
   </section>
 
 
   <section>
   <section>
-  <title>Exported pseudo-variables</title>
+  <title>Pseudo Variables</title>
     <section>
     <section>
     <title><varname>$keepalive.socket(nat_endpoint)</varname></title>
     <title><varname>$keepalive.socket(nat_endpoint)</varname></title>
       <para>
       <para>
@@ -747,7 +747,7 @@ if (method=="REGISTER") {
         force_rport();
         force_rport();
         $avp(s:received_uri) = $source_uri;
         $avp(s:received_uri) = $source_uri;
         # or we could add some extra parameters to it if needed
         # or we could add some extra parameters to it if needed
-        # $avp(s:received_uri) = $source_uri + ";relayed=false" 
+        # $avp(s:received_uri) = $source_uri + ";relayed=false"
     }
     }
     if (!www_authorize("", "subscriber")) {
     if (!www_authorize("", "subscriber")) {
         www_challenge("", "0");
         www_challenge("", "0");