doc/tor-fw-helper.1.txt

   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
   5 :man source:   Tor
   6 :man manual:   Tor Manual
   7 tor-fw-helper(1)
   8 ================
   9 Jacob Appelbaum
  10
  11 NAME
  12 ----
  13 tor-fw-helper - Manage upstream firewall/NAT devices
  14
  15 SYNOPSIS
  16 --------
  17 **tor-fw-helper** [-h|--help] [-T|--test-commandline] [-v|--verbose] [-g|--fetch-public-ip]
  18  [-p __external port__:__internal_port__]
  19
  20 DESCRIPTION
  21 -----------
  22 **tor-fw-helper** currently supports Apple's NAT-PMP protocol and the UPnP
  23 standard for TCP port mapping. It is written as the reference implementation of
  24 tor-fw-helper-spec.txt and conforms to that loose plugin API.  If your network
  25 supports either NAT-PMP or UPnP, tor-fw-helper will attempt to automatically
  26 map the required TCP ports for Tor's Or and Dir ports. +
  27
  28 OPTIONS
  29 -------
  30 **-h** or **--help**::
  31     Display help text and exit.
  32
  33 **-v** or **--verbose**::
  34     Display verbose output.
  35
  36 **-T** or **--test-commandline**::
  37     Display test information and print the test information in
  38     tor-fw-helper.log
  39
  40 **-g** or **--fetch-public-ip**::
  41     Fetch the the public ip address for each supported NAT helper method.
  42
  43 **-p** or **--port** __external_port__:__internal_port__::
  44     Forward external_port to internal_port.  This option can appear
  45     more than once.
  46
  47 BUGS
  48 ----
  49 This probably doesn't run on Windows. That's not a big issue, since we don't
  50 really want to deal with Windows before October 2010 anyway.
  51
  52 SEE ALSO
  53 --------
  54 **tor**(1) +
  55
  56 See also the "tor-fw-helper-spec.txt" file, distributed with Tor.
  57
  58 AUTHORS
  59 -------
  60     Jacob Appelbaum <jacob@torproject.org>, Steven J. Murdoch <Steven.Murdoch@cl.cam.ac.uk>