From: Davin McCall <davmac@davmac.org>
Date: Thu, 21 Nov 2019 16:51:37 +0000 (+0000)
Subject: Initial manpage for dinitcheck
X-Git-Tag: v0.8.0~25
X-Git-Url: https://git.librecmc.org/?p=oweals%2Fdinit.git;a=commitdiff_plain;h=92a60fb39f816f5b6baf649756aed71fec624685

Initial manpage for dinitcheck
---

diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile
index c343a8f..8ac2167 100644
--- a/doc/manpages/Makefile
+++ b/doc/manpages/Makefile
@@ -3,11 +3,11 @@ include ../../src/version.conf
 
 all: generate
 
-generate: dinit.8 dinitctl.8 dinit-service.5 shutdown.8
+generate: dinit.8 dinitctl.8 dinitcheck.8 dinit-service.5 shutdown.8
 
 install: generate
 	mkdir -p "$(DESTDIR)$(MANDIR)/man8"
-	install -m644 dinit.8 dinitctl.8 "$(DESTDIR)$(MANDIR)/man8"
+	install -m644 dinit.8 dinitctl.8 dinitcheck.8 "$(DESTDIR)$(MANDIR)/man8"
 	mkdir -p "$(DESTDIR)$(MANDIR)/man5"
 	install -m644 dinit-service.5 "$(DESTDIR)$(MANDIR)/man5"
 ifeq ($(BUILD_SHUTDOWN),yes)
@@ -17,7 +17,7 @@ ifeq ($(BUILD_SHUTDOWN),yes)
 endif
 
 clean:
-	rm -f dinit.8 dinitctl.8 dinit-service.5 shutdown.8
+	rm -f dinit.8 dinitctl.8 dinitcheck.8 dinit-service.5 shutdown.8
 
 dinit.8: dinit.8.m4
 	m4 -DVERSION=$(VERSION) -DMONTH=$(MONTH) -DYEAR=$(YEAR) dinit.8.m4 > dinit.8
@@ -25,6 +25,9 @@ dinit.8: dinit.8.m4
 dinitctl.8: dinitctl.8.m4
 	m4 -DVERSION=$(VERSION) -DMONTH=$(MONTH) -DYEAR=$(YEAR) dinitctl.8.m4 > dinitctl.8
 
+dinitcheck.8: dinitcheck.8.m4
+	m4 -DVERSION=$(VERSION) -DMONTH=$(MONTH) -DYEAR=$(YEAR) dinitcheck.8.m4 > dinitcheck.8
+
 dinit-service.5: dinit-service.5.m4
 	m4 -DVERSION=$(VERSION) -DMONTH=$(MONTH) -DYEAR=$(YEAR) dinit-service.5.m4 > dinit-service.5
 
diff --git a/doc/manpages/dinitcheck.8.m4 b/doc/manpages/dinitcheck.8.m4
new file mode 100644
index 0000000..41bbd0d
--- /dev/null
+++ b/doc/manpages/dinitcheck.8.m4
@@ -0,0 +1,48 @@
+changequote(`@@@',`$$$')dnl
+@@@.TH DINITCHECK "8" "$$$MONTH YEAR@@@" "Dinit $$$VERSION@@@" "Dinit \- service management system"
+.SH NAME
+dinitcheck \- check service configuration
+.\"
+.SH SYNOPSIS
+.\"
+.HP \w'\ 'u
+.B dinitcheck
+[\fB\-d\fR|\fB\-\-services\-dir\fR \fIdir\fR]
+[\fIservice-name\fR...]
+.\"
+.SH DESCRIPTION
+.\"
+The \fBdinitcheck\fR utility checks the service configuration for
+\fBDinit\fR services (see \fBdinit\fR(8)), and reports any errors it finds.
+This allows for finding errors before they can cause a service to fail to
+load during system operation.
+
+Unless altered by options specified on the command line, this utility uses the
+same search paths (for service description files) as \fBdinit\fR.
+.\"
+.SH OPTIONSs
+.TP
+\fB\-d\fR \fIdir\fP, \fB\-\-services\-dir\fR \fIdir\fP
+Specifies \fIdir\fP as the directory containing service definition files.
+The directory specified will be the only directory searched for service
+definitions.
+
+If not specified, the default is \fI$HOME/dinit.d\fR or, for the
+system service manager, each of \fI/etc/dinit.d/fR, \fI/usr/local/lib/dinit.d\fR,
+and \fI/lib/dinit.d\fR (searched in that order).
+.TP
+\fB\-\-help\fR
+Display brief help text and then exit.
+.TP
+\fIservice-name\fR
+Specifies the name of a service that should be checked (along with its
+dependencies). If none are specified, defaults to \fIboot\fR (which requires
+that a suitable service description for the \fIboot\fR service exists).
+.\"
+.SH SEE ALSO
+.\"
+\fBdinit\fR(8), \fBdinit-service\fR(5).
+.\"
+.SH AUTHOR
+Dinit, and this manual, were written by Davin McCall.
+$$$dnl