tor.1.in 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. .TH TOR 1 "May 2005" "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 command-line (\fI--option
  28. value\fR), or in the configuration file (\fIoption value\fR).
  29. Options are case-insensitive.
  30. .TP
  31. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBstderr\fR|\fBstdout\fR|\fBsyslog\fR\fP
  32. Send all messages between \fIminSeverity\fR and \fImaxSeverity\fR to
  33. the standard output stream, the standard error stream, or to the system
  34. log. (The "syslog" value is only supported on Unix.) Recognized
  35. severity levels are debug, info, notice, warn, and err. If only one
  36. severity level is given, all messages of that level or higher will be
  37. sent to the listed destination.
  38. .TP
  39. \fBLog \fR\fIminSeverity\fR[-\fImaxSeverity\fR] \fBfile\fR \fIFILENAME\fP
  40. As above, but send log messages to the listed filename. The "Log"
  41. option may appear more than once in a configuration file. Messages
  42. are sent to all the logs that match their severity level.
  43. .TP
  44. \fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  45. A token bucket limits the average incoming bandwidth on this node to
  46. the specified number of bytes per second. (Default: 2 MB)
  47. .TP
  48. \fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  49. Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 5 MB)
  50. .TP
  51. \fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  52. If set, we will not advertise more than this amount of bandwidth for our
  53. BandwidthRate. Server operators who want to reduce the number of clients
  54. who ask to build circuits through them (since this is proportional to
  55. advertised bandwidth rate) can thus reduce the CPU demands on their
  56. server without impacting network performance.
  57. .TP
  58. \fBDataDirectory \fR\fIDIR\fP
  59. Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
  60. .TP
  61. \fBDirServer \fR\fIaddress:port fingerprint\fP
  62. Use a nonstandard authoritative directory server at the provided
  63. address and port, with the specified key fingerprint. This option can
  64. be repeated many times, for multiple authoritative directory
  65. servers. If no \fBdirserver\fP line is given, Tor will use the default
  66. directory servers: moria1, moria2, and tor26.
  67. .TP
  68. \fBGroup \fR\fIGID\fP
  69. On startup, setgid to this user.
  70. .TP
  71. \fBHttpProxy\fR \fIhost\fR[:\fIport\fR]\fP
  72. If set, Tor will make all its directory requests through this host:port,
  73. rather than connecting directly to any directory servers.
  74. .TP
  75. \fBHttpsProxy\fR \fIhost\fR[:\fIport\fR]\fP
  76. If set, Tor will make all its OR (SSL) connections through this host:port,
  77. via HTTP CONNECT, rather than connecting directly to servers.
  78. .TP
  79. \fBHttpsProxyAuthenticator\fR \fIusername:password\fP
  80. If defined, Tor will use this username:password for Basic Https proxy
  81. authentication, as in RFC 2617. This is currently the only form of
  82. Https proxy authentication that Tor supports; feel free to submit a
  83. patch if you want it to support others. You may want to set FascistFirewall
  84. to restrict the set of ports you might try to connect to, if your Https
  85. proxy only allows connecting to certain ports.
  86. .TP
  87. \fBKeepalivePeriod \fR\fINUM\fP
  88. To keep firewalls from expiring connections, send a padding keepalive
  89. cell on open connections every NUM seconds. (Default: 5 minutes.)
  90. .TP
  91. \fBMaxConn \fR\fINUM\fP
  92. Maximum number of simultaneous sockets allowed. You probably don't need
  93. to adjust this. (Default: 1024)
  94. .TP
  95. \fBOutboundBindAddress \fR\fIIP\fP
  96. Make all outbound connections originate from the IP address specified. This
  97. is only useful when you have multiple network interfaces, and you want all
  98. of Tor's outgoing connections to use a single one.
  99. .TP
  100. \fBPIDFile \fR\fIFILE\fP
  101. On startup, write our PID to FILE. On clean shutdown, remove FILE.
  102. .TP
  103. \fBRunAsDaemon \fR\fB0\fR|\fB1\fR\fP
  104. If 1, Tor forks and daemonizes to the background. (Default: 0)
  105. .TP
  106. \fBUser \fR\fIUID\fP
  107. On startup, setuid to this user.
  108. .TP
  109. \fBControlPort \fR\fIPort\fP
  110. If set, Tor will accept connections from the same machine (localhost only) on
  111. this port, and allow those connections to control the Tor process using the
  112. Tor Control Protocol (described in control-spec.txt). Note: unless you also
  113. specify one of \fBHashedControlPassword\fP or \fBCookieAuthentication\fP,
  114. setting this option will cause Tor to allow any process on the local host to
  115. control it.
  116. .TP
  117. \fBHashedControlPassword \fR\fIhashed_password\fP
  118. Don't allow any connections on the control port except when the other process
  119. knows the password whose one-way hash is \fIhashed_password\fP. You can
  120. compute the hash of a password by running "tor --hash-password
  121. \fIpassword\fP".
  122. .TP
  123. \fBCookieAuthentication \fR\fB0\fR|\fB1\fP
  124. If this option is set to 1, don't allow any connections on the control port
  125. except when the connecting process knows the contents of a file named
  126. "control_auth_cookie", which Tor will create in its data directory. This
  127. authentication methods should only be used on systems with good filesystem
  128. security.
  129. \fBDirFetchPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  130. Every time the specified period elapses, Tor downloads a directory.
  131. A directory contains a signed list of all known servers as well as
  132. their current liveness status. A value of "0 seconds" tells Tor to choose an
  133. appropriate default. (Default: 1 hour for clients, 20 minutes for servers.)
  134. .TP
  135. \fBStatusFetchPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP Every time the
  136. specified period elapses, Tor downloads signed status information about the
  137. current state of known servers. A value of "0 seconds" tells Tor to choose
  138. an appropriate default. (Default: 30 minutes for clients, 15 minutes for
  139. servers.) (Default: 20 minutes.)
  140. .TP
  141. \fBRendPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  142. Every time the specified period elapses, Tor uploads any rendezvous
  143. service descriptors to the directory servers. This information is also
  144. uploaded whenever it changes. (Default: 20 minutes.)
  145. .SH CLIENT OPTIONS
  146. .PP
  147. The following options are useful only for clients (that is, if \fBSOCKSPort\fP is non-zero):
  148. .TP
  149. \fBAllowUnverifiedNodes\fR \fBentry\fR|\fBexit\fR|\fBmiddle\fR|\fBintroduction\fR|\fBrendezvous\fR|...\fP
  150. Where on our circuits should we allow Tor servers that the directory
  151. servers haven't authenticated as "verified"? (Default: middle,rendezvous.)
  152. .TP
  153. \fBClientOnly \fR\fB0\fR|\fB1\fR\fP
  154. If set to 1, Tor will under no circumstances run as a server. The default
  155. is to run as a client unless ORPort is configured. (Usually,
  156. you don't need to set this; Tor is pretty smart at figuring out whether
  157. you are reliable and high-bandwidth enough to be a useful server.)
  158. .TP
  159. \fBEntryNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  160. A list of preferred nodes to use for the first hop in the circuit, if possible.
  161. .TP
  162. \fBExitNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  163. A list of preferred nodes to use for the last hop in the circuit, if possible.
  164. .TP
  165. \fBExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  166. A list of nodes to never use when building a circuit.
  167. .TP
  168. \fBStrictExitNodes \fR\fB0\fR|\fB1\fR\fP
  169. If 1, Tor will never use any nodes besides those listed in "exitnodes" for
  170. the last hop of a circuit.
  171. .TP
  172. \fBStrictEntryNodes \fR\fB0\fR|\fB1\fR\fP
  173. If 1, Tor will never use any nodes besides those listed in "entrynodes" for
  174. the first hop of a circuit.
  175. .TP
  176. \fBFascistFirewall \fR\fB0\fR|\fB1\fR\fP
  177. If 1, Tor will only create outgoing connections to ORs running on ports that
  178. your firewall allows (defaults to 80 and 443; see \fBFirewallPorts\fR). This will
  179. allow you to run Tor as a client behind a firewall with restrictive policies,
  180. but will not allow you to run as a server behind such a firewall.
  181. .TP
  182. \fBFirewallPorts \fR\fIPORTS\fP
  183. A list of ports that your firewall allows you to connect to. Only used when
  184. \fBFascistFirewall\fR is set. (Default: 80, 443.)
  185. .TP
  186. \fBLongLivedPorts \fR\fIPORTS\fP
  187. A list of ports for services that tend to have long-running connections
  188. (e.g. chat and interactive shells). Circuits for streams that use these
  189. ports will contain only high-uptime nodes, to reduce the chance that a
  190. node will go down before the stream is finished.
  191. .TP
  192. \fBMapAddress\fR \fIaddress\fR \fInewaddress\fR
  193. 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 www.indymedia.org to exit via \fItorserver\fR (where \fItorserver\fR is the nickname of the server), use "MapAddress www.indymedia.org www.indymedia.org.torserver.exit".
  194. .TP
  195. \fBNewCircuitPeriod \fR\fINUM\fP
  196. Every NUM seconds consider whether to build a new circuit. (Default: 60)
  197. .TP
  198. \fBMaxCircuitDirtiness \fR\fINUM\fP
  199. Feel free to reuse a circuit that was first used at most NUM seconds
  200. ago, but never attach a new stream to a circuit that is too old.
  201. .TP
  202. \fBNodeFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  203. The named Tor servers constitute a "family" of similar or co-administered
  204. servers, so never use any two of them in the same circuit. Defining a
  205. NodeFamily is only needed when a server doesn't list the family itself
  206. (with MyFamily). This option can be used multiple times.
  207. .TP
  208. .\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
  209. .\" Paths are 3 hops plus a geometric distribution centered around this coinweight. Must be >=0.0 and <1.0. (Default: 0.3) NOT USED CURRENTLY
  210. .\" .TP
  211. \fBRendNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  212. A list of preferred nodes to use for the rendezvous point, if possible.
  213. .TP
  214. \fBRendExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  215. A list of nodes to never use when choosing a rendezvous point.
  216. .TP
  217. \fBSOCKSPort \fR\fIPORT\fP
  218. Advertise this port to listen for connections from SOCKS-speaking
  219. applications. Set this to 0 if you don't want to allow application
  220. connections. (Default: 9050)
  221. .TP
  222. \fBSOCKSBindAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  223. Bind to this address to listen for connections from SOCKS-speaking
  224. applications. (Default: 127.0.0.1) You can also specify a port
  225. (e.g. 192.168.0.1:9100). This directive can be specified multiple times
  226. to bind to multiple addresses/ports.
  227. .TP
  228. \fBSOCKSPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  229. 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.
  230. .TP
  231. \fBTrackHostExits \fR\fIhost\fR,\fI.domain\fR,\fI...\fR\fP
  232. For each value in the comma separated list, Tor will track recent connections
  233. to hosts that match this value and attempt to
  234. reuse the same exit node for each. If the value is prepended with a '.', it is
  235. treated as matching an entire domain. If one of the values is just a '.', it
  236. means match everything. This option is useful if you frequently connect to
  237. sites that will expire all your authentication cookies (ie log you out) if
  238. your IP address changes. Note that this option does have the disadvantage of
  239. making it more clear that a given history is
  240. associated with a single user. However, most people who would wish to observe
  241. this will observe it through cookies or other protocol-specific means anyhow.
  242. .TP
  243. \fBTrackHostExitsExpire \fR\fINUM\fP
  244. Since exit servers go up and down, it is desirable to expire the association
  245. between host and exit server after NUM seconds of inactivity. The default
  246. is 1800 seconds (30 minutes).
  247. .SH SERVER OPTIONS
  248. .PP
  249. The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
  250. .TP
  251. \fBAddress \fR\fIaddress\fP
  252. The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this
  253. unset, and Tor will guess your IP.
  254. .TP
  255. \fBContactInfo \fR\fIemail_address\fP
  256. Administrative contact information for server.
  257. .TP
  258. \fBExitPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  259. Set an exit policy for this server. Each policy is of the form
  260. "\fBaccept\fP|\fBreject\fP \fIADDR\fP[\fB/\fP\fIMASK\fP]\fB:\fP\fIPORT\fP".
  261. If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
  262. given. Instead of giving a host or network you can also use "\fB*\fP" to
  263. denote the universe (0.0.0.0/0). \fIPORT\fP can be a single port number,
  264. an interval of ports "\fIFROM_PORT\fP\fB-\fP\fITO_PORT\fP", or "\fB*\fP".
  265. For example, "reject 127.0.0.1:*,reject 192.168.1.0/24:*,accept *:*" would
  266. reject any traffic destined for localhost and any 192.168.1.* address, but
  267. accept anything else.
  268. This directive can be specified multiple times so you don't have to put
  269. it all on one line.
  270. See RFC 3330 for more details about internal and reserved IP address
  271. space. Policies are considered first to last, and the first match wins. If
  272. you want to _replace_ the default exit policy, end your exit policy with
  273. either a reject *:* or an accept *:*. Otherwise, you're _augmenting_
  274. (prepending to) the default exit policy. The default exit policy is:
  275. .PD 0
  276. .RS 12
  277. .IP "reject 0.0.0.0/8" 0
  278. .IP "reject 169.254.0.0/16" 4
  279. .IP "reject 127.0.0.0/8"
  280. .IP "reject 192.168.0.0/16"
  281. .IP "reject 10.0.0.0/8"
  282. .IP "reject 172.16.0.0/12"
  283. .IP "reject *:25"
  284. .IP "reject *:119"
  285. .IP "reject *:135-139"
  286. .IP "reject *:445"
  287. .IP "reject *:1214"
  288. .IP "reject *:4661-4666"
  289. .IP "reject *:6346-6429"
  290. .IP "reject *:6699"
  291. .IP "reject *:6881-6999"
  292. .IP "accept *:*"
  293. .RE
  294. .PD
  295. .TP
  296. \fBMaxOnionsPending \fR\fINUM\fP
  297. If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
  298. .TP
  299. \fBMyFamily \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  300. Declare that this Tor server is controlled or administered by a group
  301. or organization identical or similar to that of the other named servers.
  302. When two servers both declare that they are in the same 'family', Tor clients
  303. will not use them in the same circuit. (Each server only needs to list the
  304. other servers in its family; it doesn't need to list itself, but it won't hurt.)
  305. .TP
  306. \fBNickname \fR\fIname\fP
  307. Set the server's nickname to 'name'.
  308. .TP
  309. \fBNumCPUs \fR\fInum\fP
  310. How many processes to use at once for decrypting onionskins. (Default: 1)
  311. .TP
  312. \fBORPort \fR\fIPORT\fP
  313. Advertise this port to listen for connections from Tor clients and servers.
  314. .TP
  315. \fBORBindAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  316. Bind to this IP address to listen for connections from Tor clients and
  317. servers. If you specify a port, bind to this port rather than the one
  318. specified in ORPort. (Default: 0.0.0.0)
  319. .TP
  320. \fBRedirectExit \fR\fIpattern target\fP
  321. Whenever an outgoing connection tries to connect to one of a given set
  322. of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
  323. The address
  324. pattern is given in the same format as for an exit policy. The
  325. address translation applies after exit policies are applied. Multiple
  326. \fBRedirectExit\fP options can be used: once any one has matched
  327. successfully, no subsequent rules are considered. You can specify that no
  328. redirection is to be performed on a given set of addresses by using the
  329. special target string "pass", which prevents subsequent rules from being
  330. considered.
  331. .TP
  332. \fBShutdownWaitLength\fR\fINUM\fP
  333. When we get a SIGINT and we're a server, we begin shutting down: we close
  334. listeners and start refusing new circuits. After \fBNUM\fP seconds,
  335. we exit. If we get a second SIGINT, we exit immediately. (Default:
  336. 30 seconds)
  337. .TP
  338. \fBDirPostPeriod \fR\fIN\fR \fBseconds\fR|\fBminutes\fR|\fBhours\fR|\fBdays\fR|\fBweeks\fP
  339. Every time the specified period elapses, Tor uploads its server
  340. descriptors to the directory servers. This information is also
  341. uploaded whenever it changes. (Default: 20 minutes.)
  342. .TP
  343. \fBAccountingMax \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
  344. Never send more than the specified number of bytes in a given
  345. accounting period, or receive more than that number in the period.
  346. For example, with AccountingMax set to 1 GB, a server could send 900 MB
  347. and receive 800 MB and continue running. It will only hibernate once one
  348. of the two reaches 1 GB.
  349. When the number of bytes is exhausted, Tor will hibernate until some
  350. time in the next accounting period. To prevent all servers from
  351. waking at the same time, Tor will also wait until a random point in
  352. each period before waking up. If you have bandwidth cost issues,
  353. enabling hibernation is preferable to setting a low bandwidth, since it
  354. provides users with a collection of fast servers that are up some of
  355. the time, which is more useful than a set of slow servers that are
  356. always "available".
  357. .TP
  358. \fBAccountingStart \fR\fBday\fR|\fBweek\fR|\fBmonth\fR [\fIday\fR] \fIHH:MM\fR\fP
  359. Specify how long accounting periods last. If \fBmonth\fP is given,
  360. each accounting period runs from the time \fIHH:MM\fR on the
  361. \fIday\fRth day of one month to the same day and time of the next.
  362. (The day must be between 1 and 28.) If \fBweek\fP is given, each
  363. accounting period runs from the time \fIHH:MM\fR of the \fIday\fRth
  364. day of one week to the same day and time of the next week, with Monday
  365. as day 1 and Sunday as day 7. If \fBday\fR is given, each accounting
  366. period runs from the time \fIHH:MM\fR each day to the same time on the
  367. next day. All times are local, and given in 24-hour time. (Defaults to
  368. "month 1 0:00".)
  369. .SH DIRECTORY SERVER OPTIONS
  370. .PP
  371. The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
  372. .TP
  373. \fBAuthoritativeDirectory \fR\fB0\fR|\fB1\fR\fP
  374. When this option is set to 1, Tor operates as an authoritative
  375. directory server. Instead of caching the directory, it generates its
  376. own list of good servers, signs it, and sends that to the clients.
  377. Unless the clients already have you listed as a trusted directory, you
  378. probably do not want to set this option. Please coordinate with the other
  379. admins at tor-ops@freehaven.net if you think you should be a directory.
  380. .TP
  381. \fBDirPort \fR\fIPORT\fP
  382. Advertise the directory service on this port.
  383. .TP
  384. \fBDirBindAddress \fR\fIIP\fR[:\fIPORT\fR]\fP
  385. Bind the directory service to this address. If you specify a port, bind
  386. to this port rather than the one specified in DirPort. (Default: 0.0.0.0)
  387. .TP
  388. \fBDirPolicy \fR\fIpolicy\fR,\fIpolicy\fR,\fI...\fP
  389. 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.
  390. .TP
  391. \fBRecommendedVersions \fR\fISTRING\fP
  392. STRING is a command-separated list of Tor versions currently believed
  393. to be safe. The list is included in each directory, and nodes which
  394. pull down the directory learn whether they need to upgrade. This
  395. option can appear multiple times: the values from multiple lines are
  396. spliced together.
  397. .TP
  398. \fBDirAllowPrivateAddresses \fR\fB0\fR|\fB1\fR\fP
  399. If set to 1, Tor will accept router descriptors with arbitrary "Address"
  400. elements. Otherwise, if the address is not an IP or is a private IP,
  401. it will reject the router descriptor. Defaults to 0.
  402. .TP
  403. \fBRunTesting \fR\fB0\fR|\fB1\fR\fP
  404. If set to 1, Tor tries to build circuits through all of the servers it
  405. knows about, so it can tell which are up and which are down. This
  406. option is only useful for authoritative directories, so you probably
  407. don't want to use it.
  408. .SH HIDDEN SERVICE OPTIONS
  409. .PP
  410. The following options are used to configure a hidden service.
  411. .TP
  412. \fBHiddenServiceDir \fR\fIDIRECTORY\fP
  413. Store data files for a hidden service in DIRECTORY. Every hidden
  414. service must have a separate directory. You may use this option multiple
  415. times to specify multiple services.
  416. .TP
  417. \fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
  418. Configure a virtual port VIRTPORT for a hidden service. You may use this
  419. option multiple times; each time applies to the service using the most recent
  420. hiddenservicedir. By default, this option maps the virtual port to the
  421. same port on 127.0.0.1. You may override the target port, address, or both
  422. by specifying a target of addr, port, or addr:port.
  423. .TP
  424. \fBHiddenServiceNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  425. If possible, use the specified nodes as introduction points for the hidden
  426. service. If this is left unset, Tor will be smart and pick some reasonable
  427. ones; most people can leave this unset.
  428. .TP
  429. \fBHiddenServiceExcludeNodes \fR\fInickname\fR,\fInickname\fR,\fI...\fP
  430. Do not use the specified nodes as introduction points for the hidden
  431. service. In normal use there is no reason to set this.
  432. .\" UNDOCUMENTED
  433. .\" ignoreversion
  434. .SH SIGNALS
  435. Tor catches the following signals:
  436. .TP
  437. \fBSIGTERM\fR
  438. Tor will catch this, clean up and sync to disk if necessary, and exit.
  439. .TP
  440. \fBSIGINT\fR
  441. Tor clients behave as with SIGTERM; but Tor servers will do a controlled
  442. slow shutdown, closing listeners and waiting 30 seconds before exiting.
  443. (The delay can be configured with the ShutdownWaitLength config option.)
  444. .TP
  445. \fBSIGHUP\fR
  446. The signal instructs Tor to reload its configuration (including closing
  447. and reopening logs), fetch a new directory, and kill and restart its
  448. helper processes if applicable.
  449. .TP
  450. \fBSIGUSR1\fR
  451. Log statistics about current connections, past connections, and
  452. throughput.
  453. .TP
  454. \fBSIGUSR2\fR
  455. Switch all logs to loglevel debug. You can go back to the old loglevels
  456. by sending a SIGHUP.
  457. .TP
  458. \fBSIGCHLD\fR
  459. Tor receives this signal when one of its helper processes has exited,
  460. so it can clean up.
  461. .TP
  462. \fBSIGPIPE\fR
  463. Tor catches this signal and ignores it.
  464. .TP
  465. \fBSIGXFSZ\fR
  466. If this signal exists on your platform, Tor catches and ignores it.
  467. .SH FILES
  468. .TP
  469. .I @CONFDIR@/torrc
  470. The configuration file, which contains "option value" pairs.
  471. .TP
  472. .I @LOCALSTATEDIR@/lib/tor/
  473. The tor process stores keys and other data here.
  474. .SH SEE ALSO
  475. .BR privoxy (1),
  476. .BR tsocks (1),
  477. .BR torify (1)
  478. .BR http://tor.eff.org/
  479. .SH BUGS
  480. Plenty, probably. It's still in alpha. Please report them.
  481. .SH AUTHORS
  482. Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.