Add pod documentation to C binaries
This commit is contained in:
Andrew Bauer
parent
13b9921680
commit
4deb0d53c8
32
src/zma.cpp
32
src/zma.cpp
|
|
@ -17,6 +17,38 @@
|
||||||
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||||
//
|
//
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
zma - The ZoneMinder Analysis daemon
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
zma -m <monitor_id>
|
||||||
|
zma --monitor <monitor_id>
|
||||||
|
zma -h
|
||||||
|
zma --help
|
||||||
|
zma -v
|
||||||
|
zma --version
|
||||||
|
|
||||||
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
This is the component that goes through the captured frames and checks them
|
||||||
|
for motion which might generate an alarm or event. It generally keeps up with
|
||||||
|
the Capture daemon but if very busy may skip some frames to prevent it falling
|
||||||
|
behind.
|
||||||
|
|
||||||
|
=head1 OPTIONS
|
||||||
|
|
||||||
|
-m, --monitor_id - ID of the monitor to analyse
|
||||||
|
-h, --help - Display usage information
|
||||||
|
-v, --version - Print the installed version of ZoneMinder
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include <getopt.h>
|
#include <getopt.h>
|
||||||
#include <signal.h>
|
#include <signal.h>
|
||||||
|
|
||||||
|
|
|
||||||
38
src/zmc.cpp
38
src/zmc.cpp
|
|
@ -17,6 +17,44 @@
|
||||||
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||||
//
|
//
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
zmc - The ZoneMinder Capture daemon
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
zmc -d <device_path>
|
||||||
|
zmc --device <device_path>
|
||||||
|
zmc -r <proto> -H <host> -P <port> -p <path>
|
||||||
|
zmc -f <file_path>
|
||||||
|
zmc --file <file_path>
|
||||||
|
zmc -m <monitor_id>
|
||||||
|
zmc --monitor <monitor_id>
|
||||||
|
zmc -h
|
||||||
|
zmc --help
|
||||||
|
zmc -v
|
||||||
|
zmc --version
|
||||||
|
|
||||||
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
This binary's job is to sit on a video device and suck frames off it as fast as
|
||||||
|
possible, this should run at more or less constant speed.
|
||||||
|
|
||||||
|
=head1 OPTIONS
|
||||||
|
|
||||||
|
-d, --device <device_path> - For local cameras, device to access. e.g /dev/video0 etc
|
||||||
|
-r <proto> -H <host> -P <port> -p <path> - For remote cameras
|
||||||
|
-f, --file <file_path> - For local images, jpg file to access.
|
||||||
|
-m, --monitor_id - ID of the monitor to analyse
|
||||||
|
-h, --help - Display usage information
|
||||||
|
-v, --version - Print the installed version of ZoneMinder
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include <getopt.h>
|
#include <getopt.h>
|
||||||
#include <signal.h>
|
#include <signal.h>
|
||||||
#if defined(__FreeBSD__)
|
#if defined(__FreeBSD__)
|
||||||
|
|
|
||||||
33
src/zmf.cpp
33
src/zmf.cpp
|
|
@ -17,6 +17,39 @@
|
||||||
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||||
//
|
//
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
zmf - The ZoneMinder Frame daemon
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
zmf -m <monitor_id>
|
||||||
|
zmf --monitor <monitor_id>
|
||||||
|
zmf -h
|
||||||
|
zmf --help
|
||||||
|
zmf -v
|
||||||
|
zmf --version
|
||||||
|
|
||||||
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
This is an optional daemon that can run in concert with the Analysis daemon and
|
||||||
|
whose function it is to actually write captured frames to disk. This frees up
|
||||||
|
the Analysis daemon to do more analysis (!) and so keep up with the Capture
|
||||||
|
daemon better. If it isn’t running or dies then the Analysis daemon just writes
|
||||||
|
them itself.
|
||||||
|
|
||||||
|
=head1 OPTIONS
|
||||||
|
|
||||||
|
-m, --monitor_id - ID of the monitor to use
|
||||||
|
-h, --help - Display usage information
|
||||||
|
-v, --version - Print the installed version of ZoneMinder
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
|
||||||
|
|
@ -19,6 +19,52 @@
|
||||||
// along with this program; if not, write to the Free Software
|
// along with this program; if not, write to the Free Software
|
||||||
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
zmstreamer - eyeZM video streamer
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
zmstreamer -e <mode>
|
||||||
|
zmstreamer -o <format>
|
||||||
|
zmstreamer -u <buffer size>
|
||||||
|
zmstreamer -f <maximum fps>
|
||||||
|
zmstreamer -s <scale>
|
||||||
|
zmstreamer -b <bitrate in bps>
|
||||||
|
zmstreamer -m <monitor id>
|
||||||
|
zmstreamer -d <debug mode>
|
||||||
|
zmstreamer -i
|
||||||
|
zmstreamer -?
|
||||||
|
zmstreamer -h
|
||||||
|
zmstreamer -v
|
||||||
|
|
||||||
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
*DEPRECIATED* The xml skin and all files associated with the xml skin are now
|
||||||
|
depreciated. Please use the ZoneMinder API instead.
|
||||||
|
|
||||||
|
This binary works in conjunction with the XML skin to stream video to iPhones
|
||||||
|
running the eyeZm app.
|
||||||
|
|
||||||
|
=head1 OPTIONS
|
||||||
|
|
||||||
|
-e <mode> - Specify output mode: mpeg/jpg/zip/single/raw.
|
||||||
|
-o <format> - Specify output format.
|
||||||
|
-u <buffer size> - Specify buffer size in ms.
|
||||||
|
-f <maximum fps> - Specify maximum framerate.
|
||||||
|
-s <scale> - Specify scale.
|
||||||
|
-b <bitrate in bps> - Specify bitrate.
|
||||||
|
-m <monitor id> - Specify monitor id.
|
||||||
|
-d <debug mode> - 0 = off, 1 = no streaming, 2 = with streaming.
|
||||||
|
-i, -?, -h - Display usage information
|
||||||
|
-v - Print the installed version of ZoneMinder
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
|
|
||||||
|
|
|
||||||
69
src/zmu.cpp
69
src/zmu.cpp
|
|
@ -17,6 +17,75 @@
|
||||||
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||||
//
|
//
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
zmc - The ZoneMinder Utility
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
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>]
|
||||||
|
|
||||||
|
=head1 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.
|
||||||
|
|
||||||
|
=head1 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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
#include <getopt.h>
|
#include <getopt.h>
|
||||||
|
|
||||||
#include "zm.h"
|
#include "zm.h"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue