Clarify ClientOnly documentation

The option is unneeded, not meaningless, so explain what it does.

Patch from Matt Pagan; fixes 9059.

diff --git a/changes/bug9059 b/changes/bug9059
new file mode 100644 (file)
index 0000000..9872a59
--- /dev/null
+++ b/changes/bug9059
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Provide a more accurate description of the ClientOnly config
+      option on the man page. Resolves bug 9059.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index c49692c69da37117095715b74c0a91960b953ade..e4679bf3fca1453ae443f3cef9fe1fdf92e1563b 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -702,12 +702,13 @@ The following options are useful only for clients (that is, if
     number like 60. (Default: 0)
 
 [[ClientOnly]] **ClientOnly** **0**|**1**::
-    If set to 1, Tor will under no circumstances run as a relay or serve
-    directory requests. This config option is mostly meaningless: we
-    added it back when we were considering having Tor clients auto-promote
-    themselves to being relays if they were stable and fast enough. The
-    current behavior is simply that Tor is a client unless ORPort or
-    DirPort are configured. (Default: 0)
+    If set to 1, Tor will not run as a relay or serve
+    directory requests, even if the ORPort, ExtORPort, or DirPort options are
+    set. (This config option is
+    mostly unnecessary: we added it back when we were considering having
+    Tor clients auto-promote themselves to being relays if they were stable
+    and fast enough. The current behavior is simply that Tor is a client
+    unless ORPort, ExtORPort, or DirPort are configured.) (Default: 0)
 
 [[ExcludeNodes]] **ExcludeNodes** __node__,__node__,__...__::
     A list of identity fingerprints, nicknames, country codes and address