Docs: Fix links

pull/129/head
Oleg Nenashev 2016-11-25 23:56:39 +03:00
parent 26a25c72a1
commit 1bb286cc4c
3 changed files with 18 additions and 9 deletions

View File

@ -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)

View File

@ -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.
When winsw is running as a service, more detailed error information is reported to the Windows event log.

View File

@ -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 `<onfailure>` below for how to specify time duration:
@ -210,7 +210,7 @@ Possible values are `idle`, `belownormal`, `normal`, `abovenormal`, `high`, `rea
<priority>idle</priority>
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