mirror of https://github.com/winsw/winsw
markdownlint fixes
parent
4d852bdbff
commit
e459165281
|
@ -17,13 +17,13 @@ You can open `src\winsw.sln` and then build and run tests from within Visual Stu
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
```
|
```console
|
||||||
dotnet build src\winsw.sln
|
dotnet build src\winsw.sln
|
||||||
```
|
```
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
```
|
```console
|
||||||
dotnet test src\Test\winswTests\winswTests.csproj
|
dotnet test src\Test\winswTests\winswTests.csproj
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ Installs the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw install [<path-to-config>] [--no-elevate] [--user|--username <username>] [--pass|--password <password>]
|
winsw install [<path-to-config>] [--no-elevate] [--user|--username <username>] [--pass|--password <password>]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ Uninstalls the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw uninstall [<path-to-config>] [--no-elevate]
|
winsw uninstall [<path-to-config>] [--no-elevate]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -71,7 +71,7 @@ Starts the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw start [<path-to-config>] [--no-elevate]
|
winsw start [<path-to-config>] [--no-elevate]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -94,7 +94,7 @@ Stops the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw stop [<path-to-config>] [--no-elevate] [--no-wait]
|
winsw stop [<path-to-config>] [--no-elevate] [--no-wait]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -125,7 +125,7 @@ Stops and then starts the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw restart [<path-to-config>] [--no-elevate]
|
winsw restart [<path-to-config>] [--no-elevate]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -152,7 +152,7 @@ Checks the status of the service.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw status [<path-to-config>]
|
winsw status [<path-to-config>]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -169,7 +169,7 @@ Checks if the service can be started and then stopped without installation.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw test [<path-to-config>] [--no-elevate] [--timeout <timeout>] [--no-break]
|
winsw test [<path-to-config>] [--no-elevate] [--timeout <timeout>] [--no-break]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -202,7 +202,7 @@ Refreshes the service properties without reinstallation.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
winsw refresh [<path-to-config>] [--no-elevate]
|
winsw refresh [<path-to-config>] [--no-elevate]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,7 @@ The only way to create an external extension is to create a new extension DLL an
|
||||||
See the example in `src/Core/ServiceWrapper/winsw.csproj`.
|
See the example in `src/Core/ServiceWrapper/winsw.csproj`.
|
||||||
|
|
||||||
Generic extension creation guideline:
|
Generic extension creation guideline:
|
||||||
|
|
||||||
* Extension DLL should reference the `WinSWCore` library.
|
* Extension DLL should reference the `WinSWCore` library.
|
||||||
* The extension should extend the `AbstractWinSWExtension` class.
|
* The extension should extend the `AbstractWinSWExtension` class.
|
||||||
* The extension then can override event handlers offered by the upper class.
|
* The extension then can override event handlers offered by the upper class.
|
||||||
|
|
|
@ -39,7 +39,7 @@ The full specification of the configuration file is available [here](xml-config-
|
||||||
|
|
||||||
You can then install the service like:
|
You can then install the service like:
|
||||||
|
|
||||||
```
|
```console
|
||||||
myapp.exe install <OPTIONS>
|
myapp.exe install <OPTIONS>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -81,7 +81,6 @@ For example, in the above example, at the start of the day it will roll the file
|
||||||
:warning: This feature is reported to be broken in recent WinSW versions.
|
:warning: This feature is reported to be broken in recent WinSW versions.
|
||||||
It is a potential subject for removal.
|
It is a potential subject for removal.
|
||||||
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<log mode="roll-by-size-time">
|
<log mode="roll-by-size-time">
|
||||||
<zipOlderThanNumDays>5</zipOlderThanNumDays>
|
<zipOlderThanNumDays>5</zipOlderThanNumDays>
|
||||||
|
|
|
@ -76,6 +76,7 @@ Windows service installation may fail in such case.
|
||||||
```
|
```
|
||||||
|
|
||||||
### depend
|
### depend
|
||||||
|
|
||||||
Specify IDs of other services that this service depends on.
|
Specify IDs of other services that this service depends on.
|
||||||
When service `X` depends on service `Y`, `X` can only run if `Y` is running.
|
When service `X` depends on service `Y`, `X` can only run if `Y` is running.
|
||||||
|
|
||||||
|
@ -204,6 +205,7 @@ By default, the `download` command does not fail the service startup if the oper
|
||||||
In order to force the download failure in such case, it is possible to specify the `failOnError` boolean attribute.
|
In order to force the download failure in such case, it is possible to specify the `failOnError` boolean attribute.
|
||||||
|
|
||||||
To specify a custom proxy use the parameter `proxy` with the following formats:
|
To specify a custom proxy use the parameter `proxy` with the following formats:
|
||||||
|
|
||||||
- With credentials: `http://USERNAME:PASSWORD@HOST:PORT/`.
|
- With credentials: `http://USERNAME:PASSWORD@HOST:PORT/`.
|
||||||
- Without credentials: `http://HOST:PORT/`.
|
- Without credentials: `http://HOST:PORT/`.
|
||||||
|
|
||||||
|
@ -272,7 +274,6 @@ This affects the behaviour of the failure actions (see `<onfailure>` above).
|
||||||
In other words, this is the duration in which you consider the service has been running successfully.
|
In other words, this is the duration in which you consider the service has been running successfully.
|
||||||
Defaults to 1 day.
|
Defaults to 1 day.
|
||||||
|
|
||||||
|
|
||||||
### Security descriptor
|
### Security descriptor
|
||||||
|
|
||||||
The security descriptor string for the service in SDDL form.
|
The security descriptor string for the service in SDDL form.
|
||||||
|
|
Loading…
Reference in New Issue