Updated to be consistent with debug/production mode capability.

git-svn-id: https://svn.microneil.com/svn/PKG-SNF-CS-NIX/trunk@41 233e721a-07f6-49eb-a7da-05e0e16828fc

SNF_CS_Developer_Package/Docs/DebugMode_readme.txt

@@ -1,46 +1,50 @@
-Both SNFServer.exe and SNFClient.exe can be run in a debugging mode which
-produces additional output. In order to run these programs in debug mode
-you can rename them so that "debug" or "Debug" is in their name, or you
-can call them in a sub directory so that the path to the program conains
-"debug" or "Debug".
+Both SNFServer and SNFClient can be run in a debugging mode which
+produces additional output. In order to run these programs in debug
+mode you can rename them so that "debug" or "Debug" is in their name,
+or you can call them in a sub directory so that the path to the
+program conains "debug" or "Debug".
 
-SNFDebugClient.exe --
+SNFDebugClient --
 
-The SNFClient.exe debug mode will display the entire XCI session for each
+The SNFClient debug mode will display the entire XCI session for each
 call. This is a good way to see how XCI is used if you want to explore
 communicating with the SNFServer directly from your programs.
 
-SNFDebugServer.exe --
+SNFDebugServer --
 
-The SNFServer.exe debug mode will display a thread status report each
+The SNFServer debug mode will display a thread status report each
 second along with the usual running statistics line. The thread status
-report will show all active theads, what they are doing (generally), and
-whether they are running or have stopped. If a thread stops due to an
-unhandeled exception then information about that exception will be
+report will show all active theads, what they are doing (generally),
+and whether they are running or have stopped. If a thread stops due to
+an unhandeled exception then information about that exception will be
 displayed in the status report.
 
-There is a special version of the control script that will run the server
-in debug mode and capture it's output in a file called debuglog.
+The snf-server control script can be used to run the server in debug
+mode and capture it's output in a file called debug.log (in directory
+/var/log/snf-server by default).  Please see the Debugging section of
+INSTALL in the top-level directory of the distribution for the
+procedure and further details.
 
 20080325 -- At this time there are a few systems that are reporting an
-intermittent bug where SNFServer will either stop answering requests or
-it will stop reporting telemetry. When this happens there are no errors
-reported in logs, no exceptions thrown, no corrupted programs, nothing
-unusual at all --which is, of course, the most unusual thing of all. The
-program continues to run -- it's just not listening (or talking).
-
-On all but a handfull of systems SNFServer runs reliably for hundreds of
-days at a time without stopping until told to do so... This includes our
-lab computers... We hate mysteries -- the thread status report is designed
-to help us learn something about this bug since we are not yet able to
-reproduce it.
-
-To run SNFServer in debug mode, create a copy of SNFServer.exe named
-SNFDebugServer.exe and use the debugsnfctrl script to launch it (or you
-can launch it your own way -- the goal is to capture stdout and errout to
-a file called debuglog so that we can, hopefully, learn something).
-
-If you are not experiencing the bug then please run SNFServer.exe in the
+intermittent bug where SNFServer will either stop answering requests
+or it will stop reporting telemetry. When this happens there are no
+errors reported in logs, no exceptions thrown, no corrupted programs,
+nothing unusual at all --which is, of course, the most unusual thing
+of all. The program continues to run -- it's just not listening (or
+talking).
+
+On all but a handfull of systems SNFServer runs reliably for hundreds
+of days at a time without stopping until told to do so... This
+includes our lab computers... We hate mysteries -- the thread status
+report is designed to help us learn something about this bug since we
+are not yet able to reproduce it.
+
+To run SNFServer in debug mode, use the procedure in the INSTALL file
+(or you can launch it your own way -- the goal is to capture stdout
+and errout to a file called debug.log so that we can, hopefully, learn
+something).
+
+If you are not experiencing the bug then please run SNFServer in the
 normal way.
 
 Thanks