Commit 5a83bb0e authored by David Goulet's avatar David Goulet 🐼
Browse files

man: Clarify options in the tor.1 man page 



In addition to the comments in the ticket, couple hidden service options have
been improved to clarify the maximum and minimum values they can be set to.

Closes #21058

Signed-off-by: David Goulet's avatarDavid Goulet <dgoulet@torproject.org>
parent 92c39264

changes/bug21058

0 → 100644
+3 −0
Original line number Diff line number Diff line 
  o Documentation (man page):

    - Clarify a number of options in tor.1 and add some min/max values for

      HiddenService options. Closes #21058.

doc/tor.1.txt

+17 −16
Original line number Diff line number Diff line
@@ -846,7 +846,7 @@ The following options are useful only for clients (that is, if 
[[ExcludeExitNodes]] **ExcludeExitNodes** __node__,__node__,__...__::

    A list of identity fingerprints, country codes, and address

    patterns of nodes to never use when picking an exit node---that is, a

    node that delivers traffic for you outside the Tor network.   Note that any

    node that delivers traffic for you *outside* the Tor network.   Note that any

    node listed in ExcludeNodes is automatically considered to be part of this

    list too.  See

    the **ExcludeNodes** option for more information on how to specify
@@ -863,7 +863,7 @@ The following options are useful only for clients (that is, if 
[[ExitNodes]] **ExitNodes** __node__,__node__,__...__::

    A list of identity fingerprints, country codes, and address

    patterns of nodes to use as exit node---that is, a

    node that delivers traffic for you outside the Tor network.  See

    node that delivers traffic for you *outside* the Tor network.  See

    the **ExcludeNodes** option for more information on how to specify nodes. +

 +

    Note that if you list too few nodes here, or if you exclude too many exit
@@ -871,7 +871,7 @@ The following options are useful only for clients (that is, if 
    if none of the exits you list allows traffic on port 80 or 443, you won't

    be able to browse the web. +

 +

    Note also that not every circuit is used to deliver traffic outside of

    Note also that not every circuit is used to deliver traffic *outside* of

    the Tor network.  It is normal to see non-exit circuits (such as those

    used to connect to hidden services, those that do directory fetches,

    those used for relay reachability self-tests, and so on) that end
@@ -897,16 +897,16 @@ The following options are useful only for clients (that is, if 
    the **ExcludeNodes** option for more information on how to specify nodes.



[[StrictNodes]] **StrictNodes** **0**|**1**::

    If StrictNodes is set to 1, Tor will treat the ExcludeNodes option as a

    requirement to follow for all the circuits you generate, even if doing so

    will break functionality for you.  If StrictNodes is set to 0, Tor will

    If StrictNodes is set to 1, Tor will treat solely the ExcludeNodes option

    as a requirement to follow for all the circuits you generate, even if

    doing so will break functionality for you (StrictNodes applies to neither

    ExcludeExitNodes nor to ExitNodes).  If StrictNodes is set to 0, Tor will

    still try to avoid nodes in the ExcludeNodes list, but it will err on the

    side of avoiding unexpected errors.  Specifically, StrictNodes 0 tells

    Tor that it is okay to use an excluded node when it is *necessary* to

    perform relay reachability self-tests, connect to

    a hidden service, provide a hidden service to a client, fulfill a .exit

    request, upload directory information, or download directory information.

    (Default: 0)

    side of avoiding unexpected errors.  Specifically, StrictNodes 0 tells Tor

    that it is okay to use an excluded node when it is *necessary* to perform

    relay reachability self-tests, connect to a hidden service, provide a

    hidden service to a client, fulfill a .exit request, upload directory

    information, or download directory information.  (Default: 0)



[[FascistFirewall]] **FascistFirewall** **0**|**1**::

    If 1, Tor will only create outgoing connections to ORs running on ports
@@ -2412,8 +2412,8 @@ The following options are used to configure a hidden service. 


[[HiddenServiceMaxStreams]] **HiddenServiceMaxStreams** __N__::

   The maximum number of simultaneous streams (connections) per rendezvous

   circuit. (Setting this to 0 will allow an unlimited number of simultanous

   streams.) (Default: 0)

   circuit. The maximum value allowed is 65535. (Setting this to 0 will allow

   an unlimited number of simultanous streams.) (Default: 0)



[[HiddenServiceMaxStreamsCloseCircuit]] **HiddenServiceMaxStreamsCloseCircuit** **0**|**1**::

   If set to 1, then exceeding **HiddenServiceMaxStreams** will cause the
@@ -2423,7 +2423,8 @@ The following options are used to configure a hidden service. 
[[RendPostPeriod]] **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::

    Every time the specified period elapses, Tor uploads any rendezvous

    service descriptors to the directory servers. This information is also

    uploaded whenever it changes. (Default: 1 hour)

    uploaded whenever it changes. Minimum value allowed is 10 minutes and

    maximum is 3.5 days. (Default: 1 hour)



[[HiddenServiceDirGroupReadable]] **HiddenServiceDirGroupReadable** **0**|**1**::

    If this option is set to 1, allow the filesystem group to read the