X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=f218e83cbd49b38311d1c147f0eaaa9daaeaab03;hb=470de9224d9473853d24006d7ae13eba818ecf0f;hp=2fbe5c80dddb8118091587c7c8e63b6765624d07;hpb=4142e6c279f302b6b43e4e4d41ea7afaa89293a0;p=nssm.git

diff --git a/README.txt b/README.txt
index 2fbe5c8..f218e83 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager
-Version 2.17, 2013-11-12
+Version 2.19, 2013-11-22
 
 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,16 @@ 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.
+
+Since version 2.19, NSSM can add to the service's environment by setting
+AppEnvironmentExtra in place of or in addition to the srvany-compatible
+AppEnvironment.
+
 
 Usage
 -----
@@ -182,6 +192,20 @@ 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
 ---------------
@@ -210,6 +234,22 @@ work.  Remember, however, that the path must be accessible to the user
 running the service.
 
 
+Environment variables
+---------------------
+NSSM can replace or append to the managed application's environment.  Two
+multi-valued string (REG_MULTI_SZ) registry values are recognised under
+HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters.
+
+AppEnvironment defines a list of environment variables which will override
+the service's environment.  AppEnvironmentExtra defines a list of
+environment variables which will be added to the service's environment.
+
+Each entry in the list should be of the form KEY=VALUE.  It is possible to
+omit the VALUE but the = symbol is mandatory.
+
+srvany only supports AppEnvironment.
+
+
 Removing services using the GUI
 -------------------------------
 NSSM can also remove services.  Run
@@ -282,6 +322,8 @@ 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.
+Thanks to Paul Spause for spotting a bug with default registry entries.
 
 Licence
 -------