From: david-sarah <david-sarah@jacaranda.org>
Date: Sat, 31 Mar 2012 22:39:34 +0000 (+0000)
Subject: Document PYTHONPATH problem when running flogtool. refs #1693
X-Git-Url: https://git.rkrishnan.org/simplejson/components/com_hotproperty/status?a=commitdiff_plain;h=922ed08c25a1a1425afc81b465b14f5ff77c4d26;p=tahoe-lafs%2Ftahoe-lafs.git

Document PYTHONPATH problem when running flogtool. refs #1693
---

diff --git a/docs/logging.rst b/docs/logging.rst
index 5a24700e..9609de45 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -23,12 +23,16 @@ record information about what is happening inside the Tahoe node. This is
 primarily for use by programmers and grid operators who want to find out what
 went wrong.
 
-The foolscap logging system is documented at
+The Foolscap logging system is documented at
 `<http://foolscap.lothar.com/docs/logging.html>`_.
 
-The foolscap distribution includes a utility named "``flogtool``" (usually at
-``/usr/bin/flogtool`` on Unix) which is used to get access to many foolscap
-logging features.
+The Foolscap distribution includes a utility named "``flogtool``" that is
+used to get access to many Foolscap logging features. However, using this
+command directly on Tahoe log files may fail, due to use of an incorrect
+PYTHONPATH. Installing Foolscap v0.6.1 or later and then running
+``bin/tahoe @flogtool`` from the root of a Tahoe-LAFS source distribution
+may avoid this problem (but only on Unix, not Windows).
+
 
 Realtime Logging
 ================