X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=904468ae4da1418a95f22184757d7d5b84629c30;hb=0b386fc1984ab74ee59b7bed14b7e8f57212c22b;hp=ddc6092cd30978f992716fecc333606beead1878;hpb=b841998b630a15bb554da822b5f8ba3bbcb1b601;p=nssm.git diff --git a/README.txt b/README.txt index ddc6092..904468a 100644 --- a/README.txt +++ b/README.txt @@ -40,6 +40,10 @@ Since version 2.17, NSSM can try to shut down console applications by simulating a Control-C keypress. If they have installed a handler routine 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. + + Usage ----- In the usage notes below, arguments to the program may be written in angle @@ -73,6 +77,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 -------------------- @@ -133,6 +140,33 @@ 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. +I/O redirection +--------------- +NSSM can redirect the managed application's I/O to any path capable of being +opened by CreateFile(). This enables, for example, capturing the log output +of an application which would otherwise only write to the console or accepting +input from a serial port. + +NSSM will look in the registry under +HKLM\SYSTEM\CurrentControlSet\Services\\Parameters for the keys +corresponding to arguments to CreateFile(). All are optional. If no path is +given for a particular stream it will not be redirected. If a path is given +but any of the other values are omitted they will be receive sensible defaults. + + AppStdin: Path to receive input. + AppStdout: Path to receive output. + AppStderr: Path to receive error output. + +Parameters for CreateFile() are providing with the "AppStdinShareMode", +"AppStdinCreationDisposition" and "AppStdinFlagsAndAttributes" values (and +analogously for stdout and stderr). + +In general, if you want the service to log its output, set AppStdout and +AppStderr to the same path, eg C:\Users\Public\service.log, and it should +work. Remember, however, that the path must be accessible to the user +running the service. + + Removing services using the GUI ------------------------------- NSSM can also remove services. Run @@ -204,6 +238,7 @@ 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. Licence -------