[or-cvs] document configuration options with InitialCaps
Nick Mathewson
nickm at seul.org
Wed Oct 27 03:07:55 UTC 2004
Update of /home/or/cvsroot/doc
In directory moria.mit.edu:/tmp/cvs-serv24936/doc
Modified Files:
tor.1.in
Log Message:
document configuration options with InitialCaps
Index: tor.1.in
===================================================================
RCS file: /home/or/cvsroot/doc/tor.1.in,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -r1.25 -r1.26
--- tor.1.in 26 Oct 2004 21:48:40 -0000 1.25
+++ tor.1.in 27 Oct 2004 03:07:53 -0000 1.26
@@ -24,63 +24,67 @@
\fB-f \fR\fIFILE\fP
FILE contains further "option value" pairs. (Default: @CONFDIR@/torrc)
.TP
-Other options can be specified either on the commandline (\fI--option value\fR), or in the configuration file (\fIoption value\fR).
+Other options can be specified either on the commandline (\fI--option
+value\fR), or in the configuration file (\fIoption value\fR).
+Options are case-insensitive.
.TP
-\fBloglevel debug|info|notice|warn|err\fP
-Set the verboseness level of the primary log. (Default: warn)
+\fBLogLevel debug|info|notice|warn|err\fP
+Set the verboseness level of the primary log. (Default: warn. Abbreviation:
+-l.)
.TP
-\fBlogfile \fR\fIFILE\fP
+\fBLogFile \fR\fIFILE\fP
Rather than logging to stdout, log to FILE.
.TP
-\fBsyslog\fP
+\fBSysLog 1\fP
Rather than logging to stdout, send messages to the system log. (Not
supported on all platforms)
.TP
-\fBbandwidthrate \fR\fINUM\fP
+\fBBandwidthRate \fR\fINUM\fP
A token bucket limits the average incoming bandwidth on this node to NUM bytes per second. (Default: 800000)
.TP
-\fBbandwidthburst \fR\fINUM\fP
+\fBBandwidthBurst \fR\fINUM\fP
Limit the maximum token bucket size (also known as the burst) to NUM bytes. (Default: 10000000)
.TP
-\fBdirserver \fR\fIaddress:port fingerprint\fP
+\fBDirServer \fR\fIaddress:port fingerprint\fP
Use a nonstandard authoritative directory server at the provided
address and port, with the specified key fingerprint. This option can
be repeated many times, for multiple authoritative directory
servers. If no \fBdirserver\fP line is given, Tor will use the default
directory servers: moria1, moria2, and tor26.
.TP
-\fBdebuglogfile \fR\fIFILE\fP
+\fBDebugLogFile \fR\fIFILE\fP
In addition to other logging, we will log to FILE at log-level debug.
+(Deprecated; use LogFile and LogLevel instead.)
.TP
-\fBgroup \fR\fIGID\fP
+\fBGroup \fR\fIGID\fP
On startup, setgid to this user.
.TP
-\fBkeepaliveperiod \fR\fINUM\fP
+\fBKeepalivePeriod \fR\fINUM\fP
To keep firewalls from expiring connections, send a padding keepalive cell on open connections every NUM seconds. (Default: 300)
.TP
-\fBmaxconn \fR\fINUM\fP
+\fBMaxConn \fR\fINUM\fP
Maximum number of simultaneous connections allowed. You probably don't need
to adjust this. (Default: 900)
.TP
-\fBoutboundbindaddress \fR\fIP\fP
+\fBOutboundBindAddress \fR\fIP\fP
Make all outbound connections originate from the IP address specified. This
is only useful when you have multiple network interfaces, and you want all
of Tor's outgoing connections to use a single one.
.TP
-\fBpidfile \fR\fIFILE\fP
+\fBPIDFile \fR\fIFILE\fP
On startup, write our PID to FILE. On clean shutdown, remove FILE.
.TP
-\fBrunasdaemon \fR\fI0|1\fP
+\fBRunAsDaemon \fR\fI0|1\fP
If 1, Tor forks and daemonizes to the background. (Default: 0)
.TP
-\fBuser \fR\fIUID\fP
+\fBUser \fR\fIUID\fP
On startup, setuid to this user.
.SH CLIENT OPTIONS
.PP
-The following options are useful only for clients (that is, if \fBsocksport\fP is non-zero):
+The following options are useful only for clients (that is, if \fBSOCKSPort\fP is non-zero):
.TP
-\fBallowunverifiednodes \fR\fIentry|exit|middle|introduction|rendezvous,...\fP
+\fBAllowUnverifiedNodes \fR\fIentry|exit|middle|introduction|rendezvous,...\fP
Where on our circuits should we allow Tor servers that the directory
servers haven't authenticated as "verified"? (Default: middle,rendezvous.)
\fBdirfetchpostperiod \fR\fIseconds\fP
@@ -90,78 +94,78 @@
the directory servers. (Tor also uploads this information whenever it
changes.) (Default: 600.)
.TP
-\fBclientonly \fR\fI0|1\fP
+\fBClientOnly \fR\fI0|1\fP
If set to 1, Tor will under no circumstances run as a server. (Usually,
you don't need to set this; Tor is pretty smart at figuring out whether
you are reliable and high-bandwith enough to be a good server.)
.TP
-\fBentrynodes \fR\fInickname,nickname,...\fP
+\fBEntryNodes \fR\fInickname,nickname,...\fP
A list of preferred nodes to use for the first hop in the circuit, if possible.
.TP
-\fBexitnodes \fR\fInickname,nickname,...\fP
+\fBExitNodes \fR\fInickname,nickname,...\fP
A list of preferred nodes to use for the last hop in the circuit, if possible.
.TP
-\fBexcludenodes \fR\fInickname,nickname,...\fP
+\fBExcludeNodes \fR\fInickname,nickname,...\fP
A list of nodes to never use when building a circuit.
.TP
-\fBstrictexitnodes \fR\fI0|1\fP
+\fBStrictExitNodes \fR\fI0|1\fP
If 1, Tor will never use any nodes besides those listed in "exitnodes" for
the last hop of a circuit.
.TP
-\fBstrictentrynodes \fR\fI0|1\fP
+\fBStrictEntryNodes \fR\fI0|1\fP
If 1, Tor will never use any nodes besides those listed in "entrynodes" for
the first hop of a circuit.
.TP
-\fBfascistfirewall \fR\fI0|1\fP
+\fBFascistFirewall \fR\fI0|1\fP
If 1, Tor will only create outgoing connections to ORs running on ports that
your firewall allows (defaults to 80 and 443; see firewallports). This will
allow you to run Tor as a client behind a firewall with restrictive policies,
but will not allow you to run as a server behind such a firewall.
.TP
-\fBfirewallports \fR\fIPORTS\fP
+\fBFirewallPorts \fR\fIPORTS\fP
A list of ports that your firewall allows you to connect to. Only used when
fascistfirewall is set. (Default: 80, 443.)
.TP
-\fB
-\fBnewcircuitperiod \fR\fINUM\fP
+\fB
+\fBNewCircuitPeriod \fR\fINUM\fP
Every NUM seconds consider whether to build a new circuit. (Default: 60)
.TP
-\fBnodefamily \fR\fInickname,nickname,...\fP
+\fBNodeFamily \fR\fInickname,nickname,...\fP
The named Tor servers constitute a "family" of similar or
co-administared servers, so never use any two of them in the same
circuit. This option can be used multiple times.
.TP
-\fBpathlencoinweight \fR\fI0.0-1.0\fP
-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
-.TP
-\fBrendnodes \fR\fInickname,nickname,...\fP
+.\" \fBPathlenCoinWeight \fR\fI0.0-1.0\fP
+.\" 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
+.\" .TP
+\fBRendNodes \fR\fInickname,nickname,...\fP
A list of preferred nodes to use for the rendezvous point, if possible.
.TP
-\fBrendexcludenodes \fR\fInickname,nickname,...\fP
+\fBRendExcludeNodes \fR\fInickname,nickname,...\fP
A list of nodes to never use when choosing a rendezvous point.
.TP
-\fBsocksport \fR\fIPORT\fP
+\fBSOCKSPort \fR\fIPORT\fP
Bind to this port to listen for connections from SOCKS-speaking applications.
Set this to 0 if you don't want to allow application connections. (Default:
9050)
.TP
-\fBsocksbindaddress \fR\fIIP\fP
+\fBSOCKSBindAddress \fR\fIIP\fP
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.
.TP
-\fBsockspolicy \fR\fIpolicy,policy,...\fP
+\fBSOCKSPolicy \fR\fIpolicy,policy,...\fP
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.
.SH SERVER OPTIONS
.PP
-The following options are useful only for servers (that is, if \fBorport\fP is non-zero):
+The following options are useful only for servers (that is, if \fBORPort\fP is non-zero):
.TP
-\fBaddress \fR\fIaddress\fP
+\fBAddress \fR\fIaddress\fP
The IP or fqdn of this server (e.g. moria.mit.edu).
.TP
-\fBdatadirectory \fR\fIDIR\fP
+\fBDataDirectory \fR\fIDIR\fP
Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
.TP
-\fBexitpolicy \fR\fIpolicy,policy,...\fP
+\fBExitPolicy \fR\fIpolicy,policy,...\fP
Set an exit policy for this server. Each policy is of the form
"\fBreject\fP \fIADDR\fP\fB/\fP\fIMASK\fP\fB:\fP\fIPORT\fP".
If \fB/\fP\fIMASK\fP is omitted then this policy just applies to the host
@@ -203,34 +207,34 @@
.RE
.PD
.TP
-\fBmaxonionspending \fR\fINUM\fP
+\fBMaxOnionsPending \fR\fINUM\fP
If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100)
.TP
-\fBmyfamily \fR\fInickname,nickname,...\fP
+\fBMyFamily \fR\fInickname,nickname,...\fP
Declare that this Tor server is controlled or administered by a group
or organization identical or similar to that of the other named servers.
When two servers both declare that they are in the same 'family', Tor clients
will not use them in the same circuit.
.TP
-\fBnickname \fR\fIname\fP
+\fBNickname \fR\fIname\fP
Set the server's nickname to 'name'.
.TP
-\fBnumcpus \fR\fInum\fP
+\fBNumCPUs \fR\fInum\fP
How many processes to use at once for decrypting onionskins. (Default: 1)
.TP
-\fBorport \fR\fIPORT\fP
+\fBORPort \fR\fIPORT\fP
Bind to this port to listen for connections from Tor clients and servers.
.TP
-\fBorbindaddress \fR\fIIP\fP
+\fBORBindAddress \fR\fIIP\fP
Bind to this address to listen for connections from Tor clients and servers. (Default: 0.0.0.0)
.TP
-\fBredirectexit \fR\fIpattern target\fP
+\fBRedirectExit \fR\fIpattern target\fP
Whenever an outgoing connection tries to connect to one of a given set
of addresses, connect to \fItarget\fP (an \fIaddress:port\fP pair) instead.
The address
pattern is given in the same format as for an exit policy. The
address translation applies after exit policies are applied. Multiple
-\fBredirectexit\fP options can be used: once any one has matched
+\fBRedirectExit\fP options can be used: once any one has matched
successfully, no subsequent rules are considered. You can specify that no
redirection is to be performed on a given set of addresses by using the
special target string "pass", which prevents subsequent rules from being
@@ -238,9 +242,9 @@
.SH DIRECTORY SERVER OPTIONS
.PP
-The following options are useful only for directory servers (that is, if \fBdirport\fP is non-zero):
+The following options are useful only for directory servers (that is, if \fBDirPort\fP is non-zero):
.TP
-\fBauthoritativedirectory \fR\fI0|1\fP
+\fBAuthoritativeDirectory \fR\fI0|1\fP
When this option is set to 1, Tor operates as an authoritative
directory server. Instead of caching the directory, it generates its
own list of good servers, signs it, and sends that to the clients.
@@ -248,50 +252,50 @@
probably do not want to set this option. Please coordinate with the other
admins at tor-ops at freehaven.net if you think you should be a directory.
.TP
-\fBcontactinfo \fR\fIemail address\fP
+\fBContactInfo \fR\fIemail address\fP
Administrative contact information for server.
.TP
-\fBdirport \fR\fIPORT\fP
+\fBDirPort \fR\fIPORT\fP
Bind the directory service to this port.
.TP
-\fBdirbindaddress \fR\fIIP\fP
+\fBDirBindAddress \fR\fIIP\fP
Bind the directory service to this address. (Default: 0.0.0.0)
.TP
-\fBrecommendedversions \fR\fISTRING\fP
+\fBRecommendedVersions \fR\fISTRING\fP
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. This
option can appear multiple times: the values from multiple lines are
spliced together.
.TP
-\fBruntesting \fR\fI0|1\fP
+\fBRunTesting \fR\fI0|1\fP
If set to 1, Tor tries to build circuits through all of the servers it
knows about, so it can tell which are up and which are down. This
option is only useful for authoritative directories, so you probably
don't want to use it.
-.SH HIDDEN SERVER OPTIONS
+.SH HIDDEN SERVICE OPTIONS
.PP
The following options are used to configure a hidden service.
.TP
-\fBhiddenservicedir \fR\fIDIRECTORY\fP
+\fBHiddenServiceDir \fR\fIDIRECTORY\fP
Store data files for a hidden service in DIRECTORY. Every hidden
service must have a separate directory. You may use this option multiple
times to specify multiple services.
.TP
-\fBhiddenserviceport \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
+\fBHiddenServicePort \fR\fIVIRTPORT \fR[\fITARGET\fR]\fP
Configure a virtual port VIRTPORT for a hidden service. You may use this
option multiple times; each time applies to the service using the most recent
hiddenservicedir. By default, this option maps the virtual port to the
same port on 127.0.0.1. You may override the target port, address, or both
by specifying a target of addr, port, or addr:port.
.TP
-\fBhiddenservicenodes \fR\fInickname,nicknamme,...\fP
+\fBHiddenServiceNodes \fR\fInickname,nicknamme,...\fP
If possible, use the specified nodes as introduction points for the hidden
service.
.TP
-\fBhiddenserviceexcludenodes \fR\fInickname,nicknamme,...\fP
+\fBHiddenServiceExcludeNodes \fR\fInickname,nicknamme,...\fP
Do not use the specified nodes as introduction points for the hidden
service.
More information about the tor-commits
mailing list