X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=88a729078321e1469a9a4a68a6efe9d1588915ff;hb=859c7ca832ff02cb5a4f27693d7b997034daa42a;hp=2d38eaf7152f98c7e242914f0bdb148c21d7a2cb;hpb=44284fb9f67e45b3fe7dcfa272f5ac01bc184022;p=nssm.git

diff --git a/README.txt b/README.txt
index 2d38eaf..88a7290 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager
-Version 2.2, 2010-04-04
+Version 2.7, 2011-01-25
 
 NSSM is a service helper program similar to srvany and cygrunsrv.  It can 
 start any application as an NT service and will restart the service if it 
@@ -20,6 +20,10 @@ Thanks Benjamin Mayrargue.
 Since version 2.2, NSSM can be configured to take different actions
 based on the exit code of the managed application.
 
+Since version 2.3, NSSM logs to the Windows event log more elegantly.
+
+Since version 2.5, NSSM respects environment variables in its parameters.
+
 
 Usage
 -----
@@ -64,12 +68,19 @@ action if/when the application dies.
 
 With no configuration from you, NSSM will try to restart itself if it notices
 that the application died but you didn't send it a stop signal.  NSSM will
-keep trying, pausing 30 seconds between each attempt, until the service is
-successfully started or you send it a stop signal.
+keep trying, pausing between each attempt, until the service is successfully
+started or you send it a stop signal.
+
+NSSM will pause an increasingly longer time between subsequent restart attempts
+if the service fails to start in a timely manner, up to a maximum of 60 seconds.
+This is so it does not consume an excessive amount of CPU time trying to start
+a failed application over and over again.  If you identify the cause of the
+failure and don't want to wait you can use the Windows service console to
+send a continue signal to NSSM and it will retry within a few seconds.
 
 NSSM will look in the registry under
 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit for
-string (REG_SZ) values corresponding to the exit code of the application.
+string (REG_EXPAND_SZ) values corresponding to the exit code of the application.
 If the application exited with code 1, for instance, NSSM will look for a
 string value under AppExit called "1" or, if it does not find it, will
 fall back to the AppExit (Default) value.  You can find out the exit code
@@ -86,10 +97,19 @@ but will continue running itself.  This emulates the (usually undesirable)
 behaviour of srvany.  The Windows Services console would show the service
 as still running even though the application has exited.
 
-If the value data is "Exit" NSSM will exit.  The Windows Services console
-would show the service as stopped.  If you wish to provide finer-grained
-control over service recovery you should use this code and edit the failure
-action manually.
+If the value data is "Exit" NSSM will exit gracefully.  The Windows Services
+console would show the service as stopped.  If you wish to provide
+finer-grained control over service recovery you should use this code and
+edit the failure action manually.  Please note that Windows versions prior
+to Vista will not consider such an exit to be a failure.  On older versions
+of Windows you should use "Suicide" instead.
+
+If the value data is "Suicide" NSSM will simulate a crash and exit without
+informing the service manager.  This option should only be used for
+pre-Vista systems where you wish to apply a service recovery action.  Note
+that if the monitored application exits with code 0, NSSM will only honour a
+request to suicide if you explicitly configure a registry key for exit code 0.
+If only the default action is set to Suicide NSSM will instead exit gracefully.
 
 
 Removing services using the GUI
@@ -111,6 +131,18 @@ To remove a service without confirmation from the GUI, run
 Try not to remove essential system services...
 
 
+Logging
+-------
+NSSM logs to the Windows event log.  It registers itself as an event log source
+and uses unique event IDs for each type of message it logs.  New versions may
+add event types but existing event IDs will never be changed.
+
+Because of the way NSSM registers itself you should be aware that you may not
+be able to replace the NSSM binary if you have the event viewer open and that
+running multiple instances of NSSM from different locations may be confusing if
+they are not all the same version.
+
+
 Example usage
 -------------
 To install an Unreal Tournament server:
@@ -130,7 +162,13 @@ Studio 2008.
 
 Credits
 -------
+Thanks to Bernard Loh for finding a bug with service recovery.
 Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.
+Thanks to Joel Reingold for spotting a command line truncation bug.
+Thanks to Arve Knudsen for spotting that child processes of the monitored
+application could be left running on service shutdown, and that a missing
+registry value for AppDirectory confused NSSM.
+Thanks to Peter Wagemans and Laszlo Kereszt for suggesting throttling restarts.
 
 Licence
 -------