natpmp.1.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="natpmp">

	<refmeta>
		<refentrytitle>natpmp</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>natpmp</refname>
		<refpurpose>Handles port forwarding requests from clients behind a NAT</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>natpmp</command>
			<group><arg>-v</arg><arg>-q</arg></group>
			<arg>-b <arg>-p <replaceable>pidfile</replaceable></arg></arg>
			<arg choice="plain">-i <replaceable>public-interface</replaceable></arg>
			<arg choice="plain" rep="repeat">-a <replaceable>private-address</replaceable></arg>
			<arg>-t <replaceable>max-lifetime</replaceable></arg>
			<arg>-l <replaceable>lower-port</replaceable></arg>
			<arg>-u <replaceable>upper-port</replaceable></arg>
			<arg><arg>--</arg> <replaceable>backend-options</replaceable></arg>
		</cmdsynopsis>
		<cmdsynopsis>
			<command>natpmp</command>
			<arg choice="plain">-V</arg>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1><title>Description</title>
		<para>
			This is an implementation of NAT-PMP written in C.
		</para>
		<variablelist>
			<varlistentry>
				<term><option>-v</option></term>
				<listitem><para>verbose mode</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-q</option></term>
				<listitem><para>quiet mode</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-b</option></term>
				<listitem><para>fork into background</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-p <replaceable>pidfile</replaceable></option></term>
				<listitem>
					<para>
						write the process ID to <replaceable>pidfile</replaceable>,
						has only an effect when <option>-b</option> is given
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-i <replaceable>public-interface</replaceable></option></term>
				<listitem><para>use <replaceable>public-interface</replaceable> for internet site</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-a <replaceable>private-address</replaceable></option></term>
				<listitem>
					<para>use <replaceable>private-address</replaceable> for local site</para>
					<para>
						Don't use 0.0.0.0 here. Better set the ip addresses of each interface.
						<command>natpmp</command> will exit with failure when the public ip address
						changes	and the system can't find a route for sending the multicast announces.
					</para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-t <replaceable>max-lifetime</replaceable></option></term>
				<listitem><para>maximal lifetime of a mapping</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-l <replaceable>lowest-port</replaceable></option></term>
				<listitem><para>lowest port available for mappings</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-u <replaceable>upper-port</replaceable></option></term>
				<listitem><para>highest port available for mappings</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><option>-V</option></term>
				<listitem><para>print version and license information</para></listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1><title>Backends</title>
		<para>
			A backend is chosen at compile time.
			At the moment only an iptables backend is available. But there surely will be more.
		</para>
		<refsect2><title>iptables</title>
			<para>
				This backend uses GNU/Linux' iptables to do the port forwardings.
				It takes one option to specify the iptables chain to use. If not set it defaults to <parameter>natpmp</parameter>.
			</para>
		</refsect2>
	</refsect1>

	<refsect1><title>Author</title>
		<para>Written by <author><firstname>Adrian</firstname><surname>Friedli</surname></author>.</para>
	</refsect1>

	<refsect1><title>Reporting Bugs</title>
		<para>
			Please report bugs with the bug tracking system on the project page.
			<ulink url="http://savannah.nongnu.org/projects/natpmp/">http://savannah.nongnu.org/projects/natpmp/</ulink>
		</para>
	</refsect1>

	<refsect1><title>Copyright</title>
		<para>Copyright &copy; 2007 Adrian Friedli.</para>
		<para>
			This is free software.
			You may redistribute copies of it under the terms of the GNU General Public License <ulink url="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</ulink>.
			There is NO WARRANTY, to the extent permitted by law.</para>
	</refsect1>
</refentry>