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] [-v|--verbose] [-g|--fetch-public-ip]
  18  -i|--internal-or-port __TCP port__ [-e|--external-or-port _TCP port_]
  19  [-d|--internal-dir-port _TCP port_] [-p|--external-dir-port _TCP port_]
  20
  21 DESCRIPTION
  22 -----------
  23 **tor-fw-helper** currently supports Apple's NAT-PMP protocol and the UPnP
  24 standard for TCP port mapping. It is written as the reference implementation of
  25 tor-fw-helper-spec.txt and conforms to that loose plugin API.  If your network
  26 supports either NAT-PMP or UPnP, tor-fw-helper will attempt to automatically
  27 map the required TCP ports for Tor's Or and Dir ports. +
  28
  29 OPTIONS
  30 -------
  31 **-h** or **--help**::
  32     Display help text and exit.
  33
  34 **-v**::
  35     Display verbose output.
  36
  37 **-T** or **--test**::
  38     Display test information and print the test information in
  39     tor-fw-helper.log
  40
  41 **-g** or **--fetch-public-ip**::
  42     Fetch the the public ip address for each supported NAT helper method.
  43
  44 **-p** or **--forward-port** __external_port__:__internal_port__::
  45     Forward external_port to internal_port.
  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>