doc/tor.1.in

   1 .TH TOR 1 "November 2003" "TOR"
   2 .SH NAME
   3 tor \- The second-generation onion router
   4 .SH SYNOPSIS
   5 .B tor
   6 [\fIOPTION value\fR]...
   7 .SH DESCRIPTION
   8 .I tor
   9 is a connection-oriented anonymizing communication
  10 service. Users choose a source-routed path through a set of nodes, and
  11 negotiate a "virtual circuit" through the network, in which each node
  12 knows its predecessor and successor, but no others. Traffic flowing down
  13 the circuit is unwrapped by a symmetric key at each node, which reveals
  14 the downstream node.
  15 .PP
  16 Basically \fItor\fR provides a distributed network of servers ("onion
  17 routers"). Users bounce their tcp streams -- web traffic, ftp, ssh, etc --
  18 around the routers, and recipients, observers, and even the routers
  19 themselves have difficulty tracking the source of the stream.
  20 .SH OPTIONS
  21 \fB-h, -help\fP
  22 Display a short help message and exit.
  23 .TP
  24 \fB-f \fR\fIFILE\fP
  25 FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
  26 .TP
  27 Other options can be specified either on the commandline (\fI--option value\fR), or in the configuration file (\fIoption value\fR).
  28 .TP
  29 \fBloglevel debug|info|warn|err\fP
  30 Set the verboseness level of the primary log. (Default: warn)
  31 .TP
  32 \fBlogfile \fR\fIFILE\fP
  33 Rather than logging to stdout, log to FILE.
  34 .TP
  35 \fBbandwidthrate \fR\fINUM\fP
  36 A token bucket limits the average incoming bandwidth on this node to NUM bytes per second. (Default: 800000)
  37 .TP
  38 \fBbandwidthburst \fR\fINUM\fP
  39 Limit the maximum token bucket size (also known as the burst) to NUM bytes. (Default: 10000000)
  40 .TP
  41 \fBdebuglogfile \fR\fIFILE\fP
  42 In addition to other logging, we will log to FILE at log-level debug.
  43 .TP
  44 \fBgroup \fR\fIGID\fP
  45 On startup, setgid to this user.
  46 .TP
  47 \fBkeepaliveperiod \fR\fINUM\fP
  48 To keep firewalls from expiring connections, send a padding keepalive cell on open connections every NUM seconds. (Default: 300)
  49 .TP
  50 \fBpidfile \fR\fIFILE\fP
  51 On startup, write our PID to FILE. On clean shutdown, remove FILE.
  52 .TP
  53 \fBrouterfile \fR\fIFILE\fP
  54 FILE contains a list of directory servers, to bootstrap into the network. (Default: @CONFDIR@/dirservers)
  55 .TP
  56 \fBrunasdaemon \fR\fI0|1\fP
  57 If 1, Tor forks and daemonizes to the background. (Default: 0)
  58 .TP
  59 \fBuser \fR\fIUID\fP
  60 On startup, setuid to this user.
  61
  62 .SH CLIENT OPTIONS
  63 .PP
  64 The following options are useful only for clients (that is, if \fBsocksport\fP is non-zero):
  65 .TP
  66 \fBentrynodes \fR\fInickname,nickname,...\fP
  67 A list of preferred nodes to use for the first hop in the circuit, if possible.
  68 .TP
  69 \fBexitnodes \fR\fInickname,nickname,...\fP
  70 A list of preferred nodes to use for the last hop in the circuit, if possible.
  71 .TP
  72 \fBexcludenodes \fR\iInickname,nickname,...\fP
  73 A list of nodes to never use when building a circuit.
  74 .TP
  75 \fBnewcircuitperiod \fR\fINUM\fP
  76 Every NUM seconds consider whether to build a new circuit. (Default: 60)
  77 .TP
  78 \fBpathlencoinweight \fR\fI0.0-1.0\fP
  79 Paths are 3 hops plus a geometric distribution centered around this coinweight. Must be >=0.0 and <1.0. (Default: 0.3)
  80 .TP
  81 \fBsocksport \fR\fIPORT\fP
  82 Bind to this port to listen for connections from socks-speaking applications.
  83 .TP
  84 \fBsocksbindaddress \fR\fIIP\fP
  85 Bind to this address to listen for connections from socks-speaking applications. (Default: 127.0.0.1)
  86
  87 .SH SERVER OPTIONS
  88 .PP
  89 The following options are useful only for servers (that is, if \fBorport\fP is non-zero):
  90 .TP
  91 \fBaddress address\fP
  92 The fqdn of this server (e.g. moria.mit.edu).
  93 .TP
  94 \fBdatadirectory \fR\fIDIR\fP
  95 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  96 .TP
  97 \fBexitpolicy \fR\fIpolicy,policy,...\fP
  98 Set an exit policy for this server. Each policy is of the form
  99 "\fBreject\fP \fIADDR\fP\fB/\fP\fIMASK\fP\fB:\fP\fIPORT\fP".
 100 If \fB/\fP\fIMASK\fP is ommitted then this policy just applies to the host
 101 given.  Instead of giving a host or network you can also use "\fB*\fP" to
 102 denote the universe (0.0.0.0/0).  \fIPORT\fP can either be a single port number
 103 or an interval of ports: "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP".
 104
 105 For example, "reject 127.0.0.1:*,reject 192.168.1.0/24:*,accept *:*" would
 106 reject any traffic destined for localhost and any 192.168.1.* address, but
 107 accept anything else.
 108 .TP
 109 \fBmaxonionspending \fR\fINUM\fP
 110 If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
 111 .TP
 112 \fBnickname \fR\fIname\fP
 113 Set the server's nickname to 'name'.
 114 .TP
 115 \fBnumcpus \fR\fInum\fP
 116 How many processes to use at once for decrypting onionskins. (Default: 1)
 117 .TP
 118 \fBorport \fR\fIPORT\fP
 119 Bind to this port to listen for connections from Tor clients and servers.
 120 .TP
 121 \fBorbindaddress \fR\fIIP\fP
 122 Bind to this address to listen for connections from Tor clients and servers. (Default: 0.0.0.0)
 123
 124 .SH DIRECTORY SERVER OPTIONS
 125 .PP
 126 The following options are useful only for directory servers (that is, if \fBdirport\fP is non-zero):
 127 .TP
 128 \fBdirport \fR\fIPORT\fP
 129 Bind the directory service to this port.
 130 .TP
 131 \fBdirbindaddress \fR\fIIP\fP
 132 Bind the directory service to this address. (Default: 0.0.0.0)
 133 .TP
 134 \fBrecommendedversions \fR\fISTRING\fP
 135 STRING is a command-separated list of Tor versions currently believed to be safe. The list is included in each directory, and nodes which pull down the directory learn whether they need to upgrade.
 136
 137 .SH HIDDEN SERVER OPTIONS
 138 .PP
 139 The following options are used to configure a hidden service.
 140 .TP
 141 \fBhiddenservicedir \fR\fIDIRECTORY\fP
 142 Store data files for a hidden service in DIRECTORY.  Every hidden
 143 service must have a separate directory.  You may use this option multiple
 144 times to specify multiple services.
 145 .TP
 146 \fBhiddenserviceport \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
 147 Configure a virtual port VIRTPORT for a hidden service.  You may use this
 148 option multiple times; each time applies to the service using the most recent
 149 hiddenservicedir.  By default, this option maps the virtual port to the
 150 same port on 127.0.0.1.  You may override the target port, address, or both
 151 by specifying a target of addr, port, or addr:port.
 152 .TP
 153 \fBhiddenservicenodes \fR\fInickname,nicknamme,...\fP
 154 If possible, use the specified nodes as introduction points for the hidden
 155 service.
 156 .TP
 157 \fBhiddenserviceexcludenodes \fR\fInickname,nicknamme,...\fP
 158 Do not use the specified nodes as introduction points for the hidden
 159 service.
 160
 161 .SH FILES
 162 .TP
 163 .I @CONFDIR@/torrc
 164 The configuration file, which contains "option value" pairs.
 165 .TP
 166 .I @CONFDIR@/dirservers
 167 A list of directory servers, to bootstrap into the network.
 168 .TP
 169 .I @LOCALSTATEDIR@/lib/tor/
 170 The tor server stores keys/etc here.
 171
 172 .SH SEE ALSO
 173 .BR privoxy (1),
 174 .BR tsocks (1)
 175
 176 .BR http://freehaven.net/tor/
 177
 178 .SH BUGS
 179 Plenty, probably. It's still in alpha. Please report them.
 180 .SH AUTHORS
 181 Roger Dingledine <arma@mit.edu>.
 182