reolink: Add man pages and example configuration

4 files changed, 139 insertions, 3 deletions

diff --git a/reolink/Makefile b/reolink/Makefile
index 33c88ed..2684f54 100644
--- a/reolink/Makefile
+++ b/reolink/Makefile
@@ -13,6 +13,10 @@ install:
 	else \
 		echo "perl site libdir $$libdir does not exist"; exit 1; \
 	fi
-	install -m 0555 reolink    /usr/sbin/reolink
-	install -m 0555 reolink.rc /etc/rc.d/reolink
-	@echo "Enable reolink service manually with rcctl(8)"
+	install -m 0555 reolink        /usr/sbin/reolink
+	install -m 0555 reolink.rc     /etc/rc.d/reolink
+	install -m 0644 reolink.conf   /etc/examples/reolink.conf
+	install -m 0444 reolink.8      /usr/share/man/man8/reolink.8
+	install -m 0444 reolink.conf.5 /usr/share/man/man8/reolink.conf.5
+	makewhatis /usr/share/man
+	@echo "-> Enable reolink service manually with rcctl(8)"
diff --git a/reolink/reolink.8 b/reolink/reolink.8
new file mode 100644
index 0000000..1494381
--- /dev/null
+++ b/reolink/reolink.8
@@ -0,0 +1,74 @@
+.\" Copyright (c) 2022 Jonathan duSaint <jon@rockgeeks.net>
+.Dd $Mdocdate: July 16 2022 $
+.Dt REOLINK 8
+.Os
+.Sh NAME
+.Nm reolink
+.Nd Reolink snapshot and timelapse daemon
+.Sh SYNOPSIS
+.Nm reolink
+.Op --server
+.Op --debug
+.Nm reolink
+.Fl -client
+.Op --debug
+.Ar command
+.Nm reolink
+.Fl -process
+.Op --debug
+.Op --range <start-end>
+.Sh DESCRIPTION
+.Nm
+is a daemon that takes snapshots from a Reolink IP camera and converts
+them to daily time-lapse videos.
+.Pp
+There are three modes of operation: server, client, and process.
+.Ss server
+Run via
+.Xr rc 8
+normally.  The
+.Sq --debug
+flag keeps the program running in the foreground.
+.Ss client
+Send a command to a running server. Use
+.Sq --debug
+to communicate with a server running with
+.Sq --debug .
+Commands are:
+.Bl -column "terminate"
+.It Sy Command Ta Sy Description
+.It exit Ta
+Stop the server
+.It die Ta
+Alias for exit
+.It quit Ta
+Alias for exit
+.It term Ta
+Alias for exit
+.It terminate Ta
+Alias for exit
+.It interval Ta
+Set snapshot interval
+.It pid Ta
+Send the pid of the server
+.It snapshot Ta
+Take a snapshot now
+.It status Ta
+Send status of the server
+.It ping Ta
+Alias for status
+.It video Ta
+Time range for daily time-lapse video
+.El
+.Ss process
+Invoked recursively from the server to convert a series of images into a time-lapse video.
+.Sh FILES
+.Bl -tag -width XXXXXXXXXXXXXXXXXXXX
+.It Pa /etc/reolink.conf
+System reolink configuration file
+.It Pa $HOME/reolink.conf
+Configuration file used with
+.Sq --debug .
+.El
+.Sh SEE ALSO
+.Xr reolink.conf 5
diff --git a/reolink/reolink.conf b/reolink/reolink.conf
new file mode 100644
index 0000000..285c9ab
--- /dev/null
+++ b/reolink/reolink.conf
@@ -0,0 +1,18 @@
+# Example configuration for the reolink time-lapse daemon
+#
+# See reolink.conf(5) and reolink(8) for more information.
+
+# How often to take a snapshot
+interval: 30
+
+# Where to store snapshots and videos
+spool_dir: /var/spool/reolink
+
+# chroot to this directory after startup
+# chroot: /
+
+# IP address of camera
+reolink_ip: 192.168.127.10
+
+# Start and end time of time-lapse video
+video: 0530-2130
diff --git a/reolink/reolink.conf.5 b/reolink/reolink.conf.5
new file mode 100644
index 0000000..cdc84e7
--- /dev/null
+++ b/reolink/reolink.conf.5
@@ -0,0 +1,40 @@
+.\" Copyright (c) 2022 Jonathan duSaint <jon@rockgeeks.net>
+.Dd $Mdocdate: July 15 2022 $
+.Dt REOLINK.CONF 5
+.Os
+.Sh NAME
+.Nm reolink.conf
+.Nd Reolink daemon configuration file
+.Sh DESCRIPTION
+.Nm
+is the configuration for the reolink daemon,
+.Xr reolink 8 .
+Leading whitespace on lines, blank lines, and lines starting with
+.Sq # ,
+are ignored.
+Directives are separated by
+.Sq \&: ,
+or
+.Sq = ,
+Unknown directives are ignored. Known directives are:
+.Bl -column "reolink_ip"
+.It Sy Name Ta Sy Description
+.It interval Ta
+How often to take a snapshot
+.It spool_dir Ta
+Where to store snapshots and videos
+.It chroot Ta
+.Xr chroot 2 .
+to this directory after startup
+.It reolink_ip Ta
+IP address of camera
+.It video Ta
+Start and end time of time-lapse video
+.El
+.Sh FILES
+.Bl -tag -width XXXXXXXXXXXXXXXXXX
+.It Pa /etc/reolink.conf
+System reolink configuration file
+.El
+.Sh SEE ALSO
+.Xr reolink 8