doc/manpages/dinitcheck.8.m4

   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 .HP \w'\ 'u
   9 .B dinitcheck
  10 [\fB\-d\fR|\fB\-\-services\-dir\fR \fIdir\fR]
  11 [\fIservice-name\fR...]
  12 .\"
  13 .SH DESCRIPTION
  14 .\"
  15 The \fBdinitcheck\fR utility checks the service configuration for
  16 \fBDinit\fR services (see \fBdinit\fR(8)), and reports any errors it finds.
  17 This allows for finding errors before they can cause a service to fail to
  18 load during system operation.
  19 .LP
  20 Errors reported by \fBdinitcheck\fR include:
  21 .IP \(bu
  22 Syntax errors
  23 .IP \(bu
  24 Invalid parameter values
  25 .IP \(bu
  26 Service dependency cycles
  27 .LP
  28 Unless altered by options specified on the command line, this utility uses the
  29 same search paths (for service description files) as \fBdinit\fR.
  30 .\"
  31 .SH OPTIONSs
  32 .TP
  33 \fB\-d\fR \fIdir\fP, \fB\-\-services\-dir\fR \fIdir\fP
  34 Specifies \fIdir\fP as the directory containing service definition files.
  35 The directory specified will be the only directory searched for service
  36 definitions.
  37
  38 If not specified, the default is \fI$HOME/dinit.d\fR or, for the
  39 system service manager, each of \fI/etc/dinit.d/fR, \fI/usr/local/lib/dinit.d\fR,
  40 and \fI/lib/dinit.d\fR (searched in that order).
  41 .TP
  42 \fB\-\-help\fR
  43 Display brief help text and then exit.
  44 .TP
  45 \fIservice-name\fR
  46 Specifies the name of a service that should be checked (along with its
  47 dependencies). If none are specified, defaults to \fIboot\fR (which requires
  48 that a suitable service description for the \fIboot\fR service exists).
  49 .\"
  50 .SH SEE ALSO
  51 .\"
  52 \fBdinit\fR(8), \fBdinit-service\fR(5).
  53 .\"
  54 .SH AUTHOR
  55 Dinit, and this manual, were written by Davin McCall.
  56 $$$dnl