dinit-monitor.8.m4 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. changequote(`@@@',`$$$')dnl
  2. @@@.TH DINIT\-MONITOR "8" "$$$MONTH YEAR@@@" "Dinit $$$VERSION@@@" "Dinit \- service management system"
  3. .SH NAME
  4. dinit\-monitor \- monitor services supervised by Dinit
  5. .\"
  6. .SH SYNOPSIS
  7. .\"
  8. .PD 0
  9. .nh
  10. .HP
  11. .B dinit-monitor
  12. [\fIoptions\fR] {\fB\-c\fR \fIcommand\fR, \fB\-\-command\fR \fIcommand\fR} \fIservice-name\fR [\fIservice-name\fR...]
  13. .\"
  14. .PD
  15. .hy
  16. .\"
  17. .SH DESCRIPTION
  18. .\"
  19. \fBdinit\-monitor\fR is a utility to monitor the state of one or more services managed by the \fBdinit\fR daemon.
  20. Changes in service state are reported by the execution of the specified command.
  21. .\"
  22. .SH GENERAL OPTIONS
  23. .TP
  24. \fB\-\-help\fR
  25. Display brief help text and then exit.
  26. .TP
  27. \fB\-\-version\fR
  28. Display version and then exit.
  29. .TP
  30. \fB\-s\fR, \fB\-\-system\fR
  31. Control the system init process (this is the default when run as root).
  32. This option determines the default path to the control socket used to communicate with the \fBdinit\fR daemon
  33. process (it does not override the \fB\-p\fR option).
  34. .TP
  35. \fB\-u\fR, \fB\-\-user\fR
  36. Control the user init process (this is the default when not run as root).
  37. This option determines the default path to the control socket used to communicate with the \fBdinit\fR daemon process
  38. (it does not override the \fB\-p\fR option).
  39. .TP
  40. \fB\-i\fR, \fB\-\-initial\fR
  41. Issue the specified command additionally for the initial status of the services (when \fBdinit\-monitor\fR is started).
  42. Without this option, the command is only executed whenever service status changes.
  43. .TP
  44. \fB\-\-str\-started\fR \fIstarted-text\fR\br\fB\-\-test\fR
  45. Specify the text used for the substitution of the status in the command (as specified
  46. by the \fB\-\-command\fR option) when a service starts.
  47. .TP
  48. \fB\-\-str\-stopped\fR \fIstopped-text\fR
  49. Specify the text used for the substitution of the status in the command (as specified
  50. by the \fB\-\-command\fR option) when a service stops.
  51. .TP
  52. \fB\-\-str\-failed\fR \fIfailed-text\fR
  53. Specify the text used for the substitution of the status in the command (as specified
  54. by the \fB\-\-command\fR option) when a service fails to start.
  55. .TP
  56. \fB\-\-socket\-path\fR \fIsocket-path\fR, \fB\-p\fR \fIsocket-path\fR
  57. Specify the path to the socket used for communicating with the service manager daemon.
  58. When not specified, the \fIDINIT_SOCKET_PATH\fR environment variable is read, otherwise
  59. Dinit's default values are used.
  60. .\"
  61. .SH STATUS REPORT OPTIONS
  62. .TP
  63. \fB\-\-command\fR \fIcommand\fR, \fB\-c\fR \fIcommand\fR
  64. Execute the specified \fIcommand\fR when the service status changes. In \fIcommand\fR, \fB%n\fR
  65. will be substituted with the service name and \fB%s\fR will be substituted with a textual
  66. description of the new status (\fBstarted\fR, \fBstopped\fR or \fBfailed\fR). A double percent sign
  67. (\fB%%\fR) is substituted with a single percent sign character.
  68. .\"
  69. .SH OPERATION
  70. .\"
  71. The \fBdinit-monitor\fR program will wait until a monitored service changes status, and execute
  72. the notification command. When execution of the notification command completes, dinit-monitor will
  73. resume monitoring of service status.
  74. .LP
  75. The monitoring provided by \fBdinit-monitor\fR is not intended to be used for system-critical
  76. purposes. If system load is particularly high, for example, notifications may be skipped.
  77. .\"
  78. .SH SEE ALSO
  79. \fBdinit\fR(8), \fBdinitctl\fR(8).
  80. .\"
  81. .SH AUTHOR
  82. Dinit, and this manual, were written by Davin McCall.
  83. $$$dnl