Visual Studio notes.

[nssm.git] / README.txt

diff --git a/README.txt b/README.txt
index f2fe712..3dacf18 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager\r
 NSSM: The Non-Sucking Service Manager\r

-Version 2.17, 2013-11-12\r
+Version 2.21, 2013-11-24\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
 \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


@@ -46,6 +46,13 @@ to an arbitrary path.
 Since version 2.18, NSSM can be configured to wait a user-specified amount\r
 of time for the application to exit when shutting down.\r
 \r
 Since version 2.18, NSSM can be configured to wait a user-specified amount\r
 of time for the application to exit when shutting down.\r
 \r

+Since version 2.19, many more service options can be configured with the\r
+GUI installer as well as via the registry.\r
+\r
+Since version 2.19, NSSM can add to the service's environment by setting\r
+AppEnvironmentExtra in place of or in addition to the srvany-compatible\r
+AppEnvironment.\r
+\r

 \r
 Usage\r
 -----\r
 \r
 Usage\r
 -----\r


@@ -227,6 +234,22 @@ work.  Remember, however, that the path must be accessible to the user
 running the service.\r
 \r
 \r
 running the service.\r
 \r
 \r

+Environment variables\r
+---------------------\r
+NSSM can replace or append to the managed application's environment.  Two\r
+multi-valued string (REG_MULTI_SZ) registry values are recognised under\r
+HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters.\r
+\r
+AppEnvironment defines a list of environment variables which will override\r
+the service's environment.  AppEnvironmentExtra defines a list of\r
+environment variables which will be added to the service's environment.\r
+\r
+Each entry in the list should be of the form KEY=VALUE.  It is possible to\r
+omit the VALUE but the = symbol is mandatory.\r
+\r
+srvany only supports AppEnvironment.\r
+\r
+\r

 Removing services using the GUI\r
 -------------------------------\r
 NSSM can also remove services.  Run\r
 Removing services using the GUI\r
 -------------------------------\r
 NSSM can also remove services.  Run\r


@@ -271,11 +294,14 @@ To remove the server:
 \r
 Building NSSM from source\r
 -------------------------\r
 \r
 Building NSSM from source\r
 -------------------------\r

-NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual\r
-Studio 2008.\r
+NSSM is known to compile with Visual Studio 2008.  Older Visual Studio\r
+releases may or may not work.\r

 \r
 NSSM will also compile with Visual Studio 2010 but the resulting executable\r
 \r
 NSSM will also compile with Visual Studio 2010 but the resulting executable\r

-will not run on versions of Windows older than XP SP2.\r
+will not run on versions of Windows older than XP SP2.  If you require\r
+compatiblity with older Windows releases you should change the Platform\r
+Toolset to v90 in the General section of the project's Configuration\r
+Properties.\r

 \r
 \r
 Credits\r
 \r
 \r
 Credits\r


@@ -300,6 +326,8 @@ Thanks to Eric Cheldelin for the inspiration to generate a Control-C event
 on shutdown.\r
 Thanks to Brian Baxter for suggesting how to escape quotes from the command prompt.\r
 Thanks to Russ Holmann for suggesting that the shutdown timeout be configurable.\r
 on shutdown.\r
 Thanks to Brian Baxter for suggesting how to escape quotes from the command prompt.\r
 Thanks to Russ Holmann for suggesting that the shutdown timeout be configurable.\r

+Thanks to Paul Spause for spotting a bug with default registry entries.\r
+Thanks to BUGHUNTER for spotting more GUI bugs.\r

 \r
 Licence\r
 -------\r
 \r
 Licence\r
 -------\r