keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 1) Content-type: text/html
tor-manual.html 2)
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 3) <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 4) <HTML><HEAD><TITLE>Man page of TOR</TITLE>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 5) </HEAD><BODY>
tor.manual.html 6) <H1>TOR</H1>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 7) Section: User Commands (1)<BR>Updated: November 2004<BR><A HREF="#index">Index</A>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 8) <A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
tor.manual.html 9)
tor.manual.html 10) <A NAME="lbAB"> </A>
tor.manual.html 11) <H2>NAME</H2>
tor.manual.html 12)
tor.manual.html 13) tor - The second-generation onion router
tor.manual.html 14) <A NAME="lbAC"> </A>
tor.manual.html 15) <H2>SYNOPSIS</H2>
tor.manual.html 16)
tor.manual.html 17) <B>tor</B>
tor.manual.html 18)
tor.manual.html 19) [<I>OPTION value</I>]...
tor.manual.html 20) <A NAME="lbAD"> </A>
tor.manual.html 21) <H2>DESCRIPTION</H2>
tor.manual.html 22)
tor.manual.html 23) <I>tor</I>
tor.manual.html 24)
tor.manual.html 25) is a connection-oriented anonymizing communication
tor.manual.html 26) service. Users choose a source-routed path through a set of nodes, and
tor.manual.html 27) negotiate a "virtual circuit" through the network, in which each node
tor.manual.html 28) knows its predecessor and successor, but no others. Traffic flowing down
tor.manual.html 29) the circuit is unwrapped by a symmetric key at each node, which reveals
tor.manual.html 30) the downstream node.
tor.manual.html 31) <P>
tor.manual.html 32)
tor.manual.html 33) Basically <I>tor</I> provides a distributed network of servers ("onion
tor.manual.html 34) routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc --
tor.manual.html 35) around the routers, and recipients, observers, and even the routers
tor.manual.html 36) themselves have difficulty tracking the source of the stream.
tor.manual.html 37) <A NAME="lbAE"> </A>
tor.manual.html 38) <H2>OPTIONS</H2>
tor.manual.html 39)
tor.manual.html 40) <B>-h, -help</B>
tor.manual.html 41) Display a short help message and exit.
tor.manual.html 42) <DL COMPACT>
tor.manual.html 43) <DT><B>-f </B><I>FILE</I><DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 44) FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 45) <DT>Other options can be specified either on the command-line (<I>--option<DD>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 46) value</I>), or in the configuration file (<I>option value</I>).
tor.manual.html 47) Options are case-insensitive.
tor.manual.html 48) <DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>stderr</B>|<B>stdout</B>|<B>syslog</B><DD>
tor.manual.html 49) Send all messages between <I>minSeverity</I> and <I>maxSeverity</I> to
tor.manual.html 50) the standard output stream, the standard error stream, or to the system
tor.manual.html 51) log. (The "syslog" value is only supported on Unix.) Recognized
tor.manual.html 52) severity levels are debug, info, notice, warn, and err. If only one
tor.manual.html 53) severity level is given, all messages of that level or higher will be
tor.manual.html 54) sent to the listed destination.
tor.manual.html 55) <DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>file</B> <I>FILENAME</I><DD>
tor.manual.html 56) As above, but send log messages to the listed filename. The "Log"
tor.manual.html 57) option may appear more than once in a configuration file. Messages
tor.manual.html 58) are sent to all the logs that match their severity level.
tor.manual.html 59) <DT><B>BandwidthRate </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
tor.manual.html 60) A token bucket limits the average incoming bandwidth on this node to
tor.manual.html 61) the specified number of bytes per second. (Default: 780 KB)
tor.manual.html 62) <DT><B>BandwidthBurst </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
tor.manual.html 63) Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 48 MB)
tor.manual.html 64) <DT><B>DataDirectory </B><I>DIR</I><DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 65) Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 66) <DT><B>DirServer </B><I>address:port fingerprint</I><DD>
tor.manual.html 67) Use a nonstandard authoritative directory server at the provided
tor.manual.html 68) address and port, with the specified key fingerprint. This option can
tor.manual.html 69) be repeated many times, for multiple authoritative directory
tor.manual.html 70) servers. If no <B>dirserver</B> line is given, Tor will use the default
tor.manual.html 71) directory servers: moria1, moria2, and tor26.
tor.manual.html 72) <DT><B>Group </B><I>GID</I><DD>
tor.manual.html 73) On startup, setgid to this user.
tor.manual.html 74) <DT><B>HttpProxy</B> <I>host</I>[:<I>port</I>]<DD>
tor.manual.html 75) If set, Tor will make all its directory requests through this host:port,
tor.manual.html 76) rather than connecting directly to any directory servers.
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 77) <DT><B>HttpsProxy</B> <I>host</I>[:<I>port</I>]<DD>
tor-manual.html 78) If set, Tor will make all its OR (SSL) connections through this host:port,
tor-manual.html 79) via HTTP CONNECT, rather than connecting directly to servers.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 80) <DT><B>KeepalivePeriod </B><I>NUM</I><DD>
tor.manual.html 81) To keep firewalls from expiring connections, send a padding keepalive
tor.manual.html 82) cell on open connections every NUM seconds. (Default: 5 minutes.)
tor.manual.html 83) <DT><B>MaxConn </B><I>NUM</I><DD>
tor.manual.html 84) Maximum number of simultaneous sockets allowed. You probably don't need
tor.manual.html 85) to adjust this. (Default: 1024)
tor.manual.html 86) <DT><B>OutboundBindAddress </B><I>IP</I><DD>
tor.manual.html 87) Make all outbound connections originate from the IP address specified. This
tor.manual.html 88) is only useful when you have multiple network interfaces, and you want all
tor.manual.html 89) of Tor's outgoing connections to use a single one.
tor.manual.html 90) <DT><B>PIDFile </B><I>FILE</I><DD>
tor.manual.html 91) On startup, write our PID to FILE. On clean shutdown, remove FILE.
tor.manual.html 92) <DT><B>RunAsDaemon </B><B>0</B>|<B>1</B><DD>
tor.manual.html 93) If 1, Tor forks and daemonizes to the background. (Default: 0)
tor.manual.html 94) <DT><B>User </B><I>UID</I><DD>
tor.manual.html 95) On startup, setuid to this user.
tor.manual.html 96) <DT><B>ControlPort </B><I>Port</I><DD>
tor.manual.html 97) If set, Tor will accept connections from the same machine (localhost only) on
tor.manual.html 98) this port, and allow those connections to control the Tor process using the
tor.manual.html 99) Tor Control Protocol (described in control-spec.txt). Note: unless you also
tor.manual.html 100) specify one of <B>HashedControlPassword</B> or <B>CookieAuthentication</B>,
tor.manual.html 101) setting this option will cause Tor to allow any process on the local host to
tor.manual.html 102) control it.
tor.manual.html 103) <DT><B>HashedControlPassword </B><I>hashed_password</I><DD>
tor.manual.html 104) Don't allow any connections on the control port except when the other process
tor.manual.html 105) knows the password whose one-way hash is <I>hashed_password</I>. You can
tor.manual.html 106) compute the hash of a password by running "tor --hash-password
tor.manual.html 107) <I>password</I>".
tor.manual.html 108) <DT><B>CookieAuthentication </B><B>0</B>|<B>1</B><DD>
tor.manual.html 109) If this option is set to 1, don't allow any connections on the control port
tor.manual.html 110) except when the connecting process knows the contents of a file named
tor.manual.html 111) "control_auth_cookie", which Tor will create in its data directory. This
tor.manual.html 112) authentication methods should only be used on systems with good filesystem
tor.manual.html 113) security.
tor.manual.html 114) <B>DirFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B>
tor.manual.html 115) Every time the specified period elapses, Tor downloads a directory.
tor.manual.html 116) A directory contains a signed list of all known servers as well as
tor.manual.html 117) their current liveness status. (Default: 1 hour)
tor.manual.html 118) <DT><B>StatusFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
tor.manual.html 119) Every time the specified period elapses, Tor downloads signed status
tor.manual.html 120) information about the current state of known servers. (Default: 20 minutes.)
tor.manual.html 121) <DT><B>RendPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
tor.manual.html 122) Every time the specified period elapses, Tor uploads any rendezvous
tor.manual.html 123) service descriptors to the directory servers. This information is also
tor.manual.html 124) uploaded whenever it changes. (Default: 20 minutes.)
tor.manual.html 125) <P>
tor.manual.html 126) </DL>
tor.manual.html 127) <A NAME="lbAF"> </A>
tor.manual.html 128) <H2>CLIENT OPTIONS</H2>
tor.manual.html 129)
tor.manual.html 130) <P>
tor.manual.html 131)
tor.manual.html 132) The following options are useful only for clients (that is, if <B>SOCKSPort</B> is non-zero):
tor.manual.html 133) <DL COMPACT>
tor.manual.html 134) <DT><B>AllowUnverifiedNodes</B> <B>entry</B>|<B>exit</B>|<B>middle</B>|<B>introduction</B>|<B>rendezvous</B>|...<DD>
tor.manual.html 135) Where on our circuits should we allow Tor servers that the directory
tor.manual.html 136) servers haven't authenticated as "verified"? (Default: middle,rendezvous.)
tor.manual.html 137) <DT><B>ClientOnly </B><B>0</B>|<B>1</B><DD>
tor.manual.html 138) If set to 1, Tor will under no circumstances run as a server. (Usually,
tor.manual.html 139) you don't need to set this; Tor is pretty smart at figuring out whether
tor.manual.html 140) you are reliable and high-bandwidth enough to be a good server.)
tor.manual.html 141) <DT><B>EntryNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 142) A list of preferred nodes to use for the first hop in the circuit, if possible.
tor.manual.html 143) <DT><B>ExitNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 144) A list of preferred nodes to use for the last hop in the circuit, if possible.
tor.manual.html 145) <DT><B>ExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 146) A list of nodes to never use when building a circuit.
tor.manual.html 147) <DT><B>StrictExitNodes </B><B>0</B>|<B>1</B><DD>
tor.manual.html 148) If 1, Tor will never use any nodes besides those listed in "exitnodes" for
tor.manual.html 149) the last hop of a circuit.
tor.manual.html 150) <DT><B>StrictEntryNodes </B><B>0</B>|<B>1</B><DD>
tor.manual.html 151) If 1, Tor will never use any nodes besides those listed in "entrynodes" for
tor.manual.html 152) the first hop of a circuit.
tor.manual.html 153) <DT><B>FascistFirewall </B><B>0</B>|<B>1</B><DD>
tor.manual.html 154) If 1, Tor will only create outgoing connections to ORs running on ports that
tor.manual.html 155) your firewall allows (defaults to 80 and 443; see <B>FirewallPorts</B>). This will
tor.manual.html 156) allow you to run Tor as a client behind a firewall with restrictive policies,
tor.manual.html 157) but will not allow you to run as a server behind such a firewall.
tor.manual.html 158) <DT><B>FirewallPorts </B><I>PORTS</I><DD>
tor.manual.html 159) A list of ports that your firewall allows you to connect to. Only used when
tor.manual.html 160) <B>FascistFirewall</B> is set. (Default: 80, 443.)
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 161) <DT><B>LongLivedPorts </B><I>PORTS</I><DD>
tor-manual.html 162) A list of ports for services that tend to have long-running connections
tor-manual.html 163) (e.g. chat and interactive shells). Circuits for streams that use these
tor-manual.html 164) ports will contain only high-uptime nodes, to reduce the chance that a
tor-manual.html 165) node will go down before the stream is finished.
tor-manual.html 166) <DT><B>MapAddress</B> <I>address</I> <I>newaddress</I><DD>
tor-manual.html 167) When a request for address arrives to Tor, it will rewrite it to newaddress before processing it. For example, if you always want connections to <A HREF="http://www.indymedia.org">www.indymedia.org</A> to exit via yourtorserver, use "MapAddress <A HREF="http://www.indymedia.org">www.indymedia.org</A> <A HREF="http://www.indymedia.org.yourtorserver.exit">www.indymedia.org.yourtorserver.exit</A>".
tor-manual.html 168) <DT><B>NewCircuitPeriod </B><I>NUM</I><DD>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 169) Every NUM seconds consider whether to build a new circuit. (Default: 60)
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 170) <DT><B>MaxCircuitDirtiness </B><I>NUM</I><DD>
tor-manual.html 171) Feel free to reuse a circuit that was first used at most NUM seconds
tor-manual.html 172) ago, but never attach a new stream to a circuit that is too old.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 173) <DT><B>NodeFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 174) The named Tor servers constitute a "family" of similar or co-administered
tor.manual.html 175) servers, so never use any two of them in the same circuit. Defining a
tor.manual.html 176) NodeFamily is only needed when a server doesn't list the family itself
tor.manual.html 177) (with MyFamily). This option can be used multiple times.
tor.manual.html 178) <DT>
tor.manual.html 179) <DD>
tor.manual.html 180)
tor.manual.html 181)
tor.manual.html 182) <B>RendNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I>
tor.manual.html 183) A list of preferred nodes to use for the rendezvous point, if possible.
tor.manual.html 184) <DT><B>RendExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 185) A list of nodes to never use when choosing a rendezvous point.
tor.manual.html 186) <DT><B>SOCKSPort </B><I>PORT</I><DD>
tor.manual.html 187) Bind to this port to listen for connections from SOCKS-speaking applications.
tor.manual.html 188) Set this to 0 if you don't want to allow application connections. (Default:
tor.manual.html 189) 9050)
tor.manual.html 190) <DT><B>SOCKSBindAddress </B><I>IP</I><DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 191) Bind to this address to listen for connections from SOCKS-speaking applications. (Default: 127.0.0.1) You can also specify a port (e.g. 192.168.0.1:9100). This directive can be specified multiple times to bind to multiple addresses/ports.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 192) <DT><B>SOCKSPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 193) Set an entrance policy for this server, to limit who can connect to the SOCKS ports. The policies have the same form as exit policies below.
tor-manual.html 194) <DT><B>TrackHostExits </B><I>host1</I>,<I>.domain1</I>|<I>.</I><DD>
tor-manual.html 195) For each value in the comma separated list, Tor will track recent connections
tor-manual.html 196) to hosts that match this value and attempt to
tor-manual.html 197) reuse the same exit node for each. If the value is prepended with a '.', it is
tor-manual.html 198) treated as matching an entire domain. If one of the values is just a '.', it
tor-manual.html 199) means match everything. This option is useful if you frequently connect to
tor-manual.html 200) sites that will expire all your authentication cookies (ie log you out) if
tor-manual.html 201) your IP address changes. Note that this option does have the disadvantage of
tor-manual.html 202) making it more clear that a given history is
tor-manual.html 203) associated with a single user. However, most people who would wish to observe
tor-manual.html 204) this will observe it through cookies or other protocol-specific means anyhow.
tor-manual.html 205) <DT><B>TrackHostExitsExpire </B><I>NUM</I><DD>
tor-manual.html 206) Since exit servers go up and down, it is desirable to expire the association
tor-manual.html 207) between host and exit server after NUM seconds of inactivity. The default
tor-manual.html 208) is 1800 seconds (30 minutes).
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 209) <P>
tor.manual.html 210) </DL>
tor.manual.html 211) <A NAME="lbAG"> </A>
tor.manual.html 212) <H2>SERVER OPTIONS</H2>
tor.manual.html 213)
tor.manual.html 214) <P>
tor.manual.html 215)
tor.manual.html 216) The following options are useful only for servers (that is, if <B>ORPort</B> is non-zero):
tor.manual.html 217) <DL COMPACT>
tor.manual.html 218) <DT><B>Address </B><I>address</I><DD>
tor.manual.html 219) The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this
tor.manual.html 220) unset, and Tor will guess your IP.
tor.manual.html 221) <DT><B>ContactInfo </B><I>email_address</I><DD>
tor.manual.html 222) Administrative contact information for server.
tor.manual.html 223) <DT><B>ExitPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
tor.manual.html 224) Set an exit policy for this server. Each policy is of the form
tor.manual.html 225) "<B>accept</B>|<B>reject</B> <I>ADDR</I>[<B>/</B><I>MASK</I>]<B>:</B><I>PORT</I>".
tor.manual.html 226) If <B>/</B><I>MASK</I> is omitted then this policy just applies to the host
tor.manual.html 227) given. Instead of giving a host or network you can also use "<B>*</B>" to
tor.manual.html 228) denote the universe (0.0.0.0/0). <I>PORT</I> can be a single port number,
tor.manual.html 229) an interval of ports "<I>FROM_PORT</I><B>-</B><I>TO_PORT</I>", or "<B>*</B>".
tor.manual.html 230) <P>
tor.manual.html 231) For example, "reject 127.0.0.1:*,reject 192.168.1.0/24:*,accept *:*" would
tor.manual.html 232) reject any traffic destined for localhost and any 192.168.1.* address, but
tor.manual.html 233) accept anything else.
tor.manual.html 234) <P>
tor.manual.html 235) This directive can be specified multiple times so you don't have to put
tor.manual.html 236) it all on one line.
tor.manual.html 237) <P>
tor.manual.html 238) See RFC 3330 for more details about internal and reserved IP address
tor.manual.html 239) space. Policies are considered first to last, and the first match wins. If
tor.manual.html 240) you want to _replace_ the default exit policy, end your exit policy with
tor.manual.html 241) either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
tor.manual.html 242) (prepending to) the default exit policy. The default exit policy is:
tor.manual.html 243)
tor.manual.html 244) <DL COMPACT><DT><DD>
tor.manual.html 245) <DL COMPACT>
tor.manual.html 246) <DT>reject 0.0.0.0/8<DD>
tor.manual.html 247) <DT>reject 169.254.0.0/16<DD>
tor.manual.html 248) <DT>reject 127.0.0.0/8<DD>
tor.manual.html 249) <DT>reject 192.168.0.0/16<DD>
tor.manual.html 250) <DT>reject 10.0.0.0/8<DD>
tor.manual.html 251) <DT>reject 172.16.0.0/12<DD>
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 252) <DT>reject *:25<DD>
tor-manual.html 253) <DT>reject *:119<DD>
tor-manual.html 254) <DT>reject *:135-139<DD>
tor-manual.html 255) <DT>reject *:445<DD>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 256) <DT>reject *:1214<DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 257) <DT>reject *:4661-4666<DD>
tor-manual.html 258) <DT>reject *:6346-6429<DD>
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 259) <DT>reject *:6699<DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 260) <DT>reject *:6881-6999<DD>
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 261) <DT>accept *:*<DD>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 262) </DL>
tor.manual.html 263) </DL>
tor.manual.html 264)
tor.manual.html 265)
tor.manual.html 266) <DT><B>MaxOnionsPending </B><I>NUM</I><DD>
tor.manual.html 267) If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
tor.manual.html 268) <DT><B>MyFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 269) Declare that this Tor server is controlled or administered by a group
tor.manual.html 270) or organization identical or similar to that of the other named servers.
tor.manual.html 271) When two servers both declare that they are in the same 'family', Tor clients
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 272) will not use them in the same circuit. (Each server only needs to list the
tor-manual.html 273) other servers in its family; it doesn't need to list itself, but it won't hurt.)
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 274) <DT><B>Nickname </B><I>name</I><DD>
tor.manual.html 275) Set the server's nickname to 'name'.
tor.manual.html 276) <DT><B>NumCPUs </B><I>num</I><DD>
tor.manual.html 277) How many processes to use at once for decrypting onionskins. (Default: 1)
tor.manual.html 278) <DT><B>ORPort </B><I>PORT</I><DD>
tor.manual.html 279) Bind to this port to listen for connections from Tor clients and servers.
tor.manual.html 280) <DT><B>ORBindAddress </B><I>IP</I><DD>
tor.manual.html 281) Bind to this address to listen for connections from Tor clients and servers. (Default: 0.0.0.0)
tor.manual.html 282) <DT><B>RedirectExit </B><I>pattern target</I><DD>
tor.manual.html 283) Whenever an outgoing connection tries to connect to one of a given set
tor.manual.html 284) of addresses, connect to <I>target</I> (an <I>address:port</I> pair) instead.
tor.manual.html 285) The address
tor.manual.html 286) pattern is given in the same format as for an exit policy. The
tor.manual.html 287) address translation applies after exit policies are applied. Multiple
tor.manual.html 288) <B>RedirectExit</B> options can be used: once any one has matched
tor.manual.html 289) successfully, no subsequent rules are considered. You can specify that no
tor.manual.html 290) redirection is to be performed on a given set of addresses by using the
tor.manual.html 291) special target string "pass", which prevents subsequent rules from being
tor.manual.html 292) considered.
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 293) <DT><B>ShutdownWaitLength</B><I>NUM</I><DD>
tor-manual.html 294) When we get a SIGINT and we're a server, we begin shutting down: we close
tor-manual.html 295) listeners and start refusing new circuits. After <B>NUM</B> seconds,
tor-manual.html 296) we exit. If we get a second SIGINT, we exit immediately. (Default:
tor-manual.html 297) 30 seconds)
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 298) <DT><B>DirPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD>
tor.manual.html 299) Every time the specified period elapses, Tor uploads its server
tor.manual.html 300) descriptors to the directory servers. This information is also
tor.manual.html 301) uploaded whenever it changes. (Default: 20 minutes.)
tor.manual.html 302) <DT><B>AccountingMax </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD>
tor.manual.html 303) Never send more than the specified number of bytes in a given
tor.manual.html 304) accounting period, or receive more than that number in the period.
tor.manual.html 305) When the number of bytes is exhausted, Tor will hibernate until some
tor.manual.html 306) time in the next accounting period. To prevent all servers from
tor.manual.html 307) waking at the same time, Tor will also wait until a random point in
tor.manual.html 308) each period before waking up. If you have bandwidth cost issues,
tor.manual.html 309) using this option is preferable to setting a low bandwidth, since it
tor.manual.html 310) provides users with a collection of fast servers that are up some of
tor.manual.html 311) the time, which is more useful than a set of slow servers that are
tor.manual.html 312) always "available".
tor.manual.html 313) <DT><B>AccountingStart </B><B>day</B>|<B>week</B>|<B>month</B> [<I>day</I>] <I>HH:MM</I><DD>
tor.manual.html 314) Specify how long accounting periods last. If <B>month</B> is given,
tor.manual.html 315) each accounting period runs from the time <I>HH:MM</I> on the
tor.manual.html 316) <I>day</I>th day of one month to the same day and time of the next.
tor.manual.html 317) (The day must be between 1 and 28.) If <B>week</B> is given, each
tor.manual.html 318) accounting period runs from the time <I>HH:MM</I> of the <I>day</I>th
tor.manual.html 319) day of one week to the same day and time of the next week, with Monday
tor.manual.html 320) as day 1 and Sunday as day 7. If <B>day</B> is given, each accounting
tor.manual.html 321) period runs from the time <I>HH:MM</I> each day to the same time on the
tor.manual.html 322) next day. All times are local, and given in 24-hour time. (Defaults to
tor.manual.html 323) "month 1 0:00".)
tor.manual.html 324) <P>
tor.manual.html 325) </DL>
tor.manual.html 326) <A NAME="lbAH"> </A>
tor.manual.html 327) <H2>DIRECTORY SERVER OPTIONS</H2>
tor.manual.html 328)
tor.manual.html 329) <P>
tor.manual.html 330)
tor.manual.html 331) The following options are useful only for directory servers (that is, if <B>DirPort</B> is non-zero):
tor.manual.html 332) <DL COMPACT>
tor.manual.html 333) <DT><B>AuthoritativeDirectory </B><B>0</B>|<B>1</B><DD>
tor.manual.html 334) When this option is set to 1, Tor operates as an authoritative
tor.manual.html 335) directory server. Instead of caching the directory, it generates its
tor.manual.html 336) own list of good servers, signs it, and sends that to the clients.
tor.manual.html 337) Unless the clients already have you listed as a trusted directory, you
tor.manual.html 338) probably do not want to set this option. Please coordinate with the other
tor.manual.html 339) admins at <A HREF="mailto:tor-ops@freehaven.net">tor-ops@freehaven.net</A> if you think you should be a directory.
tor.manual.html 340) <DT><B>DirPort </B><I>PORT</I><DD>
tor.manual.html 341) Bind the directory service to this port.
tor.manual.html 342) <DT><B>DirBindAddress </B><I>IP</I><DD>
tor.manual.html 343) Bind the directory service to this address. (Default: 0.0.0.0)
tor.manual.html 344) <DT><B>DirPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD>
tor.manual.html 345) Set an entrance policy for this server, to limit who can connect to the directory ports. The policies have the same form as exit policies above.
tor.manual.html 346) <DT><B>RecommendedVersions </B><I>STRING</I><DD>
tor.manual.html 347) STRING is a command-separated list of Tor versions currently believed
tor.manual.html 348) to be safe. The list is included in each directory, and nodes which
tor.manual.html 349) pull down the directory learn whether they need to upgrade. This
tor.manual.html 350) option can appear multiple times: the values from multiple lines are
tor.manual.html 351) spliced together.
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 352) <DT><B>DirAllowPrivateAddresses </B><B>0</B>|<B>1</B><DD>
tor-manual.html 353) If set to 1, Tor will accept router descriptors with arbitrary "Address"
tor-manual.html 354) elements. Otherwise, if the address is not an IP or is a private IP,
tor-manual.html 355) it will reject the router descriptor. Defaults to 0.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 356) <DT><B>RunTesting </B><B>0</B>|<B>1</B><DD>
tor.manual.html 357) If set to 1, Tor tries to build circuits through all of the servers it
tor.manual.html 358) knows about, so it can tell which are up and which are down. This
tor.manual.html 359) option is only useful for authoritative directories, so you probably
tor.manual.html 360) don't want to use it.
tor.manual.html 361) <P>
tor.manual.html 362) </DL>
tor.manual.html 363) <A NAME="lbAI"> </A>
tor.manual.html 364) <H2>HIDDEN SERVICE OPTIONS</H2>
tor.manual.html 365)
tor.manual.html 366) <P>
tor.manual.html 367)
tor.manual.html 368) The following options are used to configure a hidden service.
tor.manual.html 369) <DL COMPACT>
tor.manual.html 370) <DT><B>HiddenServiceDir </B><I>DIRECTORY</I><DD>
tor.manual.html 371) Store data files for a hidden service in DIRECTORY. Every hidden
tor.manual.html 372) service must have a separate directory. You may use this option multiple
tor.manual.html 373) times to specify multiple services.
tor.manual.html 374) <DT><B>HiddenServicePort </B><I>VIRTPORT </I>[<I>TARGET</I>]<DD>
tor.manual.html 375) Configure a virtual port VIRTPORT for a hidden service. You may use this
tor.manual.html 376) option multiple times; each time applies to the service using the most recent
tor.manual.html 377) hiddenservicedir. By default, this option maps the virtual port to the
tor.manual.html 378) same port on 127.0.0.1. You may override the target port, address, or both
tor.manual.html 379) by specifying a target of addr, port, or addr:port.
tor.manual.html 380) <DT><B>HiddenServiceNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 381) If possible, use the specified nodes as introduction points for the hidden
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 382) service. If this is left unset, Tor will be smart and pick some reasonable
tor-manual.html 383) ones; most people can leave this unset.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 384) <DT><B>HiddenServiceExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD>
tor.manual.html 385) Do not use the specified nodes as introduction points for the hidden
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 386) service. In normal use there is no reason to set this.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 387) <P>
tor.manual.html 388)
tor.manual.html 389)
tor.manual.html 390) <P>
tor.manual.html 391) </DL>
tor.manual.html 392) <A NAME="lbAJ"> </A>
tor.manual.html 393) <H2>SIGNALS</H2>
tor.manual.html 394)
tor.manual.html 395) Tor catches the following signals:
tor.manual.html 396) <DL COMPACT>
tor.manual.html 397) <DT><B>SIGTERM</B><DD>
tor.manual.html 398) Tor will catch this, clean up and sync to disk if necessary, and exit.
tor.manual.html 399) <DT><B>SIGINT</B><DD>
tor.manual.html 400) Tor clients behave as with SIGTERM; but Tor servers will do a controlled
tor.manual.html 401) slow shutdown, closing listeners and waiting 30 seconds before exiting.
tor.manual.html 402) <DT><B>SIGHUP</B><DD>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 403) The signal instructs Tor to reload its configuration (including closing
tor-manual.html 404) and reopening logs), fetch a new directory, and kill and restart its
tor-manual.html 405) helper processes if applicable.
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 406) <DT><B>SIGUSR1</B><DD>
tor.manual.html 407) Log statistics about current connections, past connections, and
tor.manual.html 408) throughput.
tor.manual.html 409) <DT><B>SIGUSR2</B><DD>
tor.manual.html 410) Switch all logs to loglevel debug. You can go back to the old loglevels
tor.manual.html 411) by sending a SIGHUP.
tor.manual.html 412) <DT><B>SIGCHLD</B><DD>
tor.manual.html 413) Tor receives this signal when one of its helper processes has exited,
tor.manual.html 414) so it can clean up.
tor.manual.html 415) <DT><B>SIGPIPE</B><DD>
tor.manual.html 416) Tor catches this signal and ignores it.
tor.manual.html 417) <DT><B>SIGXFSZ</B><DD>
tor.manual.html 418) If this signal exists on your platform, Tor catches and ignores it.
tor.manual.html 419) <P>
tor.manual.html 420) </DL>
tor.manual.html 421) <A NAME="lbAK"> </A>
tor.manual.html 422) <H2>FILES</H2>
tor.manual.html 423)
tor.manual.html 424) <DL COMPACT>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 425) <DT><I>@CONFDIR@/torrc</I>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 426)
tor.manual.html 427) <DD>
tor.manual.html 428) The configuration file, which contains "option value" pairs.
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 429) <DT><I>@LOCALSTATEDIR@/lib/tor/</I>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 430)
tor.manual.html 431) <DD>
tor.manual.html 432) The tor process stores keys and other data here.
tor.manual.html 433) <P>
tor.manual.html 434) </DL>
tor.manual.html 435) <A NAME="lbAL"> </A>
tor.manual.html 436) <H2>SEE ALSO</H2>
tor.manual.html 437)
tor.manual.html 438) <B><A HREF="/cgi-bin/man/man2html?1+privoxy">privoxy</A></B>(1),
tor.manual.html 439)
tor.manual.html 440) <B><A HREF="/cgi-bin/man/man2html?1+tsocks">tsocks</A></B>(1),
tor.manual.html 441)
tor.manual.html 442) <B><A HREF="/cgi-bin/man/man2html?1+torify">torify</A></B>(1)
tor.manual.html 443)
tor.manual.html 444) <P>
|
|
build tor-manual.html from...
Geoff Goodell authored 19 years ago
|
tor-manual.html 445) <B><A HREF="http://tor.eff.org/">http://tor.eff.org/</A></B>
|
|
added tor man page and link
Geoff Goodell authored 19 years ago
|
tor.manual.html 446)
tor.manual.html 447) <P>
tor.manual.html 448) <A NAME="lbAM"> </A>
tor.manual.html 449) <H2>BUGS</H2>
tor.manual.html 450)
tor.manual.html 451) Plenty, probably. It's still in alpha. Please report them.
tor.manual.html 452) <A NAME="lbAN"> </A>
tor.manual.html 453) <H2>AUTHORS</H2>
tor.manual.html 454)
tor.manual.html 455) Roger Dingledine <<A HREF="mailto:arma@mit.edu">arma@mit.edu</A>>, Nick Mathewson <<A HREF="mailto:nickm@alum.mit.edu">nickm@alum.mit.edu</A>>.
tor.manual.html 456) <P>
tor.manual.html 457)
tor.manual.html 458) <HR>
tor.manual.html 459) <A NAME="index"> </A><H2>Index</H2>
tor.manual.html 460) <DL>
tor.manual.html 461) <DT><A HREF="#lbAB">NAME</A><DD>
tor.manual.html 462) <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
tor.manual.html 463) <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
tor.manual.html 464) <DT><A HREF="#lbAE">OPTIONS</A><DD>
tor.manual.html 465) <DT><A HREF="#lbAF">CLIENT OPTIONS</A><DD>
tor.manual.html 466) <DT><A HREF="#lbAG">SERVER OPTIONS</A><DD>
tor.manual.html 467) <DT><A HREF="#lbAH">DIRECTORY SERVER OPTIONS</A><DD>
tor.manual.html 468) <DT><A HREF="#lbAI">HIDDEN SERVICE OPTIONS</A><DD>
tor.manual.html 469) <DT><A HREF="#lbAJ">SIGNALS</A><DD>
tor.manual.html 470) <DT><A HREF="#lbAK">FILES</A><DD>
tor.manual.html 471) <DT><A HREF="#lbAL">SEE ALSO</A><DD>
tor.manual.html 472) <DT><A HREF="#lbAM">BUGS</A><DD>
tor.manual.html 473) <DT><A HREF="#lbAN">AUTHORS</A><DD>
tor.manual.html 474) </DL>
tor.manual.html 475) <HR>
tor.manual.html 476) This document was created by
tor.manual.html 477) <A HREF="/cgi-bin/man/man2html">man2html</A>,
tor.manual.html 478) using the manual pages.<BR>
|
|
keep manual website up-to-d...
Geoff Goodell authored 19 years ago
|
tor-manual.html 479) Time: 14:17:19 GMT, March 16, 2005
|
keep manual website up-to-d...