X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=2158741ce032cb10f9fe65a70544fa0943713df6;hb=caaaa1208f29647987173f7d9bc1aa75b58757b7;hp=ecca5e9769ac1a32acb573c1aeea148a919da276;hpb=32a1d0fab47a050086106aac346342c70f4d985b;p=nssm.git

diff --git a/README.txt b/README.txt
index ecca5e9..2158741 100644
--- a/README.txt
+++ b/README.txt
@@ -68,6 +68,8 @@ Since version 2.22, NSSM can manage existing services.
 
 Since version 2.25, NSSM can execute commands in response to service events.
 
+Since version 2.25, NSSM can list services it manages.
+
 
 Usage
 -----
@@ -331,7 +333,7 @@ a non-zero value of AppRotateBytesHigh.
 If AppRotateDelay is non-zero, NSSM will pause for the given number of
 milliseconds after rotation.
 
-If AppStdoutCopyAndTruncate or AppStdErrCopyAndTruncate are non-zero, the
+If AppStdoutCopyAndTruncate or AppStderrCopyAndTruncate are non-zero, the
 stdout (or stderr respectively) file will be rotated by first taking a copy
 of the file then truncating the original file to zero size.  This allows
 NSSM to rotate files which are held open by other processes, preventing the
@@ -406,6 +408,59 @@ application to fail to start.
 Most people will want to use AppEnvironmentExtra exclusively.  srvany only
 supports AppEnvironment.
 
+As of version 2.25, NSSM parses AppEnvironment and AppEnvironmentExtra
+itself, before reading any other registry values.  As a result it is now
+possible to refer to custom environment variables in Application,
+AppDirectory and other parameters.
+
+
+Merged service environment
+--------------------------
+All Windows services can be passed additional environment variables by
+creating a multi-valued string (REG_MULTI_SZ) registry value named
+HLKM\SYSTEM\CurrentControlSet\Services\<service>\Environment.
+
+The contents of this environment block will be merged into the system
+environment before the service starts.
+
+Note, however, that the merged environment will be sorted alphabetically
+before being processed.  This means that in practice you cannot set,
+for example, DIR=%PROGRAMFILES% in the Environment block because the
+environment passed to the service will not have defined %PROGRAMFILES%
+by the time it comes to define %DIR%.  Environment variables defined in
+AppEnvironmentExtra do not suffer from this limitation.
+
+As of version 2.25, NSSM can get and set the Environment block using
+commands similar to:
+
+    nssm get <servicename> Environment
+
+It is worth reiterating that the Environment block is available to all
+Windows services, not just NSSM services.
+
+
+Service startup environment
+---------------------------
+The environment NSSM passes to the application depends on how various
+registry values are configured.  The following flow describes how the
+environment is modified.
+
+By default:
+    The service inherits the system environment.
+
+If <service>\Environment is defined:
+    The contents of Environment are MERGED into the environment.
+
+If <service>\Parameters\AppEnvironment is defined:
+    The service inherits the environment specified in AppEnvironment.
+
+If <service>\Parameters\AppEnvironmentExtra is defined:
+    The contents of AppEnvironmentExtra are APPENDED to the environment.
+
+Note that AppEnvironment overrides the system environment and the
+merged Environment block.  Note also that AppEnvironmentExtra is
+guaranteed to be appended to the startup environment if it is defined.
+
 
 Event hooks
 -----------
@@ -519,6 +574,12 @@ If the application crashes and is restarted by NSSM, the order might be:
   Exit/Post
 
 
+If NSSM is redirecting stdout or stderr it can be configured to redirect
+the output of any hooks it runs.  Set AppRedirectHooks to 1 to enable
+that functionality.  A hook can of course redirect its own I/O independently
+of NSSM.
+
+
 Managing services using the GUI
 -------------------------------
 NSSM can edit the settings of existing services with the same GUI that is
@@ -555,6 +616,7 @@ run NSSM itself.  The parameters recognised are as follows:
 
   Description: Service description.
   DisplayName: Service display name.
+  Environment: Service merged environment.
   ImagePath: Path to the service executable.
   ObjectName: User account which runs the service.
   Name: Service key name.
@@ -736,6 +798,13 @@ running multiple instances of NSSM from different locations may be confusing if
 they are not all the same version.
 
 
+Listing managed services
+------------------------
+The following command will print the names of all services managed by NSSM:
+
+    nssm list
+
+
 Example usage
 -------------
 To install an Unreal Tournament server:
@@ -822,6 +891,14 @@ application's child processes.
 Thanks to Miguel Angel Terrón for suggesting copy/truncate rotation.
 Thanks to Yuriy Lesiuk for suggesting setting the environment before querying
 the registry for parameters.
+Thanks to Gerald Haider for noticing that installing a service with NSSM in a
+path containing spaces was technically a security vulnerability.
+Thanks to Scott Ware for reporting a crash saving the environment on XP 32-bit.
+Thanks to Stefan and Michael Scherer for reporting a bug writing the event messages source.
+Thanks to Paul Baxter for help with Visual Studio 2015.
+Thanks to Mathias Breiner for help with Visual Studio and some registry fixes.
+Thanks to David Bremner for general tidyups.
+Thanks to Nabil Redmann for suggesting redirecting hooks' output.
 
 Licence
 -------