Update "ClientOnly" man page entry

There isn't really any point to messing with it. Resolves ticket 5005.

diff --git a/changes/bug5005 b/changes/bug5005
new file mode 100644 (file)
index 0000000..04d8dfe
--- /dev/null
+++ b/changes/bug5005
@@ -0,0 +1,3 @@
+  o Minor bugfixes:
+    - Update "ClientOnly" man page entry to explain that there isn't
+      really any point to messing with it. Resolves ticket 5005.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 558b31b0fd97d62589c8659c7ba50d8c88b3efb6..160feb028191362c598d812f34edcb33f9ec24c2 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -499,11 +499,12 @@ The following options are useful only for clients (that is, if
     number like 60. (Default: 0)
 
 **ClientOnly** **0**|**1**::
-    If set to 1, Tor will under no circumstances run as a server or serve
-    directory requests. The default is to run as a client unless ORPort is
-    configured. (Usually, you don't need to set this; Tor is pretty smart at
-    figuring out whether you are reliable and high-bandwidth enough to be a
-    useful server.) (Default: 0)
+    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)
 
 **ExcludeNodes** __node__,__node__,__...__::
     A list of identity fingerprints, nicknames, country codes and address