Browse Source

Document multiline options in the manpage

Sebastian Hahn 15 years ago
parent
commit
1dab6cf4cb
2 changed files with 5 additions and 1 deletions
  1. 1 0
      changes/torrc_continuation
  2. 4 1
      doc/tor.1.txt

+ 1 - 0
changes/torrc_continuation

@@ -2,4 +2,5 @@
     - Support line continuations in torrc.  If a line ends with a
     - Support line continuations in torrc.  If a line ends with a
       single backslash character, the newline is ignored, and the
       single backslash character, the newline is ignored, and the
       configuration value is treated as continuing on the next line.
       configuration value is treated as continuing on the next line.
+      Implements bug 1929.
 
 

+ 4 - 1
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").
     value), or in the configuration file (option value or option "value").
     Options are case-insensitive. C-style escaped characters are allowed inside
     Options are case-insensitive. C-style escaped characters are allowed inside
     quoted values.   Options on the command line take precedence over
     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**::
 **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
     A token bucket limits the average incoming bandwidth usage on this node to
     A token bucket limits the average incoming bandwidth usage on this node to