.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "zmu 8"
.TH zmu 8 2024-03-12 --stderr zoneminder
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
zmc \- The ZoneMinder Utility
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& zmu \-d device_path [\-v] [function] [\-U<username> \-P<password>]
\& zmu \-\-device device_path [\-v] [function] [\-U<username> \-P<password>]
\&
\& zmu \-m monitor_id [\-v] [function] [\-U<username> \-P<password>]
\& zmu \-\-monitor monitor_id [\-v] [function] [\-U<username> \-P<password>]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This binary is a handy command line interface to several useful functions. It's
not really meant to be used by anyone except the web page (there's only limited
\&'help' in it so far) but can be if necessary, especially for debugging video
problems.
.SH OPTIONS
.IX Header "OPTIONS"
General options:
  \-v, \-\-verbose                           \- Produce more verbose output
  \-l, \-\-list                              \- List the current status of active (or all with \-v) monitors
  \-h, \-\-help                               \- Display usage information
  \-v, \-\-version                            \- Print the installed version of ZoneMinder
.PP
Options for use with devices:
  \-d, \-\-device [device_path]              \- Get the current video device settings for [device_path] or all devices
  \-V, \-\-version <V4L version>             \- Set the Video 4 Linux API version to use for the query, use 1 or 2
  \-q, \-\-query                             \- Query the current settings for the device
.PP
Options for use with monitors:
  \-m, \-\-monitor <monitor_id>              \- Specify which monitor to address, default 1 if absent
  \-q, \-\-query                             \- Query the current settings for the monitor
  \-s, \-\-state                             \- Output the current monitor state, 0 = idle, 1 = prealarm, 2 = alarm,
                                            3 = alert, 4 = tape
  \-B, \-\-brightness [value]                \- Output the current brightness, set to value if given 
  \-C, \-\-contrast [value]                  \- Output the current contrast, set to value if given 
  \-H, \-\-hue [value]                       \- Output the current hue, set to value if given 
  \-O, \-\-colour [value]                    \- Output the current colour, set to value if given 
  \-i, \-\-image [image_index]               \- Write captured image to disk as <monitor_name>.jpg, last image captured
                                            or specified ring buffer index if given.
  \-S, \-\-scale <scale_%%ge>                \- With \-\-image specify any scaling (in %%) to be applied to the image
  \-t, \-\-timestamp [image_index]           \- Output captured image timestamp, last image captured or specified
                                            ring buffer index if given
  \-R, \-\-read_index                        \- Output ring buffer read index
  \-W, \-\-write_index                       \- Output ring buffer write index
  \-e, \-\-event                             \- Output last event index
  \-f, \-\-fps                               \- Output last Frames Per Second captured reading
  \-z, \-\-zones                             \- Write last captured image overlaid with zones to <monitor_name>\-Zones.jpg
  \-a, \-\-alarm                             \- Force alarm in monitor, this will trigger recording until cancelled with \-c
  \-n, \-\-noalarm                           \- Force no alarms in monitor, this will prevent alarms until cancelled with \-c
  \-c, \-\-cancel                            \- Cancel a forced alarm/noalarm in monitor, required after being enabled with \-a or \-n
  \-L, \-\-reload                            \- Signal monitor to reload settings
  \-E, \-\-enable                            \- Enable detection, wake monitor up
  \-D, \-\-disable                           \- Disable detection, put monitor to sleep
  \-u, \-\-suspend                           \- Suspend detection, useful to prevent bogus alarms when panning etc
  \-r, \-\-resume                            \- Resume detection after a suspend
  \-U, \-\-username <username>               \- When running in authenticated mode the username and
  \-P, \-\-password <password>               \- password combination of the given user
  \-A, \-\-auth <authentication>             \- Pass authentication hash string instead of user details
  \-x, \-\-xtrigger                          \- Output the current monitor trigger state, 0 = not triggered, 1 = triggered