Browse Source

Revise docs for 3.0.0-alpha.5 (#689)

* Revise docs for 3.0.0-alpha.5

* Revise docs for 3.0.0-alpha.5
Next Turn 5 years ago
parent
commit
c24ca31aae
3 changed files with 11 additions and 5 deletions
  1. 1 1
      README.md
  2. 7 1
      docs/cli-commands.md
  3. 3 3
      samples/sample-complete.xml

+ 1 - 1
README.md

@@ -75,7 +75,7 @@ Most commands require Administrator privileges to execute. WinSW will prompt for
 ## Documentation
 
 * [Get started](docs/installation.md)
-* [Migrate to WinSW 3.x](docs/migrate-to-3-x)
+* [Migrate to WinSW 3.x](docs/migrate-to-3-x.md)
 * Configuration:
   * [XML configuration file](docs/xml-config-file.md)
   * [Logging and error reporting](docs/logging-and-error-reporting.md)

+ 7 - 1
docs/cli-commands.md

@@ -247,9 +247,15 @@ Draws the process tree associated with the service.
 ### Usage
 
 ```console
-winsw dev ps [<path-to-config>]
+winsw dev ps [<path-to-config>] [-a|--all]
 ```
 
+### Options
+
+- `-a|--all`
+
+  Optional. Draws the process tree associated with all services.
+
 ## `dev kill` command
 
 Terminates the service if it has stopped responding.

+ 3 - 3
samples/sample-complete.xml

@@ -40,6 +40,9 @@ All options in other sections are optional
   <!-- ID of the service. It should be unique accross the Windows system-->
   <id>myapp</id>
 
+  <!-- Path to the executable, which should be started -->
+  <executable>%BASE%\myExecutable.exe</executable>
+
   <!-- Display name of the service -->
   <!--
   <name>MyApp Service (powered by WinSW)</name>
@@ -50,9 +53,6 @@ All options in other sections are optional
   <description>This service is a service created from a sample configuration</description>
   -->
 
-  <!-- Path to the executable, which should be started -->
-  <executable>%BASE%\myExecutable.exe</executable>
-
 <!--
 SECTION: Installation
 These options are being used during the installation only.