README.txt 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. NSSM: The Non-Sucking Service Manager
  2. Version 2.1, 2009-12-28 by Benjamin Mayrargue (www.softlion.com)
  3. NSSM is a service helper program similar to srvany and cygrunsrv. It can
  4. start any application as an NT service and will restart the service if it
  5. fails for any reason.
  6. NSSM also has a graphical service installer and remover.
  7. Full documentation can be found online at
  8. http://iain.cx/src/nssm/
  9. Since version 2.0, the GUI can be bypassed by entering all appropriate
  10. options on the command line.
  11. Since version 2.1, NSSM can be compiled for x64 platforms.
  12. Thanks Benjamin Mayrargue.
  13. Usage
  14. -----
  15. In the usage notes below, arguments to the program may be written in angle
  16. brackets and/or square brackets. <string> means you must insert the
  17. appropriate string and [<string>] means the string is optional. See the
  18. examples below...
  19. Installation using the GUI
  20. --------------------------
  21. To install a service, run
  22. nssm install <servicename>
  23. You will be prompted to enter the full path to the application you wish
  24. to run and any command line options to pass to that application.
  25. Use the system service manager (services.msc) to control advanced service
  26. properties such as startup method and desktop interaction. NSSM may
  27. support these options at a later time...
  28. Installation using the command line
  29. -----------------------------------
  30. To install a service, run
  31. nssm install <servicename> <application> [<options>]
  32. NSSM will then attempt to install a service which runs the named application
  33. with the given options (if you specified any).
  34. Don't forget to enclose paths in "quotes" if they contain spaces!
  35. Managing the service
  36. --------------------
  37. NSSM will launch the application listed in the registry when you send it a
  38. start signal and will terminate it when you send a stop signal. So far, so
  39. much like srvany. But NSSM is the Non-Sucking service manager and will take
  40. action if/when the application dies.
  41. NSSM will try to restart itself if it notices that the application died but
  42. you didn't send it a stop signal. NSSM will keep trying, pausing 30 seconds
  43. between each attempt, until the service is successfully started or you send
  44. it a stop signal.
  45. Removing services using the GUI
  46. -------------------------------
  47. NSSM can also remove services. Run
  48. nssm remove <servicename>
  49. to remove a service. You will prompted for confirmation before the service
  50. is removed. Try not to remove essential system services...
  51. Removing service using the command line
  52. ---------------------------------------
  53. To remove a service without confirmation from the GUI, run
  54. nssm remove <servicename> confirm
  55. Try not to remove essential system services...
  56. Example usage
  57. -------------
  58. To install an Unreal Tournament server:
  59. nssm install UT2004 c:\games\ut2004\system\ucc.exe server
  60. To remove the server:
  61. nssm remove UT2004 confirm
  62. Building NSSM from source
  63. -------------------------
  64. NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual
  65. Studio 2008.
  66. Credits
  67. -------
  68. Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.
  69. Licence
  70. -------
  71. NSSM is public domain. You may unconditionally use it and/or its source code
  72. for any purpose you wish.