mirrors/winsw
1
0
Fork 0
mirror of https://github.com/winsw/winsw.git synced 2025-12-10 18:37:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Revise docs for 3.0.0-alpha.2 (#594)

Browse Source 
* Update links

* Remove `<waithint>` and `<sleeptime>`

* Create cli-commands.md

* Update migrate-to-3-x.md

* Update the Usage section

* Fix broken link

* Add `--force` to `stop` and `restart`

* CAUTION

* WIP Add extra steps

* Split removals

* Update additional commands

* Update cli-commands.md

* Update README.md

* Update README.md

* NOTE

* Update copyright texts

* Temporarily skip failing test

* Suggest using command-line options
This commit is contained in:
Next Turn
2020-07-28 08:35:18 +08:00
committed by GitHub
parent 3ea68e2d20
commit 1b2365a99a
10 changed files with 299 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -21,8 +21,7 @@ See the [project manifest](MANIFEST.md).
## Supported platforms
WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1.
It can run on Windows platforms which have these versions of .NET Framework installed.
WinSW 3 can run on Windows platforms with .NET Framework 4.6.1 or later versions installed.
For systems without .NET Framework, the project provides native 64-bit and 32-bit executables based on .NET Core.
More executables can be added upon request.
@@ -42,64 +41,35 @@ WinSW is being managed by the [XML configuration file](docs/xml-config-file.md).
Your renamed *WinSW.exe* binary also accepts the following commands:
* `install`
Install the service to Windows Service Controller.
This command requires some preliminary steps described in the [Installation guide](docs/installation.md).
* `uninstall`
Uninstall the service. The opposite operation of above.
* `start`
Start the service. The service must have already been installed.
* `stop`
Stop the service.
* `stopwait`
Stop the service and wait until it's actually stopped.
* `restart`
Restart the service. If the service is not currently running, this command acts like `start`.
* `status`
Check the current status of the service.
* This command prints one line to the console.
* `NonExistent` indicates the service is not currently installed
* `Started` to indicate the service is currently running
* `Stopped` to indicate that the service is installed but not currently running.
| Command | Description |
| ----------- | ----------- |
| [install](docs/cli-commands.md#install-command) | Installs the service. This command requires some preliminary steps described in the [installation guide](docs/installation.md). |
| [uninstall](docs/cli-commands.md#uninstall-command) | Uninstalls the service. |
| [start](docs/cli-commands.md#start-command) | Starts the service. |
| [stop](docs/cli-commands.md#stop-command) | Stops the service. |
| [restart](docs/cli-commands.md#restart-command) | Stops and then starts the service. |
| [status](docs/cli-commands.md#status-command) | Checks the status of the service. |
| [test](docs/cli-commands.md#test-command) | Checks if the service can be started and then stopped without installation. |
| [refresh](docs/cli-commands.md#refresh-command) | Refreshes the service properties without reinstallation. |
Most commands require Administrator privileges to execute. Since 2.8, WinSW will prompt for UAC in non-elevated sessions.
## Documentation
User documentation:
* [Installation guide](docs/installation.md) - Describes the installation process for different systems and .NET versions
* [Migration guide](docs/migrate-to-3-x) - Migrate to WinSW 3.x.
* [Get started](docs/installation.md)
* [Migrate to WinSW 3.x](docs/migrate-to-3-x)
* Configuration:
* [Main XML configuration file](docs/xml-config-file.md)
* [EXE configuration file](docs/exe-config-file.md)
* [XML configuration file](docs/xml-config-file.md)
* [Logging and error reporting](docs/logging-and-error-reporting.md)
* [Extensions](docs/extensions/extensions.md)
* Use-cases:
* [Shared Directory Mapper](docs/extensions/shared-directory-mapper.md)
* Use cases:
* [Self-restarting services](docs/self-restarting-service.md)
* [Deferred file operations](docs/deferred-file-operations.md)
Developer documentation:
* [Developer guide](DEVELOPER.md)
## Contributing
Contributions are welcome!
No Contributor License Agreement is needed, just submit your pull requests.
See the [contributing guidelines](CONTRIBUTING.md) for more information.
## License