From be51f4741bf46b1ec53065a7c84d0af750aad8fe Mon Sep 17 00:00:00 2001
From: Jon duSaint
Date: Sat, 16 Jul 2022 12:41:33 -0700
Subject: reolink: Add man pages and example configuration

---
 reolink/reolink.8 | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 reolink/reolink.8

(limited to 'reolink/reolink.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
-- 
cgit v1.2.3