From 1bb286cc4cbe80f7d2d9fffa0251fab748a50489 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 25 Nov 2016 23:56:39 +0300 Subject: [PATCH] Docs: Fix links --- README.md | 17 +++++++++++++---- doc/loggingAndErrorReporting.md | 4 ++-- doc/xmlConfigFile.md | 6 +++--- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a8d583f..b39d6b9 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,19 @@ Unix systems have their own conventions for daemons, so a good behaving Unix dae ### Download [Binaries are available here](http://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/) -### Available commands -Your renamed `winsw.exe` accepts the following commands: +### Description -* `install` to install the service to Windows Service Controller +WinSW is an executable binary, which can be used to wrap and manage a custom process as a Windows service. +Once you download the installation package, you can rename `winsw.exe` to any name, e.g. `myService.exe`. + +WinSW is being managed by configuration files. + +* + +Your renamed `winsw.exe` binary accepts the following commands: + +* `install` to install the service to Windows Service Controller. + This command requires some preliminary steps described in the [Installation Guide](doc/installation.md). * `uninstall` to uninstall the service. The opposite operation of above. * `start` to start the service. The service must have already been installed. * `stop` to stop the service. @@ -31,7 +40,7 @@ Your renamed `winsw.exe` accepts the following commands: ### Documentation -* [Installation Guide](doc/protocols.md) - Describes the installation process for different systems and .NET versions +* [Installation Guide](doc/installation.md) - Describes the installation process for different systems and .NET versions * Configuration: * [Main XML Configuration file](doc/xmlConfigFile.md) * [Configuration File](doc/xmlConfigFile.md) diff --git a/doc/loggingAndErrorReporting.md b/doc/loggingAndErrorReporting.md index 900364e..d6b7b92 100644 --- a/doc/loggingAndErrorReporting.md +++ b/doc/loggingAndErrorReporting.md @@ -53,6 +53,6 @@ For example, in the above example, the log of Jan 1, 2013 gets written to `myapp ### Error reporting Winsw uses WMI underneath, and as such it uses its error code as the exit code. -See the MSDN article [Create method of the Win32_Service class](http://msdn.microsoft.com/en-us/library/aa389390(VS.85).aspx) for the complete list of exit code. +See the MSDN article [Create method of the Win32_Service class](http://msdn.microsoft.com/en-us/library/aa389390%28VS.85%29.aspx) for the complete list of exit code. -When winsw is running as a service, more detailed error information is reported to the Windows event log. \ No newline at end of file +When winsw is running as a service, more detailed error information is reported to the Windows event log. diff --git a/doc/xmlConfigFile.md b/doc/xmlConfigFile.md index 533e9c9..e349269 100644 --- a/doc/xmlConfigFile.md +++ b/doc/xmlConfigFile.md @@ -102,10 +102,10 @@ Note that the name of the element is `startargument` and not `startarguments`. As such, to specify multiple arguments, you'll specify multiple elements. ### stoptimeout -When the service is requested to stop, winsw first attempts to [GenerateConsoleCtrlEvent function](http://msdn.microsoft.com/en-us/library/windows/desktop/ms683155(v=vs.85).aspx) (similar to Ctrl+C), +When the service is requested to stop, winsw first attempts to [GenerateConsoleCtrlEvent function](http://msdn.microsoft.com/en-us/library/windows/desktop/ms683155%28v=vs.85%29.aspx) (similar to Ctrl+C), then wait for up to 15 seconds for the process to exit by itself gracefully. A process failing to do that (or if the process does not have a console), - then winsw resorts to calling [TerminateProcess function](http://msdn.microsoft.com/en-us/library/windows/desktop/ms686714(v=vs.85).aspx ) API to kill the service instantly. + then winsw resorts to calling [TerminateProcess function](http://msdn.microsoft.com/en-us/library/windows/desktop/ms686714%28v=vs.85%29.aspx ) API to kill the service instantly. This optional element allows you to change this "15 seconds" value, so that you can control how long winsw gives the service to shut itself down. See `` below for how to specify time duration: @@ -210,7 +210,7 @@ Possible values are `idle`, `belownormal`, `normal`, `abovenormal`, `high`, `rea idle Specifying a priority higher than normal has unintended consequences. -See the MSDN article [ProcessPriorityClass Enumeration](http://msdn.microsoft.com/en-us/library/system.diagnostics.processpriorityclass(v=vs.110).aspx) for details. +See the MSDN article [ProcessPriorityClass Enumeration](http://msdn.microsoft.com/en-us/library/system.diagnostics.processpriorityclass%28v=vs.110%29.aspx) for details. This feature is intended primarily to launch a process in a lower priority so as not to interfere with the computer's interactive usage. ###stopparentprocessfirst