diff --git a/src/zma.cpp b/src/zma.cpp index e45327cc1..fdf15303e 100644 --- a/src/zma.cpp +++ b/src/zma.cpp @@ -17,6 +17,38 @@ // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. // +/* + +=head1 NAME + +zma - The ZoneMinder Analysis daemon + +=head1 SYNOPSIS + + zma -m + zma --monitor + 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 #include diff --git a/src/zmc.cpp b/src/zmc.cpp index e159f0096..56417d044 100644 --- a/src/zmc.cpp +++ b/src/zmc.cpp @@ -17,6 +17,44 @@ // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. // +/* + +=head1 NAME + +zmc - The ZoneMinder Capture daemon + +=head1 SYNOPSIS + + zmc -d + zmc --device + zmc -r -H -P -p + zmc -f + zmc --file + zmc -m + zmc --monitor + 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 - For local cameras, device to access. e.g /dev/video0 etc + -r -H -P -p - For remote cameras + -f, --file - 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 #include #if defined(__FreeBSD__) diff --git a/src/zmf.cpp b/src/zmf.cpp index 94bd0bdb5..c7544bcf1 100644 --- a/src/zmf.cpp +++ b/src/zmf.cpp @@ -17,6 +17,39 @@ // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. // +/* + +=head1 NAME + +zmf - The ZoneMinder Frame daemon + +=head1 SYNOPSIS + + zmf -m + zmf --monitor + 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 #include #include diff --git a/src/zmstreamer.cpp b/src/zmstreamer.cpp index 7385accca..a16e50704 100644 --- a/src/zmstreamer.cpp +++ b/src/zmstreamer.cpp @@ -19,6 +19,52 @@ // along with this program; if not, write to the Free Software // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +/* + +=head1 NAME + +zmstreamer - eyeZM video streamer + +=head1 SYNOPSIS + + zmstreamer -e + zmstreamer -o + zmstreamer -u + zmstreamer -f + zmstreamer -s + zmstreamer -b + zmstreamer -m + zmstreamer -d + 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 - Specify output mode: mpeg/jpg/zip/single/raw. + -o - Specify output format. + -u - Specify buffer size in ms. + -f - Specify maximum framerate. + -s - Specify scale. + -b - Specify bitrate. + -m - Specify monitor id. + -d - 0 = off, 1 = no streaming, 2 = with streaming. + -i, -?, -h - Display usage information + -v - Print the installed version of ZoneMinder + +=cut + +*/ + #include #include diff --git a/src/zmu.cpp b/src/zmu.cpp index 9348012db..1cecb6d22 100644 --- a/src/zmu.cpp +++ b/src/zmu.cpp @@ -17,6 +17,75 @@ // 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 -P] + zmu --device device_path [-v] [function] [-U -P] + + zmu -m monitor_id [-v] [function] [-U -P] + zmu --monitor monitor_id [-v] [function] [-U -P] + +=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 - 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 - 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 .jpg, last image captured + or specified ring buffer index if given. + -S, --scale - 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 -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 - When running in authenticated mode the username and + -P, --password - password combination of the given user + -A, --auth - Pass authentication hash string instead of user details + +=cut + +*/ + #include #include "zm.h"