Add manpage entry for logging domains

Fixes issue 2215.

diff --git a/changes/log_domains b/changes/log_domains
new file mode 100644 (file)
index 0000000..f4cfe6f
--- /dev/null
+++ b/changes/log_domains
@@ -0,0 +1,5 @@
+  o Documentation
+
+    - Add documentation for configuring logging at different severities in
+      different log domains.  We've had this feature since 0.2.1.1-alpha, but
+      for some reason it never made it into the manpage.  Fixes bug 2215.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index c8608eb8455d4e57b1be1ece637f92a8cdfc41a0..9a7ee07e70dc1193a7089c5bf57986423d5397bd 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -323,6 +323,29 @@ Other options can be specified either on the command-line (--option
     Messages are sent to all the logs that match their severity
     level.
 
+**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ +
+
+**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog** ::
+    As above, but select messages by range of log severity __and__ by a
+    set of "logging domains".  Each logging domain corresponds to an area of
+    functionality inside Tor.  You can specify any number of severity ranges
+    for a single log statement, each of them prefixed by a comma-separated
+    list of logging domains.  You can prefix a domain with ~ to indicate
+    negation, and use * to indicate "all domains".  If you specify a severity
+    range without a list of domains, it matches all domains. +
+ +
+    This is an advanced feature which is most useful for debugging one or two
+    of Tor's subsystems at a time. +
+ +
+    The currently recognized domains are: general, crypto, net, config, fs,
+    protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge,
+    acct, hist, and handshake.  Domain names are case-insensitive. +
+ +
+    For example, "`Log [handshake]debug [*,~net,~mm]info notice stdout`" sends
+    to stdout: all handshake messages of any severity, all info-and-higher
+    messages from domains other than networking and memory management, and all
+    messages of severity notice or higher.
+
 **OutboundBindAddress** __IP__::
     Make all outbound connections originate from the IP address specified. This
     is only useful when you have multiple network interfaces, and you want all