[sr-dev] git:master: iptrtpproxy: minor doc updates

Module: sip-router Branch: master Commit: 77bcb35eb4b4fc15aeeca8cab9577e34eeaf0168 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=77bcb35… Author: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Committer: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Date: Tue Sep 21 14:13:17 2010 +0200 iptrtpproxy: minor doc updates - minor fixes + note about setting iptdir in Makefile - README regenerated --- modules/iptrtpproxy/README | 13 ++++++++++--- modules/iptrtpproxy/doc/iptrtpproxy.xml | 30 +++++++++++++++++++++++------- 2 files changed, 33 insertions(+), 10 deletions(-) diff --git a/modules/iptrtpproxy/README b/modules/iptrtpproxy/README index 7854b36..4a02c94 100644 --- a/modules/iptrtpproxy/README +++ b/modules/iptrtpproxy/README @@ -32,9 +32,9 @@ Tomas Mandys It provides similar functionality as nathelper but communicates with netfilter kernel xt_RTPPROXY module using libipt_RTPPROXY userspace - library. See http://www.2p.cz/en/netfilter_rtp_proxy All RTP streams - are manipulated directly in kernel space, no data are copied from - kernel to userspace and back, it reduces load and delay. + library. All RTP streams are manipulated directly in kernel space, no + data is copied from kernel to userspace and back, it reduces load and + delay. See http://www.2p.cz/en/netfilter_rtp_proxy for more details. The ser module is written as light-weighted, there is not implemented any dialog managment as in nathelper, the reason is that such API @@ -60,6 +60,13 @@ Tomas Mandys * netfilter xt_RTPROXY & libipt_RTPPROXY, see http://www.2p.cz/en/netfilter_rtp_proxy +Note + + The module Makefile must be edited and iptdir setup to the directory + with the iptable sources (if different from ~/iptables). Alternatively + compile the module using: + make -C modules/iptrtpproxy iptdir=path_to_iptables_src + 1.3. Parameters 1.3.1. config (string) diff --git a/modules/iptrtpproxy/doc/iptrtpproxy.xml b/modules/iptrtpproxy/doc/iptrtpproxy.xml index 7c9e039..10cfcc6 100644 --- a/modules/iptrtpproxy/doc/iptrtpproxy.xml +++ b/modules/iptrtpproxy/doc/iptrtpproxy.xml @@ -1,6 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" + [ <!ENTITY % local.common.attrib + "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'"> + <!-- Include general documentation entities --> + <!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> + %docentities; + ] +> <section id="iptrtpproxy" xmlns:xi="http://www.w3.org/2001/XInclude"> <sectioninfo> @@ -34,11 +41,12 @@ <para> It provides similar functionality as <emphasis>nathelper</emphasis> but communicates with <emphasis>netfilter</emphasis> kernel <emphasis>xt_RTPPROXY</emphasis> module using - <emphasis>libipt_RTPPROXY</emphasis> userspace library. - See <ulink url="http://www.2p.cz/en/netfilter_rtp_proxy">http://www.2p.cz/en/netfilter_rtp_proxy</ulink> - All RTP streams are - manipulated directly in kernel space, no data are copied from - kernel to userspace and back, it reduces load and delay. + <emphasis>libipt_RTPPROXY</emphasis> userspace library. + All RTP streams are + manipulated directly in kernel space, no data is copied from + kernel to userspace and back, it reduces load and delay. + See <ulink url="http://www.2p.cz/en/netfilter_rtp_proxy"> + http://www.2p.cz/en/netfilter_rtp_proxy</ulink> for more details. </para> <para> @@ -92,6 +100,14 @@ </listitem> </itemizedlist> </para> + <note><para> + The module Makefile must be edited and iptdir setup to the directory with + the iptable sources (if different from ~/iptables). Alternatively + compile the module using: + <programlisting> + make -C modules/iptrtpproxy iptdir=path_to_iptables_src + </programlisting> + </para></note> </section> <section id="iptrtpproxy.parameters">