aboutsummaryrefslogtreecommitdiff
path: root/spec/param-spec.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/param-spec.md')
-rw-r--r--spec/param-spec.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/spec/param-spec.md b/spec/param-spec.md
index 025110c..2f79120 100644
--- a/spec/param-spec.md
+++ b/spec/param-spec.md
@@ -1,11 +1,11 @@
-Tor network parameters
+# Tor network parameters
This file lists the recognized parameters that can appear on the "params"
line of a directory consensus.
<a id="param-spec.txt-1"></a>
-# Network protocol parameters {#network-protocol}
+## Network protocol parameters {#network-protocol}
"circwindow" -- the default package window that circuits should be
established with. It started out at 1000 cells, but some research
@@ -58,7 +58,7 @@ First appeared: 0.4.5.1-alpha.
<a id="param-spec.txt-2"></a>
-# Performance-tuning parameters {#performance-tuning}
+## Performance-tuning parameters {#performance-tuning}
"CircuitPriorityHalflifeMsec" -- the halflife parameter used when
weighting which circuit will send the next cell. Obeyed by Tor
@@ -108,7 +108,7 @@ First appeared: 0.4.8.2
<a id="param-spec.txt-3"></a>
-# Voting-related parameters {#voting}
+## Voting-related parameters {#voting}
"bwweightscale" -- Value that bandwidth-weights are divided by. If not
present then this defaults to 10000.
@@ -146,7 +146,7 @@ dirauth.
<a id="param-spec.txt-4"></a>
-# Circuit-build-timeout parameters {#cbt}
+## Circuit-build-timeout parameters {#cbt}
"cbtdisabled", "cbtnummodes", "cbtrecentcount", "cbtmaxtimeouts",
"cbtmincircs", "cbtquantile", "cbtclosequantile", "cbttestfreq",
@@ -157,7 +157,7 @@ consensus parameters.
<a id="param-spec.txt-5"></a>
-# Directory-related parameters {#directory}
+## Directory-related parameters {#directory}
"max-consensus-age-to-cache-for-diff" -- Determines how much
consensus history (in hours) relays should try to cache in order to
@@ -169,7 +169,7 @@ try to find a diff for it. (min 0, max 8192, default 72)
<a id="param-spec.txt-6"></a>
-# Pathbias parameters {#pathbias}
+## Pathbias parameters {#pathbias}
"pb_mincircs", "pb_noticepct", "pb_warnpct", "pb_extremepct",
"pb_dropguards", "pb_scalecircs", "pb_scalefactor",
@@ -178,7 +178,7 @@ try to find a diff for it. (min 0, max 8192, default 72)
<a id="param-spec.txt-7"></a>
-# Relay behavior parameters {#relay-behavior}
+## Relay behavior parameters {#relay-behavior}
"refuseunknownexits" -- if set to one, exit relays look at the previous
hop of circuits that ask to open an exit stream, and refuse to exit if
@@ -262,7 +262,7 @@ First appeared: 0.4.7.5-alpha.
<a id="param-spec.txt-8"></a>
-# V3 onion service parameters {#onion-service}
+## V3 onion service parameters {#onion-service}
"hs_intro_min_introduce2", "hs_intro_max_introduce2" --
Minimum/maximum amount of INTRODUCE2 cells allowed per circuits
@@ -321,7 +321,7 @@ First appeared: 0.4.2.1-alpha.
<a id="param-spec.txt-9"></a>
-# Denial-of-service parameters {#dos}
+## Denial-of-service parameters {#dos}
Denial of Service mitigation parameters. Introduced in 0.3.3.2-alpha:
@@ -368,7 +368,7 @@ rendezvous points for single hop clients.
<a id="param-spec.txt-10"></a>
-# Padding-related parameters {#padding}
+## Padding-related parameters {#padding}
"circpad_max_circ_queued_cells" -- The circuitpadding module will
stop sending more padding cells if more than this many cells are in
@@ -402,7 +402,7 @@ First appeared: 0.4.0.3-alpha.
<a id="param-spec.txt-11"></a>
-# Guard-related parameters
+## Guard-related parameters
(See guard-spec.txt for more information on the vocabulary used here.)
@@ -499,7 +499,7 @@ First appeared: 0.3.0
<a id="param-spec.txt-X"></a>
-# Obsolete parameters {#obsolete}
+## Obsolete parameters {#obsolete}
"NumDirectoryGuards", "NumEntryGuards" -- Number of guard nodes
clients should use by default. If NumDirectoryGuards is 0, we