1 // Copyright (c) The Tor Project, Inc.
2 // See LICENSE for licensing information
3 // This is an asciidoc file used to generate the manpage/html reference.
4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
11 tor-fw-helper - Manage upstream firewall/NAT devices
15 **tor-fw-helper** [-h|--help] [-T|--test] [-v|--verbose] [-g|--fetch-public-ip]
16 -i|--internal-or-port __TCP port__ [-e|--external-or-port _TCP port_]
17 [-d|--internal-dir-port _TCP port_] [-p|--external-dir-port _TCP port_]
21 **tor-fw-helper** currently supports Apple's NAT-PMP protocol and the UPnP
22 standard for TCP port mapping. It is written as the reference implementation of
23 tor-fw-helper-spec.txt and conforms to that loose plugin API. If your network
24 supports either NAT-PMP or UPnP, tor-fw-helper will attempt to automatically
25 map the required TCP ports for Tor's Or and Dir ports. +
29 **-h** or **--help**::
30 Display help text and exit.
33 Display verbose output.
35 **-T** or **--test**::
36 Display test information and print the test information in
39 **-g** or **--fetch-public-ip**::
40 Fetch the the public ip address for each supported NAT helper method.
42 **-i** or **--internal-or-port** __port__::
43 Inform **tor-fw-helper** of your internal OR port. This is the only
46 **-e** or **--external-or-port** __port__::
47 Inform **tor-fw-helper** of your external OR port.
49 **-d** or **--internal-dir-port** __port__::
50 Inform **tor-fw-helper** of your internal Dir port.
52 **-p** or **--external-dir-port** __port__::
53 Inform **tor-fw-helper** of your external Dir port.
57 This probably doesn't run on Windows. That's not a big issue, since we don't
58 really want to deal with Windows before October 2010 anyway.
64 See also the "tor-fw-helper-spec.txt" file, distributed with Tor.
68 Jacob Appelbaum <jacob@torproject.org>, Steven J. Murdoch <Steven.Murdoch@cl.cam.ac.uk>