path: root/reolink/reolink.8

.\" 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 spooltime Ta
Set spool retention time (in hours)
.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