From 557bef09e961fbeb14c15514e893c76a52f257ce Mon Sep 17 00:00:00 2001
From: Davin McCall <davmac@davmac.org>
Date: Wed, 14 Jun 2017 18:07:03 +0100
Subject: [PATCH] Man page updates.

Man pages should be section 8, not section 1. Add "list" command info to
dinitctl manpage.
---
 doc/manpages/Makefile                   |  2 +-
 doc/manpages/{dinit.1 => dinit.8}       | 12 ++++++++----
 doc/manpages/{dinitctl.1 => dinitctl.8} | 22 ++++++++++++++++++++--
 3 files changed, 29 insertions(+), 7 deletions(-)
 rename doc/manpages/{dinit.1 => dinit.8} (99%)
 rename doc/manpages/{dinitctl.1 => dinitctl.8} (82%)

diff --git a/doc/manpages/Makefile b/doc/manpages/Makefile
index a1f4ef9..8235e4d 100644
--- a/doc/manpages/Makefile
+++ b/doc/manpages/Makefile
@@ -1,3 +1,3 @@
 install:
 	mkdir -p "$(DESTDIR)/usr/share/man/man1"
-	cp dinit.1 dinitctl.1 "$(DESTDIR)/usr/share/man/man1"
+	cp dinit.8 dinitctl.8 "$(DESTDIR)/usr/share/man/man1"
diff --git a/doc/manpages/dinit.1 b/doc/manpages/dinit.8
similarity index 99%
rename from doc/manpages/dinit.1
rename to doc/manpages/dinit.8
index 406a185..fff23ea 100644
--- a/doc/manpages/dinit.1
+++ b/doc/manpages/dinit.8
@@ -1,4 +1,4 @@
-.TH DINIT "1" "June 2017" "Dinit 0.06" "Dinit \- service management system"
+.TH DINIT "8" "June 2017" "Dinit 0.06" "Dinit \- service management system"
 .SH NAME
 dinit \- supervise processes and manage services
 .\"
@@ -263,7 +263,8 @@ expected to have set up the system to a level suitable for basic operation.
 
 .RS
 .nf
-.gcolor yellow
+.gcolor blue
+.ft CR
 # mysqld service
 type = process
 command = /usr/bin/mysqld --user=mysql
@@ -271,6 +272,7 @@ logfile = /var/log/mysqld.log
 smooth-recovery = true
 restart = false
 depends-on = rcboot # Basic system services must be ready
+.ft
 .gcolor
 .RE
 .fi
@@ -284,7 +286,8 @@ the process can be interrupted using control-C.
 
 .RS
 .nf
-.gcolor yellow
+.gcolor blue
+.ft CR
 # rootfscheck service
 type = scripted
 command = /etc/dinit.d/rootfscheck.sh
@@ -292,6 +295,7 @@ restart = false
 options = starts-on-console pass-cs-fd
 depends-on = early-filesystems  # /proc and /dev
 depends-on = device-node-daemon
+.ft
 .gcolor
 .fi
 .RE
@@ -309,7 +313,7 @@ immediately.
 .\"
 .SH SEE ALSO
 .\"
-\fBdinitctl\fR(1).
+\fBdinitctl\fR(8).
 .\"
 .SH AUTHOR
 Dinit, and this manual, were written by Davin McCall.
diff --git a/doc/manpages/dinitctl.1 b/doc/manpages/dinitctl.8
similarity index 82%
rename from doc/manpages/dinitctl.1
rename to doc/manpages/dinitctl.8
index 36e0c49..2ce2851 100644
--- a/doc/manpages/dinitctl.1
+++ b/doc/manpages/dinitctl.8
@@ -1,4 +1,4 @@
-.TH DINITCTL "1" "June 2017" "Dinit 0.06" "Dinit \- service management system"
+.TH DINITCTL "8" "June 2017" "Dinit 0.06" "Dinit \- service management system"
 .SH NAME
 dinitctl \- control services supervised by Dinit
 .\"
@@ -69,6 +69,24 @@ Remove start- and stop- pins from a service. If a started service is not explici
 has no active dependents, it will stop. If a started service has a dependency service which is stopping,
 it will stop. If a stopped service has a dependent service which is starting, it will start. Otherwise,
 any pending start/stop commands will be carried out.
+.TP
+\fBlist\fR
+List loaded services and their state. Before each service, one of the following state indicators is
+displayed:
+
+.RS
+.nf
+\f[CR]\m[blue][{+}     ]\m[]\fR service has started.
+\f[CR]\m[blue][{ }<<   ]\m[]\fR service is starting.
+\f[CR]\m[blue][   <<{ }]\m[]\fR service is starting, will stop once started.
+\f[CR]\m[blue][{ }>>   ]\m[]\fR service is stopping, will start once stopped.
+\f[CR]\m[blue][   >>{ }]\m[]\fR service is stopping.
+\f[CR]\m[blue][     {-}]\m[]\fR service has stopped.
+.fi
+
+The << and >> symbols represent a transition state (starting and stopping respectively); curly braces
+indicate the desired state (left: started, right: stopped).
+.RE
 .\"
 .SH SERVICE OPERATION
 .\"
@@ -86,7 +104,7 @@ automatically, or with a dependent service configured to do so, will restart imm
 unless pinned.
 .\"
 .SH SEE ALSO
-\fBdinit\fR(1).
+\fBdinit\fR(8).
 .\"
 .SH AUTHOR
 Dinit, and this manual, were written by Davin McCall.
-- 
2.25.1