tor-fw-helper.1.txt 1.8 KB

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