dinitcheck.8.m4 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. changequote(`@@@',`$$$')dnl
  2. @@@.TH DINITCHECK "8" "$$$MONTH YEAR@@@" "Dinit $$$VERSION@@@" "Dinit \- service management system"
  3. .SH NAME
  4. dinitcheck \- check service configuration
  5. .\"
  6. .SH SYNOPSIS
  7. .\"
  8. .nh
  9. .\"
  10. .HP
  11. .B dinitcheck
  12. [\fB\-d\fR|\fB\-\-services\-dir\fR \fIdir\fR]
  13. [\fIservice-name\fR...]
  14. .\"
  15. .hy
  16. .\"
  17. .SH DESCRIPTION
  18. .\"
  19. The \fBdinitcheck\fR utility checks the service configuration for
  20. \fBDinit\fR services (see \fBdinit\fR(8)), and reports any errors it finds.
  21. This allows for finding errors before they can cause a service to fail to
  22. load during system operation.
  23. .LP
  24. Errors reported by \fBdinitcheck\fR include:
  25. .IP \(bu
  26. Syntax errors
  27. .IP \(bu
  28. Invalid parameter values
  29. .IP \(bu
  30. Service dependency cycles
  31. .LP
  32. Unless altered by options specified on the command line, this utility uses the
  33. same search paths (for service description files) as \fBdinit\fR.
  34. .\"
  35. .SH OPTIONS
  36. .TP
  37. \fB\-d\fR \fIdir\fP, \fB\-\-services\-dir\fR \fIdir\fP
  38. Specifies \fIdir\fP as the directory containing service description files (can
  39. be given multiple times to specify multiple service directories).
  40. Default directories are not searched for services when this option is provided.
  41. See \fBdinit\fR(8) for defaults.
  42. .TP
  43. \fB\-n\fR, \fB\-\-online\fR
  44. Operate in "online" mode; contact a running instance of \fBdinit\fR to obtain the service directories
  45. and environment variables (used for substitution in service setting values).
  46. The \fB\-\-services\-dir\fR (\fB\-d\fR) and \fB\-\-env\-file\fR (\fB\-e\fR) options will be ignored.
  47. .TP
  48. \fB\-s\fR, \fB\-\-system\fR
  49. Use defaults for a system instance. This affects default service directories, environment file, and
  50. (when in online mode) control socket path. It is the default when run as the root user.
  51. .TP
  52. \fB\-u\fR, \fB\-\-user\fR
  53. Use defaults for a user instance. This affects default service directories, environment file, and
  54. (when in online mode) control socket path. It is the default when not run as the root user.
  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 value from the \fBDINIT_SOCKET_PATH\fR environment variable is used, with
  59. the default path (as documented for \fBdinit\fR(8)) used if the variable is unset.
  60. This option is ignored unless \fB\-\-online\fR (\fB\-n\fR) is also specified.
  61. .TP
  62. \fB\-e\fR \fIfile\fP, \fB\-\-env\-file\fR \fIfile\fP
  63. Read supplementary environment from \fIfile\fR, which should be in the format used by \fBdinit\fR(8).
  64. If not specified, the default is as for \fBdinit\fR(8).
  65. This setting is not used when \fB\-\-online\fR (\fB\-n\fR) is specified.
  66. .TP
  67. \fB\-\-help\fR
  68. Display brief help text and then exit.
  69. .TP
  70. \fIservice-name\fR
  71. Specifies the name of a service that should be checked (along with its
  72. dependencies).
  73. If none are specified, defaults to \fIboot\fR (which requires that a suitable
  74. service description for the \fIboot\fR service exists).
  75. .\"
  76. .SH NOTES
  77. .\"
  78. For service properties that are subject to environment variable substitution, including
  79. \fBsocket\-listen\fR, \fBlogfile\fR, \fBenv\-file\fR, \fBworking\-dir\fR and \fBpid\-file\fR, the
  80. substitution may have a different result when performed by \fBdinitcheck\fR than when performed by
  81. \fBdinit\fR if the two processes have a different environment.
  82. For this reason \fBdinitcheck\fR will issue a warning whenever substitution is used, unless run in
  83. "online" mode (\fB\-\-online\fR or \fB\-n\fR), in which case environment variable values are obtained
  84. from the running instance of \fBdinit\fR.
  85. .\"
  86. .SH SEE ALSO
  87. .\"
  88. \fBdinit\fR(8), \fBdinit-service\fR(5).
  89. .\"
  90. .SH AUTHOR
  91. Dinit, and this manual, were written by Davin McCall.
  92. $$$dnl