NSSM 2.4.

[nssm.git] / README.txt

diff --git a/README.txt b/README.txt
index 2d38eaf..022e5ed 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager\r
-Version 2.2, 2010-04-04\r
+Version 2.4, 2010-09-23\r
 \r
 NSSM is a service helper program similar to srvany and cygrunsrv.  It can \r
 start any application as an NT service and will restart the service if it \r
@@ -20,6 +20,8 @@ Thanks Benjamin Mayrargue.
 Since version 2.2, NSSM can be configured to take different actions\r
 based on the exit code of the managed application.\r
 \r
+Since version 2.3, NSSM logs to the Windows event log more elegantly.\r
+\r
 \r
 Usage\r
 -----\r
@@ -86,10 +88,16 @@ but will continue running itself.  This emulates the (usually undesirable)
 behaviour of srvany.  The Windows Services console would show the service\r
 as still running even though the application has exited.\r
 \r
-If the value data is "Exit" NSSM will exit.  The Windows Services console\r
-would show the service as stopped.  If you wish to provide finer-grained\r
-control over service recovery you should use this code and edit the failure\r
-action manually.\r
+If the value data is "Exit" NSSM will exit gracefully.  The Windows Services\r
+console would show the service as stopped.  If you wish to provide\r
+finer-grained control over service recovery you should use this code and\r
+edit the failure action manually.  Please note that Windows versions prior\r
+to Vista will not consider such an exit to be a failure.  On older versions\r
+of Windows you should use "Suicide" instead.\r
+\r
+If the value data is "Suicide" NSSM will simulate a crash and exit without\r
+informing the service manager.  This option should only be used for\r
+pre-Vista systems where you wish to apply a service recovery action.\r
 \r
 \r
 Removing services using the GUI\r
@@ -111,6 +119,18 @@ To remove a service without confirmation from the GUI, run
 Try not to remove essential system services...\r
 \r
 \r
+Logging\r
+-------\r
+NSSM logs to the Windows event log.  It registers itself as an event log source\r
+and uses unique event IDs for each type of message it logs.  New versions may\r
+add event types but existing event IDs will never be changed.\r
+\r
+Because of the way NSSM registers itself you should be aware that you may not\r
+be able to replace the NSSM binary if you have the event viewer open and that\r
+running multiple instances of NSSM from different locations may be confusing if\r
+they are not all the same version.\r
+\r
+\r
 Example usage\r
 -------------\r
 To install an Unreal Tournament server:\r
@@ -130,7 +150,9 @@ Studio 2008.
 \r
 Credits\r
 -------\r
+Thanks to Bernard Loh for finding a bug with service recovery.\r
 Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.\r
+Thanks to Joel Reingold for spotting a command line truncation bug.\r
 \r
 Licence\r
 -------\r