X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.txt;h=904468ae4da1418a95f22184757d7d5b84629c30;hb=0b386fc1984ab74ee59b7bed14b7e8f57212c22b;hp=b2f9c27b6cb76a43b94d1b910fa7e53a1ab9777e;hpb=8561a216b764d928364f432a590bead3547e1497;p=nssm.git diff --git a/README.txt b/README.txt index b2f9c27..904468a 100644 --- a/README.txt +++ b/README.txt @@ -1,5 +1,5 @@ NSSM: The Non-Sucking Service Manager -Version 2.8, 2011-02-26 +Version 2.16, 2012-12-01 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 @@ -9,7 +9,7 @@ NSSM also has a graphical service installer and remover. Full documentation can be found online at - http://iain.cx/src/nssm/ + http://nssm.cc/ Since version 2.0, the GUI can be bypassed by entering all appropriate options on the command line. @@ -28,6 +28,22 @@ Since version 2.8, NSSM tries harder to shut down the managed application gracefully and throttles restart attempts if the application doesn't run for a minimum amount of time. +Since version 2.11, NSSM respects srvany's AppEnvironment parameter. + +Since version 2.13, NSSM is translated into French. +Thanks François-Régis Tardy. + +Since version 2.15, NSSM is translated into Italian. +Thanks Riccardo Gusmeroli. + +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 @@ -61,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 -------------------- @@ -121,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 @@ -168,6 +214,9 @@ Building NSSM from source NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual Studio 2008. +NSSM will also compile with Visual Studio 2010 but the resulting executable +will not run on versions of Windows older than XP SP2. + Credits ------- @@ -178,6 +227,18 @@ Thanks to Arve Knudsen for spotting that child processes of the monitored application could be left running on service shutdown, and that a missing registry value for AppDirectory confused NSSM. Thanks to Peter Wagemans and Laszlo Keresztfalvi for suggesting throttling restarts. +Thanks to Eugene Lifshitz for finding an edge case in CreateProcess() and for +advising how to build messages.mc correctly in paths containing spaces. +Thanks to Rob Sharp for pointing out that NSSM did not respect the +AppEnvironment registry value used by srvany. +Thanks to Szymon Nowak for help with Windows 2000 compatibility. +Thanks to François-Régis Tardy for French translation. +Thanks to Emilio Frini for spotting that French was inadvertently set as +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 -------