NSSM 1.0.
[nssm.git] / README.txt
1 NSSM: The Non-Sucking Service Manager\r
2 Version 1.0, 2003-05-30\r
3 \r
4 NSSM is a service helper program similar to srvany and cygrunsrv.  It can \r
5 start any application as an NT service and will restart the service if it \r
6 fails for any reason.\r
7 \r
8 NSSM also has a graphical service installer and remover.\r
9 \r
10 \r
11 Installation\r
12 ------------\r
13 To install a service, run\r
14 \r
15     nssm install servicename\r
16 \r
17 You will be prompted to enter the full path to the application you wish \r
18 to run and any commandline options to pass to that application.\r
19 \r
20 Use the system service manager (services.msc) to control advanced service \r
21 properties such as startup method and desktop interaction.  NSSM may \r
22 support these options at a later time...\r
23 \r
24 \r
25 Managing the service\r
26 --------------------\r
27 NSSM will launch the application listed in the registry when you send it a \r
28 start signal and will terminate it when you send a stop signal.  So far, so \r
29 much like srvany.  But NSSM is the Non-Sucking service manager and will take \r
30 action if/when the application dies.\r
31 \r
32 NSSM will try to restart itself if it notices that the application died but \r
33 you didn't send it a stop signal.  NSSM will keep trying, pausing 30 seconds \r
34 between each attempt, until the service is successfully started or you send \r
35 it a stop signal.\r
36 \r
37 \r
38 Removing services\r
39 -----------------\r
40 NSSM can also remove services.  Run\r
41 \r
42     nssm remove servicename\r
43 \r
44 to remove a service.  You will prompted for confirmation before the service \r
45 is removed.  Try not to remove essential system services...\r
46 \r
47 \r
48 Licence\r
49 -------\r
50 NSSM is public domain.  You may unconditionally use it and/or its source code \r
51 for any purpose you wish.\r