From fd8284c8b9b804ef405db211bae51a9fd5442979 Mon Sep 17 00:00:00 2001 From: David Goulet Date: Mon, 10 Apr 2017 13:47:43 -0400 Subject: [PATCH] man: Update Num{Directory,Entry}Guards default value Fixes #21715 Signed-off-by: David Goulet --- changes/bug21715 | 5 +++++ doc/tor.1.txt | 18 +++++++++--------- 2 files changed, 14 insertions(+), 9 deletions(-) create mode 100644 changes/bug21715 diff --git a/changes/bug21715 b/changes/bug21715 new file mode 100644 index 0000000000..ad9d8bfdaf --- /dev/null +++ b/changes/bug21715 @@ -0,0 +1,5 @@ + o Documentation (man page): + - Default of NumEntryGuards is 1 if the consensus parameter + guard-n-primary-guards-to-use isn't set. Default of NumDirectoryGuards + is 3 if the consensus parameter guard-n-primary-dir-guards-to-use isn't + set. Fixes bug 21715. diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 568d037d98..c7692379b1 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -646,7 +646,7 @@ GENERAL OPTIONS (127.0.0.0/8 and ::1). [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__:: - Make all outbound non-exit (=relay and other) connections originate from the IP + Make all outbound non-exit (=relay and other) connections originate from the IP address specified. This option overrides **OutboundBindAddress** for the same IP version. This option may be used twice, once with an IPv4 address and once with an IPv6 address. This setting will be ignored for connections to the @@ -1274,16 +1274,16 @@ The following options are useful only for clients (that is, if [[NumEntryGuards]] **NumEntryGuards** __NUM__:: If UseEntryGuards is set to 1, we will try to pick a total of NUM routers - as long-term entries for our circuits. If NUM is 0, we try to learn - the number from the NumEntryGuards consensus parameter, and default - to 3 if the consensus parameter isn't set. (Default: 0) + as long-term entries for our circuits. If NUM is 0, we try to learn the + number from the guard-n-primary-guards-to-use consensus parameter, and + default to 1 if the consensus parameter isn't set. (Default: 0) [[NumDirectoryGuards]] **NumDirectoryGuards** __NUM__:: - If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we - have at least NUM routers to use as directory guards. If this option - is set to 0, use the value from the NumDirectoryGuards consensus - parameter, falling back to the value from NumEntryGuards if the - consensus parameter is 0 or isn't set. (Default: 0) + If UseEntryGuardsAsDirectoryGuards is enabled, we try to make sure we have + at least NUM routers to use as directory guards. If this option is set to + 0, use the value from the guard-n-primary-dir-guards-to-use consensus + parameter, and default to 3 if the consensus parameter isn't set. + (Default: 0) [[GuardLifetime]] **GuardLifetime** __N__ **days**|**weeks**|**months**:: If nonzero, and UseEntryGuards is set, minimum time to keep a guard before