NSSM 2.0.

[nssm.git] / README.txt

diff --git a/README.txt b/README.txt
index ae081d2..21718ba 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
 NSSM: The Non-Sucking Service Manager\r
-Version 1.0, 2003-05-30\r
+Version 2.0, 2006-09-09\r
 \r
 NSSM is a service helper program similar to srvany and cygrunsrv.  It can \r
 start any application as an NT service and will restart the service if it \r
@@ -7,21 +7,44 @@ fails for any reason.
 \r
 NSSM also has a graphical service installer and remover.\r
 \r
+Since version 2.0, the GUI can be bypassed by entering all appropriate \r
+options on the command line.\r
 \r
-Installation\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
+examples below...\r
+\r
+\r
+Installation using the GUI\r
+--------------------------\r
 To install a service, run\r
 \r
-    nssm install servicename\r
+    nssm install <servicename>\r
 \r
 You will be prompted to enter the full path to the application you wish \r
-to run and any commandline options to pass to that application.\r
+to run and any command line options to pass to that application.\r
 \r
 Use the system service manager (services.msc) to control advanced service \r
 properties such as startup method and desktop interaction.  NSSM may \r
 support these options at a later time...\r
 \r
 \r
+Installation using the command line\r
+-----------------------------------\r
+To install a service, run\r
+\r
+    nssm install <servicename> <application> [<options>]\r
+\r
+NSSM will then attempt to install a service which runs the named application \r
+with the given options (if you specified any).\r
+\r
+Don't forget to enclose paths in "quotes" if they contain spaces!\r
+\r
+\r
 Managing the service\r
 --------------------\r
 NSSM will launch the application listed in the registry when you send it a \r
@@ -35,16 +58,41 @@ between each attempt, until the service is successfully started or you send
 it a stop signal.\r
 \r
 \r
-Removing services\r
------------------\r
+Removing services using the GUI\r
+-------------------------------\r
 NSSM can also remove services.  Run\r
 \r
-    nssm remove servicename\r
+    nssm remove <servicename>\r
 \r
 to remove a service.  You will prompted for confirmation before the service \r
 is removed.  Try not to remove essential system services...\r
 \r
 \r
+Removing service using the command line\r
+---------------------------------------\r
+To remove a service without confirmation from the GUI, run\r
+\r
+    nssm remove <servicename> confirm\r
+\r
+Try not to remove essential system services...\r
+\r
+\r
+Example usage\r
+-------------\r
+To install an Unreal Tournament server:\r
+\r
+    nssm install UT2004 c:\games\ut2004\system\ucc.exe server\r
+\r
+To remove the server:\r
+\r
+    nssm remove UT2004 confirm\r
+\r
+\r
+Building NSSM from source\r
+-------------------------\r
+NSSM is known to compile with Visual Studio 6 and Visual Studio 2005.\r
+\r
+\r
 Licence\r
 -------\r
 NSSM is public domain.  You may unconditionally use it and/or its source code \r