tor/doc/tor-fw-helper.1.txt

// Copyright (c) The Tor Project, Inc.
// See LICENSE for licensing information
// This is an asciidoc file used to generate the manpage/html reference.
// Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
tor-fw-helper(1)
================
Jacob Appelbaum

NAME
----
tor-fw-helper - Manage upstream firewall/NAT devices

SYNOPSIS
--------
**tor-fw-helper** [-h|--help] [-T|--test] [-v|--verbose] [-g|--fetch-public-ip]
 -i|--internal-or-port __TCP port__ [-e|--external-or-port _TCP port_]
 [-d|--internal-dir-port _TCP port_] [-p|--external-dir-port _TCP port_]

DESCRIPTION
-----------
**tor-fw-helper** currently supports Apple's NAT-PMP protocol and the UPnP
standard for TCP port mapping. It is written as the reference implementation of
tor-fw-helper-spec.txt and conforms to that loose plugin API.  If your network
supports either NAT-PMP or UPnP, tor-fw-helper will attempt to automatically
map the required TCP ports for Tor's Or and Dir ports. +

OPTIONS
-------
**-h** or **--help**::
    Display help text and exit.

**-v**::
    Display verbose output.

**-T** or **--test**::
    Display test information and print the test information in
    tor-fw-helper.log

**-g** or **--fetch-public-ip**::
    Fetch the the public ip address for each supported NAT helper method.

**-i** or **--internal-or-port** __port__::
    Inform **tor-fw-helper** of your internal OR port. This is the only
    required argument.

**-e** or **--external-or-port** __port__::
    Inform **tor-fw-helper** of your external OR port.

**-d** or **--internal-dir-port** __port__::
    Inform **tor-fw-helper** of your internal Dir port.

**-p** or **--external-dir-port** __port__::
    Inform **tor-fw-helper** of your external Dir port.

BUGS
----
This probably doesn't run on Windows. That's not a big issue, since we don't
really want to deal with Windows before October 2010 anyway.

SEE ALSO
--------
**tor**(1) +

See also the "tor-fw-helper-spec.txt" file, distributed with Tor.

AUTHORS
-------
    Jacob Appelbaum <jacob@torproject.org>, Steven J. Murdoch <Steven.Murdoch@cl.cam.ac.uk>