Legacy quick'n'dirtiness.

[nssm.git] / README.txt

diff --git a/README.txt b/README.txt
index a7655d9..19fcb8e 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -58,16 +58,19 @@ Since version 2.22, NSSM can rotate existing output files when redirecting I/O.
 Since version 2.22, NSSM can set service display name, description, startup\r
 type and log on details.\r
 \r
-Since version 2.22, NSSM can edit existing services.\r
+Since version 2.22, NSSM can manage existing services.\r
 \r
 \r
 Usage\r
 -----\r
-In the usage notes below, arguments to the program may be written in angle \r
-brackets and/or square brackets.  <string> means you must insert the \r
-appropriate string and [<string>] means the string is optional.  See the \r
+In the usage notes below, arguments to the program may be written in angle\r
+brackets and/or square brackets.  <string> means you must insert the\r
+appropriate string and [<string>] means the string is optional.  See the\r
 examples below...\r
 \r
+Note that everywhere <servicename> appears you may substitute the\r
+service's display name.\r
+\r
 \r
 Installation using the GUI\r
 --------------------------\r
@@ -321,6 +324,7 @@ run NSSM itself.  The parameters recognised are as follows:
   DisplayName: Service display name.\r
   ImagePath: Path to the service executable.\r
   ObjectName: User account which runs the service.\r
+  Name: Service key name.\r
   Start: Service startup type.\r
   Type: Service type.\r
 \r
@@ -378,6 +382,12 @@ exit code of 2, run
     nssm set <servicename> AppExit 2 Exit\r
 \r
 \r
+The Name parameter can only be queried, not set.  It returns the service's\r
+registry key name.  This may be useful to know if you take advantage of\r
+the fact that you can substitute the service's display name anywhere where\r
+the syntax calls for <servicename>.\r
+\r
+\r
 The ObjectName parameter requires an additional argument only when setting\r
 a username.  The additional argument is the password of the user.\r
 \r
@@ -423,6 +433,17 @@ is in two stages as follows.
     nssm set <servicename> Type SERVICE_INTERACTIVE_PROCESS\r
 \r
 \r
+Controlling services using the command line\r
+-------------------------------------------\r
+NSSM offers rudimentary service control features.\r
+\r
+    nssm start <servicename>\r
+\r
+    nssm stop <servicename>\r
+\r
+    nssm status <servicename>\r
+\r
+\r
 Removing services using the GUI\r
 -------------------------------\r
 NSSM can also remove services.  Run\r
@@ -472,6 +493,10 @@ To remove the server:
 \r
     nssm remove UT2004 confirm\r
 \r
+To find out the service name of a service with a display name:\r
+\r
+    nssm get "Background Intelligent Transfer Service" Name\r
+\r
 \r
 Building NSSM from source\r
 -------------------------\r