[or-cvs] [tor/master 3/6] Document multiline options in the manpage

[nickm at torproject.org]

Author: Sebastian Hahn <sebastian at torproject.org>
Date: Sat, 11 Sep 2010 01:41:33 +0200
Subject: Document multiline options in the manpage
Commit: 1dab6cf4cbb35e27dd1d13f7deeb3e25f7dfcd5c

---
 changes/torrc_continuation |    1 +
 doc/tor.1.txt              |    5 ++++-
 2 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/changes/torrc_continuation b/changes/torrc_continuation
index f40e970..f63937e 100644
--- a/changes/torrc_continuation
+++ b/changes/torrc_continuation
@@ -2,4 +2,5 @@
     - Support line continuations in torrc.  If a line ends with a
       single backslash character, the newline is ignored, and the
       configuration value is treated as continuing on the next line.
+      Implements bug 1929.
 
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 3b7e30b..8c581c4 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -65,7 +65,10 @@ Other options can be specified either on the command-line (--option
     value), or in the configuration file (option value or option "value").
     Options are case-insensitive. C-style escaped characters are allowed inside
     quoted values.   Options on the command line take precedence over
-    options found in the configuration file.
+    options found in the configuration file, except indicated otherwise.  To
+    split one configuration entry into multiple lines, use a single \ before
+    the end of the line.  Comments can be used in such multiline entries, but
+    they must start at the beginning of a line.
 
 **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
     A token bucket limits the average incoming bandwidth usage on this node to
-- 
1.7.1