X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=f5e6ed8827c30fc2dbfc08efaa9940cba8e35f9c;hb=b3a4446ab363b5895aa2e04c645ed5d5dfa00442;hp=b772c3667b039991bb874e67bcb0c3e7cbd51860;hpb=40792fac2ef98e69c331b9cd5a9279dc3e1eb730;p=nssm.git

diff --git a/README.txt b/README.txt
index b772c36..f5e6ed8 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager
-Version 2.16, 2012-12-01
+Version 2.18, 2013-11-15
 
 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 
@@ -43,6 +43,12 @@ they can clean up and shut down gracefully on receipt of the event.
 Since version 2.17, NSSM can redirect the managed application's I/O streams
 to an arbitrary path.
 
+Since version 2.18, NSSM can be configured to wait a user-specified amount
+of time for the application to exit when shutting down.
+
+Since version 2.19, many more service options can be configured with the
+GUI installer as well as via the registry.
+
 
 Usage
 -----
@@ -77,6 +83,9 @@ with the given options (if you specified any).
 
 Don't forget to enclose paths in "quotes" if they contain spaces!
 
+If you want to include quotes in the options you will need to """quote""" the
+quotes.
+
 
 Managing the service
 --------------------
@@ -137,6 +146,63 @@ 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.
 
 
+Stopping the service
+--------------------
+When stopping a service NSSM will attempt several different methods of killing
+the monitored application, each of which can be disabled if necessary.
+
+First NSSM will attempt to generate a Control-C event and send it to the
+application's console.  Batch scripts or console applications may intercept
+the event and shut themselves down gracefully.  GUI applications do not have
+consoles and will not respond to this method.
+
+Secondly NSSM will enumerate all windows created by the application and send
+them a WM_CLOSE message, requesting a graceful exit.
+
+Thirdly NSSM will enumerate all threads created by the application and send
+them a WM_QUIT message, requesting a graceful exit.  Not all applications'
+threads have message queues; those which do not will not respond to this
+method.
+
+Finally NSSM will call TerminateProcess() to request that the operating
+system forcibly terminate the application.  TerminateProcess() cannot be
+trapped or ignored, so in most circumstances the application will be killed.
+However, there is no guarantee that it will have a chance to perform any
+tidyup operations before it exits.
+
+Any or all of the methods above may be disabled.  NSSM will look for the
+HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppStopMethodSkip
+registry value which should be of type REG_DWORD set to a bit field describing
+which methods should not be applied.
+
+  If AppStopMethodSkip includes 1, Control-C events will not be generated.
+  If AppStopMethodSkip includes 2, WM_CLOSE messages will not be posted.
+  If AppStopMethodSkip includes 4, WM_QUIT messages will not be posted.
+  If AppStopMethodSkip includes 8, TerminateProcess() will not be called.
+
+If, for example, you knew that an application did not respond to Control-C
+events and did not have a thread message queue, you could set AppStopMethodSkip
+to 5 and NSSM would not attempt to use those methods to stop the application.
+
+Take great care when including 8 in the value of AppStopMethodSkip.  If NSSM
+does not call TerminateProcess() it is possible that the application will not
+exit when the service stops.
+
+By default NSSM will allow processes 1500ms to respond to each of the methods
+described above before proceeding to the next one.  The timeout can be
+configured on a per-method basis by creating REG_DWORD entries in the
+registry under HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters.
+
+  AppStopMethodConsole
+  AppStopMethodWindow
+  AppStopMethodThreads
+
+Each value should be set to the number of milliseconds to wait.  Please note
+that the timeout applies to each process in the application's process tree,
+so the actual time to shutdown may be longer than the sum of all configured
+timeouts if the application spawns multiple subprocesses.
+
+
 I/O redirection
 ---------------
 NSSM can redirect the managed application's I/O to any path capable of being
@@ -235,6 +301,8 @@ the default language when the user's display language was not translated.
 Thanks to Riccardo Gusmeroli for Italian translation.
 Thanks to Eric Cheldelin for the inspiration to generate a Control-C event
 on shutdown.
+Thanks to Brian Baxter for suggesting how to escape quotes from the command prompt.
+Thanks to Russ Holmann for suggesting that the shutdown timeout be configurable.
 
 Licence
 -------