X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=3ef60051d879cb2621868af5319b3c9a3d8de244;hb=fdf66ebb177e189479057ebe4e1124251c0116c3;hp=84a34ba473f9d5c8bfac55d07457520ccdc639d6;hpb=e437fc1db29fc193b11061c9c0e54f4b5fcc861e;p=nssm.git

diff --git a/README.txt b/README.txt
index 84a34ba..3ef6005 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager
-Version 2.1, 2009-12-28 by Benjamin Mayrargue (www.softlion.com)
+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 
@@ -17,6 +17,13 @@ options on the command line.
 Since version 2.1, NSSM can be compiled for x64 platforms.
 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
 -----
@@ -56,13 +63,46 @@ Managing the service
 --------------------
 NSSM will launch the application listed in the registry when you send it a 
 start signal and will terminate it when you send a stop signal.  So far, so 
-much like srvany.  But NSSM is the Non-Sucking service manager and will take 
+much like srvany.  But NSSM is the Non-Sucking service manager and can take 
 action if/when the application dies.
 
-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.
+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.
+
+NSSM will look in the registry under
+HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit for
+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
+for the application by consulting the system event log.  NSSM will log the
+exit code when the application exits.
+
+Based on the data found in the registry, NSSM will take one of three actions:
+
+If the value data is "Restart" NSSM will try to restart the application as
+described above.  This is its default behaviour.
+
+If the value data is "Ignore" NSSM will not try to restart the application
+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 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
@@ -84,6 +124,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:
@@ -103,7 +155,12 @@ 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.
 
 Licence
 -------