Reorganised config.

git-svn-id: http://svn.zoneminder.com/svn/zm/trunk@1812 e3e1d417-86f3-4887-817a-d78f3d33393f
pull/27/merge
stan 2006-01-14 20:56:17 +00:00
parent c9d3769c6c
commit 93eae6a309
1 changed files with 115 additions and 99 deletions

View File

@ -99,7 +99,7 @@ our @options =
default => "en_gb",
description => "Default language used by web interface",
help => "ZoneMinder allows the web interface to use languages other than English if the appropriate language file has been created and is present. This option allows you to change the default language that is used from the shipped language, British English, to another language",
type => $types{directory},
type => $types{string},
category => "system",
},
{
@ -186,6 +186,41 @@ our @options =
type => $types{tristate},
category => "tools",
},
{
name => "ZM_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => "ZoneMinder can be configured to use either mpeg encoded video or a series or still jpeg images when sending video streams. This option defines which is used. If you choose mpeg you should ensure that you have the appropriate plugins available on your browser whereas choosing jpeg will work natively on Mozilla and related browsers and with a Java applet on Internet Explorer",
type => { db_type=>"string", hint=>"mpeg|jpeg", pattern=>qr|^([mj])|i, format=>q( $1 =~ /^m/ ? "mpeg" : "jpeg" ) },
category => "tools",
},
{
name => "ZM_MPEG_TIMED_FRAMES",
default => "yes",
description => "Tag video frames with a timestamp for more realistic streaming",
help => "When using streamed MPEG based video, either for live monitor streams or events, ZoneMinder can send the streams in two ways. If this option is selected then the timestamp for each frame, taken from it's capture time, is included in the stream. This means that where the frame rate varies, for instance around an alarm, the stream will still maintain it's 'real' timing. If this option is not selected then an approximate frame rate is calculated and that is used to schedule frames instead. This option should be selected unless you encounter problems with your preferred streaming method.",
requires => [ { name=>"ZM_STREAM_METHOD", value=>"mpeg" } ],
type => $types{boolean},
category => "tools",
},
{
name => "ZM_MPEG_LIVE_FORMAT",
default => "asf",
description => "What format 'live' video streams are played in",
help => "When using MPEG mode ZoneMinder can output live video. However what formats are handled by the browser varies greatly between machines. This option allows you to specify a video format using a file extension format, so you would just enter the extension of the file type you would like and the rest is determined from that. The default of 'asf' works well under Windows with Windows Media Player but I'm currently not sure what, if anything, works on a Linux platform. If you find out please let me know! If this option is left blank then live streams will revert to being in motion jpeg format",
requires => [ { name=>"ZM_STREAM_METHOD", value=>"mpeg" } ],
type => $types{string},
category => "tools",
},
{
name => "ZM_MPEG_REPLAY_FORMAT",
default => "asf",
description => "What format 'replay' video streams are played in",
help => "When using MPEG mode ZoneMinder can replay events in encoded video format. However what formats are handled by the browser varies greatly between machines. This option allows you to specify a video format using a file extension format, so you would just enter the extension of the file type you would like and the rest is determined from that. The default of 'asf' works well under Windows with Windows Media Player and 'mpg', or 'avi' etc should work under Linux. If you knwo any more then please let me know! If this option is left blank then live streams will revert to being in motion jpeg format",
requires => [ { name=>"ZM_STREAM_METHOD", value=>"mpeg" } ],
type => $types{string},
category => "tools",
},
{
name => "ZM_RAND_STREAM",
default => "yes",
@ -243,38 +278,6 @@ our @options =
type => $types{boolean},
category => "config",
},
{
name => "ZM_COLOUR_JPEG_FILES",
default => "yes",
description => "Colourise greyscale JPEG files",
help => "Cameras that capture in greyscale can write their captured images to jpeg files with a corresponding greyscale colour space. This saves a small amount of disk space over colour ones. However some tools such as ffmpeg and mpeg_encode either fail to work with this colour space or have to convert it beforehand. Setting this option to yes uses up a little more space but makes creation of MPEG files much faster.",
type => $types{boolean},
category => "config",
},
{
name => "ZM_ADD_JPEG_COMMENTS",
default => "no",
description => "Add jpeg timestamp annotations as file header comments",
help => "JPEG files may have a number of extra fields added to the file header. The comment field may have any kind of text added. This options allows you to have the same text that is used to annotate the image additionally included as a file header comment. If you archive event images to other locations this may help you locate images for particular events or times if you use software that can read comment headers.",
type => $types{boolean},
category => "config",
},
{
name => "ZM_JPEG_FILE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the saved event files (1-100)",
help => "When ZoneMinder detects an event it will save the images associated with that event to files. These files are in the JPEG format and can be viewed or streamed later. This option specifies what image quality should be used to save these files. A higher number means better quality but less compression so will take up more disk space and take longer to view over a slow connection. By contrast a low number means smaller, quicker to view, files but at the price of lower quality images.",
type => $types{integer},
category => "config",
},
{
name => "ZM_JPEG_IMAGE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the streamed 'live' images (1-100)",
help => "When viewing a 'live' stream for a monitor ZoneMinder will grab an image from the buffer and encode it into JPEG format before sending it. This option specifies what image quality should be used to encode these images. A higher number means better quality but less compression so will take longer to view over a slow connection. By contrast a low number means quicker to view files but at the price of lower quality images. This option does not apply when viewing still images as these are just read from disk and so will be encoded at the quality specified by the previous option.",
type => $types{integer},
category => "config",
},
{
name => "ZM_OPT_ADAPTIVE_SKIP",
default => "yes",
@ -422,12 +425,20 @@ our @options =
category => "tools",
},
{
name => "ZM_OPT_TRIGGERS",
default => "no",
description => "Whether we want to interface external event triggers via socket or device files",
help => "ZoneMinder can interact with external systems which prompt or cancel alarms. This is done via the zmtrigger.pl script. This option indicates whether you want to use these external triggers. Most people will say no here.",
name => "ZM_RECORD_EVENT_STATS",
default => "yes",
description => "Record event statistical information, switch off if too slow",
help => "This version of ZoneMinder records detailed information about events in the Stats table. This can help in profiling what the optimum settings are for Zones though this is tricky at present. However in future releases this will be done more easily and intuitively, especially with a large sample of events. The default option of 'yes' allows this information to be collected now in readiness for this but if you are concerned about performance you can switch this off in which case no Stats information will be saved.",
type => $types{boolean},
category => "tools",
category => "debug",
},
{
name => "ZM_RECORD_DIAG_IMAGES",
default => "no",
description => "Record intermediate alarm diagnostic images, can be very slow",
help => "In addition to recording event statistics you can also record the intermediate diagnostic images that display the results of the various checks and processing that occur when trying to determine if an alarm event has taken place. There are several of these images generated for each frame and zone for each alarm or alert frame so this can have a massive impact on performance. Only switch this setting on for debug or analysis purposes and remember to switch it off again once no longer required.",
type => $types{boolean},
category => "debug",
},
{
name => "ZM_EXTRA_DEBUG",
@ -435,7 +446,7 @@ our @options =
description => "Whether to switch additional debugging on",
help => "ZoneMinder binary components usually have several levels of debug information they can output. Normally this is set to a fairly low level to avoid filling logs too quickly. This options lets you switch on other options that allow you to configure additional debug information to be output. Components will pick up this instruction when they are restarted.",
type => $types{boolean},
category => "tools",
category => "debug",
},
{
name => "ZM_EXTRA_DEBUG_TARGET",
@ -444,7 +455,7 @@ our @options =
help => "There are three scopes of debug available. Leaving this option blank means that all components will use extra debug (not recommended). Setting this option to '_<component>', e.g. _zmc, will limit extra debug to that component only. Setting this option to '_<component>_<identity>', e.g. '_zmc_m1' will limit extra debug to that instance of the component only. This is ordinarily what you probably want to do.",
requires => [ { name => "ZM_EXTRA_DEBUG", value => "yes" } ],
type => $types{string},
category => "tools",
category => "debug",
},
{
name => "ZM_EXTRA_DEBUG_LEVEL",
@ -453,7 +464,7 @@ our @options =
help => "There are 9 levels of debug available, with higher numbers being more debug and level 0 being no debug. However not all levels are used by all components. Also if there is debug at a high level it is usually likely to be output at such a volume that it may obstruct normal operation. For this reason you should set the level carefully and cautiously until the degree of debug you wish to see is present.",
requires => [ { name => "ZM_EXTRA_DEBUG", value => "yes" } ],
type => { db_type=>"integer", hint=>"0|1|2|3|4|5|6|7|8|9", pattern=>qr|^(\d+)$|, format=>q( $1 ) },
category => "tools",
category => "debug",
},
{
name => "ZM_EXTRA_DEBUG_LOG",
@ -462,7 +473,7 @@ our @options =
help => "Depending on your system configuration you may find that only errors, warning and informational messages are logged to your system log. This option allows you to specify an additional target for these messages and debug. This also has the advantage of partitioning debug for the component you are tracing, from messages from other components. Be warned however that if this is a simple filename and you are debugging several components then they will all try and write to the same file with undesirable consequences. Appending a '+' to the filename will cause the file to be created with a '.<pid>' suffix containing your process id. In this way debug from each run of a component is kept separate. This is the recommended setting as it will also prevent subsequent runs from overwriting the same log.",
requires => [ { name => "ZM_EXTRA_DEBUG", value => "yes" } ],
type => $types{string},
category => "tools",
category => "debug",
},
{
name => "ZM_PATH_SOCKS",
@ -481,39 +492,36 @@ our @options =
category => "paths",
},
{
name => "ZM_VIDEO_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => "ZoneMinder can be configured to use either mpeg encoded video or a series or still jpeg images when sending video streams. This option defines which is used. If you choose mpeg you should ensure that you have the appropriate plugins available on your browser whereas choosing jpeg will work natively on Mozilla and related browsers and with a Java applet on Internet Explorer",
type => { db_type=>"string", hint=>"mpeg|jpeg", pattern=>qr|^([mj])|i, format=>q( $1 =~ /^m/ ? "mpeg" : "jpeg" ) },
category => "video",
},
{
name => "ZM_VIDEO_TIMED_FRAMES",
name => "ZM_COLOUR_JPEG_FILES",
default => "yes",
description => "Tag video frames with a timestamp for more realistic streaming",
help => "When using streamed MPEG based video, either for live monitor streams or events, ZoneMinder can send the streams in two ways. If this option is selected then the timestamp for each frame, taken from it's capture time, is included in the stream. This means that where the frame rate varies, for instance around an alarm, the stream will still maintain it's 'real' timing. If this option is not selected then an approximate frame rate is calculated and that is used to schedule frames instead. This option should be selected unless you encounter problems with your preferred streaming method.",
requires => [ { name=>"ZM_VIDEO_STREAM_METHOD", value=>"mpeg" } ],
description => "Colourise greyscale JPEG files",
help => "Cameras that capture in greyscale can write their captured images to jpeg files with a corresponding greyscale colour space. This saves a small amount of disk space over colour ones. However some tools such as ffmpeg and mpeg_encode either fail to work with this colour space or have to convert it beforehand. Setting this option to yes uses up a little more space but makes creation of MPEG files much faster.",
type => $types{boolean},
category => "video",
category => "images",
},
{
name => "ZM_VIDEO_LIVE_FORMAT",
default => "asf",
description => "What format 'live' video streams are played in",
help => "When using MPEG mode ZoneMinder can output live video. However what formats are handled by the browser varies greatly between machines. This option allows you to specify a video format using a file extension format, so you would just enter the extension of the file type you would like and the rest is determined from that. The default of 'asf' works well under Windows with Windows Media Player but I'm currently not sure what, if anything, works on a Linux platform. If you find out please let me know! If this option is left blank then live streams will revert to being in motion jpeg format",
requires => [ { name=>"ZM_VIDEO_STREAM_METHOD", value=>"mpeg" } ],
type => $types{string},
category => "video",
name => "ZM_ADD_JPEG_COMMENTS",
default => "no",
description => "Add jpeg timestamp annotations as file header comments",
help => "JPEG files may have a number of extra fields added to the file header. The comment field may have any kind of text added. This options allows you to have the same text that is used to annotate the image additionally included as a file header comment. If you archive event images to other locations this may help you locate images for particular events or times if you use software that can read comment headers.",
type => $types{boolean},
category => "images",
},
{
name => "ZM_VIDEO_REPLAY_FORMAT",
default => "asf",
description => "What format 'replay' video streams are played in",
help => "When using MPEG mode ZoneMinder can replay events in encoded video format. However what formats are handled by the browser varies greatly between machines. This option allows you to specify a video format using a file extension format, so you would just enter the extension of the file type you would like and the rest is determined from that. The default of 'asf' works well under Windows with Windows Media Player and 'mpg', or 'avi' etc should work under Linux. If you knwo any more then please let me know! If this option is left blank then live streams will revert to being in motion jpeg format",
requires => [ { name=>"ZM_VIDEO_STREAM_METHOD", value=>"mpeg" } ],
type => $types{string},
category => "video",
name => "ZM_JPEG_FILE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the saved event files (1-100)",
help => "When ZoneMinder detects an event it will save the images associated with that event to files. These files are in the JPEG format and can be viewed or streamed later. This option specifies what image quality should be used to save these files. A higher number means better quality but less compression so will take up more disk space and take longer to view over a slow connection. By contrast a low number means smaller, quicker to view, files but at the price of lower quality images.",
type => $types{integer},
category => "images",
},
{
name => "ZM_JPEG_IMAGE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the streamed 'live' images (1-100)",
help => "When viewing a 'live' stream for a monitor ZoneMinder will grab an image from the buffer and encode it into JPEG format before sending it. This option specifies what image quality should be used to encode these images. A higher number means better quality but less compression so will take longer to view over a slow connection. By contrast a low number means quicker to view files but at the price of lower quality images. This option does not apply when viewing still images as these are just read from disk and so will be encoded at the quality specified by the previous option.",
type => $types{integer},
category => "images",
},
{
name => "ZM_WEB_TITLE_PREFIX",
@ -639,6 +647,22 @@ our @options =
type => $types{boolean},
category => "config",
},
{
name => "ZM_SIGNAL_CHECK_POINTS",
default => "10",
description => "How many points in a captured image to check for signal loss",
help => "For locally attached video cameras ZoneMinder can check for signal loss by looking at a number of random points on each captured image. If all of these points are set to the same fixed colour then the camera is assumed to have lost signal. When this happens any open events are closed and a short one frame signal loss event is generated, as is another when the signal returns. This option defines how many points on each image to check. Note that this is a maximum, any points found to not have the check colour will abort any further checks so in most cases on a couple of points will actually be checked. Network and file based cameras are never checked.",
type => $types{integer},
category => "config",
},
{
name => "ZM_SIGNAL_CHECK_COLOUR",
default => "0100BE",
description => "The colour to check when detecting signal loss",
help => "For locally attached video cameras ZoneMinder can check for signal loss by looking at a number of random points on each captured image. If all of these points are set to the same fixed colour then the camera is assumed to have lost signal. This option defines what that colour is, in hexadecimal RGB (red/green/blue) terms. The default, which is a shade of blue, is most common but other systems may differ.",
type => $types{hexadecimal},
category => "config",
},
{
name => "ZM_CAPTURES_PER_FRAME",
default => "1",
@ -936,18 +960,10 @@ body = "ZM alarm detected - %ED% secs, %EF%/%EFA% frames, t%EST%/m%ESM%/a%ESA% s
category => "config",
},
{
name => "ZM_RECORD_EVENT_STATS",
default => "yes",
description => "Whether to record event statistical information, switch off if too slow",
help => "This version of ZoneMinder records detailed information about events in the Stats table. This can help in profiling what the optimum settings are for Zones though this is tricky at present. However in future releases this will be done more easily and intuitively, especially with a large sample of events. The default option of 'yes' allows this information to be collected now in readiness for this but if you are concerned about performance you can switch this off in which case no Stats information will be saved.",
type => $types{boolean},
category => "config",
},
{
name => "ZM_RECORD_DIAG_IMAGES",
name => "ZM_FORCE_CLOSE_EVENTS",
default => "no",
description => "Whether to record intermediate alarm diagnostic images, can be very slow",
help => "In addition to recording event statistics you can also record the intermediate diagnostic images that display the results of the various checks and processing that occur when trying to determine if an alarm event has taken place. There are several of these images generated for each frame and zone for each alarm or alert frame so this can have a massive impact on performance. Only switch this setting on for debug or analysis purposes and remember to switch it off again once no longer required.",
description => "Whether events are closed at section ends.",
help => "When a monitor is running in a continuous recording moe (Record or Mocord) events are usually closed after a fixed period of time (the section length). However in Mocord mode it is possible that motion detection may occur near the end of a section and ordinarily this will prevent the event being closed until the motion has ceased. Switching this option on will force the event closed at the specified time regardless of any motion activity.",
type => $types{boolean},
category => "config",
},
@ -1002,26 +1018,10 @@ body = "ZM alarm detected - %ED% secs, %EF%/%EFA% frames, t%EST%/m%ESM%/a%ESA% s
category => "system",
},
{
name => "ZM_EVENT_SORT_FIELD",
default => "DateTime",
description => "Default field the event lists are sorted by",
help => "Events in lists can be initially ordered in any way you want. This option controls what field is used to sort them. You can modify this ordering from filters or by clicking on headings in the lists themselves. Bear in mind however that the 'Prev' and 'Next' links, when scrolling through events, relate to the ordering in the lists and so not always to time based ordering.",
type => { db_type=>"string", hint=>"Id|Name|Cause|MonitorName|DateTime|Length|Frames|AlarmFrames|TotScore|AvgScore|MaxScore", pattern=>qr|.|, format=>q( $1 ) },
category => "system",
},
{
name => "ZM_EVENT_SORT_ORDER",
default => "asc",
description => "Default order the event lists are sorted by",
help => "Events in lists can be initially ordered in any way you want. This option controls what order (ascending or descending) is used to sort them. You can modify this ordering from filters or by clicking on headings in the lists themselves. Bear in mind however that the 'Prev' and 'Next' links, when scrolling through events, relate to the ordering in the lists and so not always to time based ordering.",
type => { db_type=>"string", hint=>"asc|desc", pattern=>qr|^([ad])|i, format=>q( $1 =~ /^a/i ? "asc" : "desc" ) },
category => "system",
},
{
name => "ZM_FORCE_CLOSE_EVENTS",
name => "ZM_OPT_TRIGGERS",
default => "no",
description => "Whether events are closed at section ends.",
help => "When a monitor is running in a continuous recording moe (Record or Mocord) events are usually closed after a fixed period of time (the section length). However in Mocord mode it is possible that motion detection may occur near the end of a section and ordinarily this will prevent the event being closed until the motion has ceased. Switching this option on will force the event closed at the specified time regardless of any motion activity.",
description => "Whether we want to interface external event triggers via socket or device files",
help => "ZoneMinder can interact with external systems which prompt or cancel alarms. This is done via the zmtrigger.pl script. This option indicates whether you want to use these external triggers. Most people will say no here.",
type => $types{boolean},
category => "system",
},
@ -1058,6 +1058,22 @@ body = "ZM alarm detected - %ED% secs, %EF%/%EFA% frames, t%EST%/m%ESM%/a%ESA% s
type => $types{boolean},
category => "web",
},
{
name => "ZM_WEB_EVENT_SORT_FIELD",
default => "DateTime",
description => "Default field the event lists are sorted by",
help => "Events in lists can be initially ordered in any way you want. This option controls what field is used to sort them. You can modify this ordering from filters or by clicking on headings in the lists themselves. Bear in mind however that the 'Prev' and 'Next' links, when scrolling through events, relate to the ordering in the lists and so not always to time based ordering.",
type => { db_type=>"string", hint=>"Id|Name|Cause|MonitorName|DateTime|Length|Frames|AlarmFrames|TotScore|AvgScore|MaxScore", pattern=>qr|.|, format=>q( $1 ) },
category => "web",
},
{
name => "ZM_WEB_EVENT_SORT_ORDER",
default => "asc",
description => "Default order the event lists are sorted by",
help => "Events in lists can be initially ordered in any way you want. This option controls what order (ascending or descending) is used to sort them. You can modify this ordering from filters or by clicking on headings in the lists themselves. Bear in mind however that the 'Prev' and 'Next' links, when scrolling through events, relate to the ordering in the lists and so not always to time based ordering.",
type => { db_type=>"string", hint=>"asc|desc", pattern=>qr|^([ad])|i, format=>q( $1 =~ /^a/i ? "asc" : "desc" ) },
category => "web",
},
{
name => "ZM_WEB_EVENTS_PER_PAGE",
default => "25",