|
weathermap |
Subversion Repositories: |
Compare with Previous - Blame - Download
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" type="text/css" media="screen" href="weathermap.css"><title>PHP Weathermapv0.97aConfiguration Reference</title></head><body><div id="frame"><div class="navcontainer"><ul id="navlist"><li><a href="main.html">Main Page</a></li><li><a href="main.html#installation">Installation</a></li><li><a href="main.html#basics">Basics</a></li><li><a href="faq.html">FAQ and Tips</a></li><li><a href="main.html#example">Sample Map</a></li><li><a href="cli-reference.html">CLI Reference</a></li><li><a href="config-reference.html">Config Reference</a></li><li><a href="advanced.html">Advanced Topics</a></li><li><a href="editor.html">Editor</a></li><li><a href="cacti-plugin.html">Cacti Plugin</a></li><li><a href="http://www.network-weathermap.com/">Site</a></li></ul></div><div id="header"><h1>PHP Weathermapv0.97a</h1><h4>Copyright © 2005-2010 Howard Jones, <tt><ahref="mailto:howie@thingy.com">howie@thingy.com</a></tt>. (<ahref="http://www.network-weathermap.com/">Website</a>)</h4></div><h2><a name="configref">Configuration Reference</a></h2><p>This page is automatically compiled, and documents all the configuration directives that are available in PHP Weathermapv0.97a. </p><h1 class="configsection">Introduction</h1><div class="preamble"><div id="contents"><h4 class="configsection">Node-specific Configuration Directives</h4><p id="context_NODE"><a href="#NODE_NODE">NODE</a><a href="#NODE_TEMPLATE">TEMPLATE</a><a href="#NODE_POSITION">POSITION</a><a href="#NODE_LABEL">LABEL</a><a href="#NODE_TARGET">TARGET</a><a href="#NODE_USESCALE">USESCALE</a><a href="#NODE_MAXVALUE">MAXVALUE</a><a href="#NODE_ICON">ICON</a><a href="#NODE_USEICONSCALE">USEICONSCALE</a><a href="#NODE_LABELOFFSET">LABELOFFSET</a><a href="#NODE_LABELANGLE">LABELANGLE</a><a href="#NODE_LABELFONT">LABELFONT</a><a href="#NODE_COLORS">*COLOR</a><a href="#NODE_INFOURL">INFOURL</a><a href="#NODE_OVERLIBGRAPH">OVERLIBGRAPH</a><a href="#NODE_OVERLIBWIDTH">OVERLIBWIDTH</a><a href="#NODE_OVERLIBHEIGHT">OVERLIBHEIGHT</a><a href="#NODE_OVERLIBCAPTION">OVERLIBCAPTION</a><a href="#NODE_NOTES">NOTES</a><a href="#NODE_SET">SET</a><a href="#NODE_ZORDER">ZORDER</a></p><h4 class="configsection">Link-specific Configuration Directives</h4><p id="context_LINK"><a href="#LINK_LINK">LINK</a><a href="#LINK_TEMPLATE">TEMPLATE</a><a href="#LINK_NODES">NODES</a><a href="#LINK_TARGET">TARGET</a><a href="#LINK_USESCALE">USESCALE</a><a href="#LINK_WIDTH">WIDTH</a><a href="#LINK_BANDWIDTH">BANDWIDTH</a><a href="#LINK_DUPLEX">DUPLEX</a><a href="#LINK_BWLABEL">BWLABEL</a><a href="#LINK_INBWFORMAT">INBWFORMAT</a><a href="#LINK_OUTBWFORMAT">OUTBWFORMAT</a><a href="#LINK_BWSTYLE">BWSTYLE</a><a href="#LINK_BWLABELPOS">BWLABELPOS</a><a href="#LINK_BWFONT">BWFONT</a><a href="#LINK_INCOMMENT">INCOMMENT</a><a href="#LINK_OUTCOMMENT">OUTCOMMENT</a><a href="#LINK_COMMENTFONT">COMMENTFONT</a><a href="#LINK_COMMENTPOS">COMMENTPOS</a><a href="#LINK_COMMENTSTYLE">COMMENTSTYLE</a><a href="#LINK_SPLITPOS">SPLITPOS</a><a href="#LINK_COLORS">*COLOR</a><a href="#LINK_INFOURL">INFOURL</a><a href="#LINK_ININFOURL">ININFOURL</a><a href="#LINK_OUTINFOURL">OUTINFOURL</a><a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a><a href="#LINK_INOVERLIBGRAPH">INOVERLIBGRAPH</a><a href="#LINK_OUTOVERLIBGRAPH">OUTOVERLIBGRAPH</a><a href="#LINK_OVERLIBWIDTH">OVERLIBWIDTH</a><a href="#LINK_OVERLIBHEIGHT">OVERLIBHEIGHT</a><a href="#LINK_OVERLIBCAPTION">OVERLIBCAPTION</a><a href="#LINK_INOVERLIBCAPTION">INOVERLIBCAPTION</a><a href="#LINK_OUTOVERLIBCAPTION">OUTOVERLIBCAPTION</a><a href="#LINK_NOTES">NOTES</a><a href="#LINK_INNOTES">INNOTES</a><a href="#LINK_OUTNOTES">OUTNOTES</a><a href="#LINK_VIA">VIA</a><a href="#LINK_VIASTYLE">VIASTYLE</a><a href="#LINK_LINKSTYLE">LINKSTYLE</a><a href="#LINK_ARROWSTYLE">ARROWSTYLE</a><a href="#LINK_SET">SET</a><a href="#LINK_ZORDER">ZORDER</a></p><h4 class="configsection">Global Configuration Directives</h4><p id="context_GLOBAL"><a href="#GLOBAL_BACKGROUND">BACKGROUND</a><a href="#GLOBAL_WIDTH">WIDTH</a><a href="#GLOBAL_HEIGHT">HEIGHT</a><a href="#GLOBAL_HTMLOUTPUTFILE">HTMLOUTPUTFILE</a><a href="#GLOBAL_HTMLSTYLESHEET">HTMLSTYLESHEET</a><a href="#GLOBAL_IMAGEOUTPUTFILE">IMAGEOUTPUTFILE</a><a href="#GLOBAL_IMAGEURI">IMAGEURI</a><a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a><a href="#GLOBAL_FONT">*FONT</a><a href="#GLOBAL_COLORS">*COLOR</a><a href="#GLOBAL_TIMEPOS">TIMEPOS</a><a href="#GLOBAL_MINTIMEPOS">MINTIMEPOS</a><a href="#GLOBAL_MAXTIMEPOS">MAXTIMEPOS</a><a href="#GLOBAL_TITLE">TITLE</a><a href="#GLOBAL_TITLEPOS">TITLEPOS</a><a href="#GLOBAL_KILO">KILO</a><a href="#GLOBAL_HTMLSTYLE">HTMLSTYLE</a><a href="#GLOBAL_SCALE">SCALE</a><a href="#GLOBAL_KEYPOS">KEYPOS</a><a href="#GLOBAL_KEYSTYLE">KEYSTYLE</a><a href="#GLOBAL_SET">SET</a><a href="#GLOBAL_INCLUDE">INCLUDE</a></p></div></div><h1 id="s_scope_NODE" class="configsection">Node-specific Configuration Directives</h1><div class="referenceentry"><h2><a name="NODE_NODE">NODE</a></h2><div class="definition">NODE <em class="meta">nodename</em></div><div class="description"><p>The initial definition of a <a href="#NODE_NODE">NODE.</a> This must come before any other configuration related to this node. </p><p>The 'nodename' is used in link definitions to specify which nodes the link joins. The nodename is must be a singleword, with no spaces. </p><p>There is one special node name, 'DEFAULT', which allows for the setting of defaults.All nodes that are defined after this one in the configuration file will use the parametersof this node as a starting point. For this reason, it is best to define the DEFAULT node at thetop of the configuration file, if you intend to use it. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Added DEFAULT node.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_TEMPLATE">TEMPLATE</a></h2><div class="definition">TEMPLATE<em class="meta">nodename</em></div><div class="description"><p>By default, each new node starts with the same set of properties. Youcan change the default properties by defining a node called DEFAULT. </p><p>You can also use the <a href="#NODE_TEMPLATE">TEMPLATE</a> keyword to make a node inherit it's settingsfrom <em>any</em> other node. The node you use must be defined earlier in theconfig file than where you use it. </p><p>You can make template-only nodes that are not visible in the map, by notincluding a <a href="#LINK_NODES">NODES</a> line in the node. Template nodes can also use templates, tobuild up a hierarchy of 'types'. </p><p><strong>NOTE:</strong> The <a href="#NODE_TEMPLATE">TEMPLATE</a> line should be the first line in the <a href="#NODE_NODE">NODE</a>definition, as it will copy the configuration over the top of anything else youhave already defined for that <a href="#NODE_NODE">NODE.</a> </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>NODE Templates in use - with template-only nodes</h5><pre>NODE server</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added template support</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_POSITION">POSITION</a></h2><div class="definition">POSITION <em class="meta">x-coord</em> <em class="meta">y-coord</em></div><div class="definition">POSITION <em class="meta">nodename</em> <em class="meta">x-coord</em> <em class="meta">y-coord</em></div><div class="description"><p>Specifies where to place the node on the map. Coordinates are in pixel units, with the origin at the top-left of the map. </p><p>Optionally, you can also specify another node that the coordinates are relative to. This allows you to have 'sub-nodes' that follow a master node around as you alter the map. Relative nodes can be relative to other relative nodes, as long as the node at the end of the chain is not relatively positioned! </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Example of a 'sub-node', that will be 20 pixels above the main node, wherever that gets moved to. It is used to show additional information about the main node.</h5><pre>NODE main_nodePOSITION 200 320LABEL MAINNODE sub_nodePOSITION main_node 0 -20LABEL {nodes:main_node:invalue}</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Add relative position from other nodes.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_LABEL">LABEL</a></h2><div class="definition">LABEL <em class="meta">labeltext</em></div><div class="description"><p>Specifies a label for the node. Everything to the end of the line is used. </p><p>If the node has an <a href="#NODE_ICON">ICON</a> defined as well, then you can specify the position of the label relative to the node's centre-point by using <a href="#NODE_LABELOFFSET">LABELOFFSET.</a> </p><p>The text for the label can contain <a href="advanced.html#tokens">special tokens</a> to show map data. </p><p>This is drawn using the font specified by <a href="#NODE_LABELFONT">LABELFONT</a> in the colours specified by <a href="#NODE_COLORS">LABELFONTCOLOR,</a> <a href="#NODE_COLORS">LABELFONTSHADOWCOLOR,</a> <a href="#NODE_COLORS">LABELBGCOLOR</a> and <a href="#NODE_COLORS">LABELOUTLINECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added 'special token' support.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_TARGET">TARGET</a></h2><div class="definition">TARGET <em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> <em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> -<em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> n*<em class="meta">targetspec</em></div><div class="definition">TARGET "<em class="meta">targetspec</em>"</div><div class="description"><p>Specifies where to look for the current "throughput"information for this <a href="#NODE_NODE">NODE.</a> You can also specify multiple targets, which will then be added together to make the aggregate resultwhich is then displayed. Specify the targets on one <a href="#NODE_TARGET">TARGET</a> line, seperated with a space. If a targetspec starts with a '-', then it's value will be <i>subtracted</i> from the final result instead. </p><p>Also, if a targetspec starts with a number, then a *, then it's used a scaling factor on the result. You can do basic maths with this, especially if you remember that multiplyingby a number below 1 is the same as dividing by 1 divided by that number (0.5* is the same as divide by 2). </p><p>For both the '-' and '*' options, <em>there must be no spaces</em> between any modifiers and the actual target string after it. </p><p>It's important to note, especially for <a href="#NODE_NODE">NODEs,</a> that the value that is used does not have to be bandwidth. You can use data for temperature, session-counts, CPU usage or anything else you can get data for. </p><p>The actual contents of the <em>targetspec</em> depend on the data source plugins that areavailable. <a href="targets.html">The standard plugins are documented here</a>. </p><p>To help with filenames that can contain spaces, or for the external script data source, you can enclose the entiretargetspec in double-quotes (") to show that it is a single targetspec. <em>The quotes must be around the whole targetspec, including any prefixes.</em> </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Using multiple data sources for one link</h5><pre>TARGET link1a.rrd link1b.rrd</pre></div><div class="example"><h5>Taking the input from one file, and output from another</h5><pre>TARGET poot.rrd:-:DS1 poot2.rrd:DS0:-</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added quotes option for targets with spaces.</dd><dt>0.96</dt><dd>Added scale factors for all datasources.</dd><dt>0.91</dt><dd>Added 'negative' datasources.</dd><dt>0.9</dt><dd>Added plugin data sources, node targets, and added new plugins.</dd><dt>0.8</dt><dd>Added ability to specify multiple targets. Added tab-delimited data source. Added 'ignore' DS name.</dd><dt>0.5</dt><dd>Added ability to specify DS names.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_USESCALE">USESCALE</a></h2><div class="definition">USESCALE <em class="meta">scalename</em></div><div class="definition">USESCALE <em class="meta">scalename</em> <em class="meta">{in,out}</em></div><div class="description"><p>Specify which <a href="#GLOBAL_SCALE">SCALE</a> to use to decide the colour of this node. </p><p>After the percentage usage is calculated (using BANDWIDTH/MAXVALUE and data from the <a href="#NODE_TARGET">TARGET</a> line),the colour is decided by looking up the percentage against this <a href="#GLOBAL_SCALE">SCALE.</a> If there is no <a href="#NODE_USESCALE">USESCALE</a>line, then the default scale is used. </p><p>If you also specify 'absolute', then no percentage calculation is performed. The raw valuesfrom the <a href="#NODE_TARGET">TARGET</a> line are just looked up in the named <a href="#GLOBAL_SCALE">SCALE.</a> </p><p>For nodes, you can also specify a scalename of 'none'. This stops the node's colour from changing at all. This is useful if you want touse the <a href="#NODE_TARGET">TARGET</a> line to fetch data that is used in the <a href="#NODE_LABEL">LABEL</a> or <a href="#NODE_ICON">ICON</a> of the node, for example, without changing the colour of the node itself. </p><p>You can also change the colour of the <a href="#NODE_ICON">ICON</a> associated with a <a href="#NODE_NODE">NODE</a> according to a different <a href="#GLOBAL_SCALE">SCALE,</a> by using <a href="#NODE_USEICONSCALE">USEICONSCALE.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.97</dt><dd>Added absolute scale support.</dd><dt>0.95</dt><dd>Added USEICONSCALE.</dd><dt>0.9</dt><dd>Added named scales and USESCALE.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_MAXVALUE">MAXVALUE</a></h2><div class="definition">MAXVALUE <em class="meta">max-value</em></div><div class="definition">MAXVALUE <em class="meta">max-in-value</em> <em class="meta">max-out-value</em></div><div class="description"><p>Specifies the maximum value(s) for the node, in the same way that <a href="#LINK_BANDWIDTH">BANDWIDTH</a> does for a <a href="#LINK_LINK">LINK.</a> These are used to calculate the percentage usage value, which in turn is used to decide the <a href="#NODE_NODE">NODE's</a> colour, if it has a <a href="#NODE_TARGET">TARGET</a> defined. </p><p>The default value is 100, which has the effect of not changing the input value ( (n/100)*100 = n ). </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added TARGET and MAXVALUE for nodes.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_ICON">ICON</a></h2><div class="definition">ICON <em class="meta">iconimagefile</em></div><div class="definition">ICON <em class="meta">maxwidth</em> <em class="meta">maxheight</em> <em class="meta">iconimagefile</em></div><div class="definition">ICON none</div><div class="description"><p>Specifies an icon to use for the node. </p><p>The filename can either be a full path to the image, or a relative one. </p><p>The icon file must be in PNG, JPEG or GIF format. Alpha-transparency within the icon should be honoured by Weathermap for PNG icons, to create irregular shapes. </p><p>If you specify the word 'none' as the icon filename, then no icon is used. This is useful if you have specified an <a href="#NODE_ICON">ICON</a> in the DEFAULT <a href="#NODE_NODE">NODE,</a> and want to override that for a few special cases. </p><p>There are some special icon filenames that can be used to generate an icon image without using an external file.These all <em>require</em> you to specify a <em>maxwidth</em> and <em>maxheight</em> which are then used as the size of theicon. The 'magic filenames' are: <ul><li>'box' - to produce a square cornered box.</li><li>'rbox' -to produce a round-cornered box</li><li>'round' - to produce a circle or ellipse.</li><li>'inpie' & 'outpie' - to produce a pie-chart of either the in or out value relative to it's maximum. The colouring options on this are likely to change in a future version.</li><li>'nink' - to produce a circular 'yin-yang'-style symbol, with each half showing the in and out values. The colouring options on this are likely to change in a future version.</li></ul>The colours for these "artificial icons" are specifiedusing the <a href="#NODE_COLORS">AICONFILLCOLOR</a> and <a href="#NODE_COLORS">AICONOUTLINECOLOR</a> keywords. </p><p>The second form allows you to specify a maximum width and height for the icon. If the PNG file that you specify is bigger or smaller than this size, then it is automatically scaled up (or down) in proportion, so that it fits into a box of the size you specify. </p><p>The size of the icon image is used by <a href="#NODE_LABELOFFSET">LABELOFFSET</a> to decided how far to move the label, if you use compass-point offsets. </p><p>The text for the filename can contain <a href="advanced.html#tokens">special tokens</a> to select an icon based on map data. </p><p>You can adjust the colour of the icon according to a <a href="#GLOBAL_SCALE">SCALE,</a> by using <a href="#NODE_USEICONSCALE">USEICONSCALE,</a> if you are using the PHP GD library (the function required is not present in the main GD library). </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added inpie, outpie and nink.</dd><dt>0.95</dt><dd>Added Artificial Icon support - round, rbox and box.</dd><dt>0.95</dt><dd>Added Icon colourising support.</dd><dt>0.9</dt><dd>Added 'special token' support.</dd><dt>0.9</dt><dd>Added JPEG and GIF support.</dd><dt>0.9</dt><dd>Added special icon 'none', and automatic scaling.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_USEICONSCALE">USEICONSCALE</a></h2><div class="definition">USEICONSCALE <em class="meta">scalename</em></div><div class="definition">USEICONSCALE <em class="meta">scalename</em> <em class="meta">{in,out}</em></div><div class="description"><p>Specify which <a href="#GLOBAL_SCALE">SCALE</a> to use to decide the colour of the icon for this node. </p><p>After the percentage usage is calculated (using BANDWIDTH/MAXVALUE and data from the <a href="#NODE_TARGET">TARGET</a> line),the colour is decided by looking up the percentage against this <a href="#GLOBAL_SCALE">SCALE.</a> If there is no <a href="#NODE_USEICONSCALE">USEICONSCALE</a>line, then no scale is used, and the icon colour does not change. </p><p>Hint: This facility works best when you start with greyscale images. </p><p><strong>NOTE:</strong> Prior to 0.97, Icon colourising used the PHP <tt>imagefilter()</tt> function. This functionis <em>only</em> available in the version of GD that is bundled with PHP, and not with the official GD library. Severalpopular operating systems (e.g. Debian/Ubuntu) use the official GD library rather than the bundled PHP library. Ifyou know that you <em>do</em> have the imagefilter function, and you prefer the 'old-style' coloring, then you can add<tt><a href="#NODE_SET">SET</a> use_imagefilter 1</tt> in the top section of your map config file, to use <tt>imagefilter</tt> instead. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.97</dt><dd>Removed dependency on imagefilter</dd><dt>0.95</dt><dd>Added USEICONSCALE.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_LABELOFFSET">LABELOFFSET</a></h2><div class="definition">LABELOFFSET <em class="meta">compass-point</em></div><div class="definition">LABELOFFSET <em class="meta">x-offset</em> <em class="meta">y-offset</em></div><div class="description"><p>If you specify an <a href="#NODE_ICON">ICON,</a> and also a <a href="#NODE_LABEL">LABEL,</a> then you will find that the label is often hard to read.<a href="#NODE_LABELOFFSET">LABELOFFSET</a> allows you to move the position of the <a href="#NODE_LABEL">LABEL,</a> so that it's not directly over the centreof the node anymore. </p><p>You can specify a compass-point (e.g. <a href="#NODE_LABELOFFSET">LABELOFFSET</a> S). The compass-point method takes the size of the<a href="#NODE_ICON">ICON,</a> and uses that as the offset distance in the direction you specify. This way, you can change youricon for something of a different size, and not need to change all your offsets. You can use the main8 points of the compass: N, E, S, W, NE, SE, NW, SW. </p><p><img src="../images/compass-points.png"></img><br></br>The compass points, relative to the node's bounding-box.. </p><p>For more control, you can specify an integer offset for the x and y positions of the label (e.g. <a href="#NODE_LABELOFFSET">LABELOFFSET</a> -10 -20) instead. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Originally added LABELOFFSET</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_LABELANGLE">LABELANGLE</a></h2><div class="definition">LABELANGLE <em class="meta">angle</em></div><div class="description"><p>Specifies a rotation angle of the label for a node. Allowed angles are 0, 90, 180 and 270 degrees. The rotation is around the centre of the label, after any <a href="#NODE_LABELOFFSET">LABELOFFSET</a> has been applied. </p><p>The <a href="#NODE_LABELFONT">LABELFONT</a> <em>must be a TrueType font</em> for angles other than 0 (the default) as these are the only font type to support rotating text. </p><p><img src="../images/labelangle+labeloffset.png"></img><br></br>Rotated label, using <tt><a href="#NODE_LABELANGLE">LABELANGLE</a> 90</tt> and <tt><a href="#NODE_LABELOFFSET">LABELOFFSET</a> E</tt> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added LABELANGLE.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_LABELFONT">LABELFONT</a></h2><div class="definition">LABELFONT <em class="meta">fontnumber</em></div><div class="description"><p>Specify the font used for drawing the <a href="#NODE_LABEL">LABEL.</a> </p><p>Fonts are specified by number. The GD library that Weathermap uses has 5 built-in fonts, 1-5. You can define new fonts based on TrueType or GD fonts by using the <a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a> directive. </p><p><img src="../images/font-sizes.png"></img>The built-in GD fonts. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Global NODEFONT became per-node LABELFONT.</dd><dt>0.6</dt><dd>Originally added NODEFONT.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_COLORS">*COLOR</a></h2><div class="definition">LABELFONTCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">LABELFONTSHADOWCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">LABELBGCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">LABELOUTLINECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">AICONOUTLINECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">AICONFILLCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="description"><p>Specify the colours used for drawing the <a href="#NODE_LABEL">LABEL.</a> </p><p>red, green and blue are numbers from 0 to 255. </p><p><a href="#NODE_COLORS">LABELFONTSHADOWCOLOR,</a> <a href="#NODE_COLORS">LABELBGCOLOR</a> and <a href="#NODE_COLORS">LABELOUTLINECOLOR</a> have an additional option - 'none' - which stops that element of the <a href="#NODE_LABEL">LABEL</a> being drawn. <a href="#NODE_COLORS">LABELFONTSHADOWCOLOR</a> defaults to 'none'. </p><p><a href="#NODE_COLORS">LABELFONTCOLOR</a> has an additional option 'contrast', which will select either black or white depending on the current <a href="#NODE_COLORS">LABELBGCOLOR.</a> This is especially useful if you are using a <a href="#GLOBAL_SCALE">SCALE</a> to change the colour of your <a href="#NODE_NODE">NODE</a> <a href="#NODE_LABEL">LABELs.</a> </p><p><a href="#NODE_COLORS">AICONOUTLINECOLOR</a> and <a href="#NODE_COLORS">AICONFILLCOLOR</a> are used to colour an 'artificial <a href="#NODE_ICON">ICON'</a> if one is defined for this node. To allow the artifical icon to <em>also</em> follow thecolour of the <a href="#NODE_COLORS">LABELBGCOLOR</a> when you are using a <a href="#GLOBAL_SCALE">SCALE,</a> you can also specify 'copy' as the colour for <a href="#NODE_COLORS">AICONFILLCOLOR.</a> See <a href="#NODE_ICON">ICON</a> for more about artificial icons. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added 'contrast' and 'copy' options.</dd><dt>0.95</dt><dd>Added AICONFILLCOLOR and AICONOUTLINECOLOR.</dd><dt>0.8</dt><dd>Added LABELFONTCOLOR, LABELFONTSHADOWCOLOR, LABELBGCOLOR and LABELOUTLINECOLOR.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_INFOURL">INFOURL</a></h2><div class="definition">INFOURL <em class="meta">url</em></div><div class="description"><p>Creates a hyperlink in the HTML output. </p><p>If you are using the HTML output facility, then a link is added to the<map> section of the HTML so that when you click on the node, you aretaken to the url specified here. </p></div></div><div class="referenceentry"><h2><a name="NODE_OVERLIBGRAPH">OVERLIBGRAPH</a></h2><div class="definition">OVERLIBGRAPH <em class="meta">url</em></div><div class="definition">OVERLIBGRAPH <em class="meta">url</em> <em class="meta">url</em>...</div><div class="description"><p>Creates a popup image in the HTML output. </p><p>If you are using the HTML output facility, and <a href="#GLOBAL_HTMLSTYLE">HTMLSTYLE</a> is set to 'overlib', then a link is added to the<map> section of the HTML so that when you move the mouse pointer over the the node, a box will pop upcontaining the image that you specify. Typically used to link to historical data in your network monitoring system. </p><p>You can also specify more than one url, in which case the images are 'stacked' one after another in the popup box. </p><p>If a <a href="#NODE_NOTES">NOTES</a> line is also specified for a node, then the image(s) specified here appears with the <a href="#NODE_NOTES">NOTES</a> text underneath it. </p><p>You can influence how Weathermap positions the popup box, using the <a href="#NODE_OVERLIBWIDTH">OVERLIBWIDTH</a> and <a href="#NODE_OVERLIBHEIGHT">OVERLIBHEIGHT</a> keywords. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Typical use of OVERLIBGRAPH</h5><pre>OVERLIBGRAPH http://www.yoursite.net/mrtg/router1-cpu-daily.png</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_OVERLIBWIDTH">OVERLIBWIDTH</a></h2><div class="definition">OVERLIBWIDTH <em class="meta">imagewidth</em></div><div class="description"><p>Specify the width, in pixels of the graph image referred to by <a href="#NODE_OVERLIBGRAPH">OVERLIBGRAPH</a> line. </p><p>This is an optional extra that allows the OverLib library to make a better job ofpositioning the 'popup' image so that it doesn't appear off the edge of the screen.Typically, you would use this once, in the DEFAULT <a href="#NODE_NODE">NODE.</a> If you use this, you mustalso use <a href="#NODE_OVERLIBHEIGHT">OVERLIBHEIGHT,</a> for either to have any effect. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Originally added OVERLIBWIDTH and OVERLIBHEIGHT based on code by Niels Baggesen.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_OVERLIBHEIGHT">OVERLIBHEIGHT</a></h2><div class="definition">OVERLIBHEIGHT <em class="meta">imagewidth</em></div><div class="description"><p>Specify the width, in pixels of the graph image referred to by <a href="#NODE_OVERLIBGRAPH">OVERLIBGRAPH</a> line. </p><p>This is an optional extra that allows the OverLib library to make a better job ofpositioning the 'popup' image so that it doesn't appear off the edge of the screen.Typically, you would use this once, in the DEFAULT <a href="#NODE_NODE">NODE.</a> If you use this, you mustalso use <a href="#NODE_OVERLIBWIDTH">OVERLIBWIDTH,</a> for either to have any effect. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Originally added OVERLIBWIDTH and OVERLIBHEIGHT based on code by Niels Baggesen.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_OVERLIBCAPTION">OVERLIBCAPTION</a></h2><div class="definition">OVERLIBCAPTION <em class="meta">caption text</em></div><div class="description"><p>Specify the caption used for the popup HTML 'window' if you have also specified an <a href="#NODE_OVERLIBGRAPH">OVERLIBGRAPH</a> line. By default, this is the name of the <a href="#NODE_NODE">NODE.</a> </p><p>The text for the caption can contain <a href="advanced.html#tokens">special tokens</a> to show map data. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added OVERLIBCAPTION.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_NOTES">NOTES</a></h2><div class="definition">NOTES <em class="meta">notes text</em></div><div class="description"><p>Specifies the text or HTML notes for a node. </p><p>The <em>notes text</em> appears in a popup box when the user hovers their mouse over the node. If an <a href="#NODE_OVERLIBGRAPH">OVERLIBGRAPH</a> is specified too, then the text appears below the graph. </p><p>The map <a href="#GLOBAL_HTMLSTYLE">HTMLSTYLE</a> must be set to 'overlib' to enable any of the mouse-hover functionality. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added NOTES.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_SET">SET</a></h2><div class="definition">SET <em class="meta">hintname</em> <em class="meta">hintvalue</em></div><div class="description"><p>Specifies a value for a <em>hint variable</em>. </p><p>Hint Variables allow the user to pass settings to the internals of Weathermap thatwouldn't normally need to be changed, or that aren't part of the core Weathermap application.Examples are: small rendering changes, parameters for datasources plugins and similar. </p><p>Hint Variables are either Global for the map, or assigned to a specific link or node. </p><p>There is more about Hint Variables in the <a href="advanced.html">Advanced Topics</a> section. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added SET.</dd></dl></div></div><div class="referenceentry"><h2><a name="NODE_ZORDER">ZORDER</a></h2><div class="definition">ZORDER <em class="meta">z-coord</em> </div><div class="description"><p>Specifies the order in which to draw this item on the map. </p><p>By default, all nodes are drawn above all links.There are some situations where you might like to change this, for exampleif you use a <a href="#NODE_NODE">NODE</a> as a background image, and you want links to show in frontof that image. </p><p>By default, all nodes have a Z coordinate of 600, and all links have 300. The map legendis at 1000, which cannot be changed (you can move everything else above it, if you like, of course).Items are drawn from lowest Z up to highest Z, so if you want a particular node to appear underneath thedefault links, you can use <a href="#NODE_ZORDER">'ZORDER</a> 250' to do that.</p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added Z-ordering support.</dd></dl></div></div><h1 id="s_scope_LINK" class="configsection">Link-specific Configuration Directives</h1><div class="referenceentry"><h2><a name="LINK_LINK">LINK</a></h2><div class="definition">LINK <em class="meta">linkname</em></div><div class="description"><p>The first line of a <a href="#LINK_LINK">LINK</a> definition. </p><p>The linkname mustbe unique within the map, and must not contain spaces. The only place it currently appears isin the small title-bar of a popup graph if you specify an<a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> without an <a href="#LINK_OVERLIBCAPTION">OVERLIBCAPTION,</a> however. </p><p>There is one special link name, 'DEFAULT', which allows for the setting of defaults.All links that are defined after this one in the configuration file will use the parametersof this link as a starting point. For this reason, it is best to define the DEFAULT link at thetop of the configuration file, if you intend to use it. </p></div></div><div class="referenceentry"><h2><a name="LINK_TEMPLATE">TEMPLATE</a></h2><div class="definition">TEMPLATE<em class="meta">linkname</em></div><div class="description"><p>By default, each new link starts with the same set of properties. Youcan change the default properties by defining a link called DEFAULT. </p><p>You can also use the <a href="#LINK_TEMPLATE">TEMPLATE</a> keyword to make a link inherit it's settingsfrom <em>any</em> other link. The link you use must be defined earlier in theconfig file than where you use it. </p><p>You can make template-only links that are not visible in the map, by notincluding a <a href="#LINK_NODES">NODES</a> line in the link. Template links can also use templates, tobuild up a hierarchy of 'types'. </p><p><strong>NOTE:</strong> The <a href="#LINK_TEMPLATE">TEMPLATE</a> line should be the first line in the <a href="#LINK_LINK">LINK</a>definition, as it will copy the configuration over the top of anything else youhave already defined for that <a href="#LINK_LINK">LINK.</a> </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>LINK Templates in use - with template-only links</h5><pre>LINK bigpipeWIDTH 8ARROWSTYLE classicLINK smallpipeWIDTH 3ARROWSTYLE compact# this link uses the bigpipe template, so it doesn't need any formatting/styling commandsLINK a_real_linkTEMPLATE bigpipeNODES rtr1 rtr2</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added template support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_NODES">NODES</a></h2><div class="definition">NODES <em class="meta">nodename{:compassoffset}</em> <em class="meta">nodename{:compassoffset}</em></div><div class="definition">NODES <em class="meta">nodename{:compassoffset}{percentage}</em> <em class="meta">nodename{:compassoffset}{percentage}</em></div><div class="definition">NODES <em class="meta">nodename{:xoffset:yoffset}</em> <em class="meta">nodename{:xoffset:yoffset}</em></div><div class="definition">NODES <em class="meta">nodename{:angle}r{radius}</em> <em class="meta">nodename{:angle}r{radius}</em></div><div class="description"><p>These are the <a href="#NODE_NODE">NODEs</a> that this link joins. There can beonly two. They are the 'nodename's from the <a href="#NODE_NODE">NODE</a> line foreach node. </p><p>Optionally, you can add an offset after a nodename, to move the location of that end of the link. This can help with crowded areas of the map, and also in making parallel links. Valid offsets can be numeric values, to indicate the relative position in pixels from the centre of the node, or are named after compass-points: N,S,E,W,NE,NE,SE,SW. The compass pointsdescribe locations around the edge of the box that contains the node. You can also specify a percentage after the compass point, to be a certain proportion of the way from the centre. The percentage must be two digits.Finally, you can also use polar coordinates to specify offsets, with an angle in degrees and a radius in pixels from the centre point. 0 degrees is straight up.</p><p>The order of the nodes is significant. When reading data sources, the flow from the first node to the second is considered 'out' and from second-to-first is 'in'. </p><p><img src="../images/compass-points.png"></img><br></br>The compass points, relative to the node's bounding-box.. </p><p><img src="../images/linkoffset-defaults.png"></img><br></br>The default - node centre to node centre. </p><p><img src="../images/linkoffset-eastwest.png"></img><br></br>Using compass points - <tt><a href="#LINK_NODES">NODES</a> node1:E node2:W</tt> </p><p><img src="../images/linkoffset-east50west50.png"></img><br></br>Using compass points with percentages - <tt><a href="#LINK_NODES">NODES</a> node1:E50 node2:W50</tt> </p><p><img src="../images/linkoffset-radial.png"></img><br></br>Using polar offsets - <tt><a href="#LINK_NODES">NODES</a> node1:45r20 node2:225r20</tt> </p><p><img src="../images/linkoffset-parallel.png"></img><br></br>Using offsets to make parallel links- <tt><a href="#LINK_NODES">NODES</a> node1:NE50node2:NW50</tt> for one link and <tt><a href="#LINK_NODES">NODES</a> node1:SE50 node2:SW50</tt> for the other. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Defining a simple link</h5><pre>LINK mylinkNODES node1 node2</pre></div><div class="example"><h5>Two parallel links, using offsets</h5><pre>LINK firstlinkNODES node1:E node2:ELINK secondlinkNODES node1:W node2:W</pre></div><div class="example"><h5>Two parallel links, using percentage compass offsets to bring the links closer together</h5><pre>LINK firstlinkNODES node1:E50 node2:E50LINK secondlinkNODES node1:W50 node2:W50</pre></div><div class="example"><h5>An offset link using pixel offsets</h5><pre>LINK firstlinkNODES node1:-10:10 node2:20:12</pre></div><div class="example"><h5>An offset link using polar coordinates</h5><pre>LINK firstlinkNODES node1:45r20 node2:225r20</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added polar offsets.</dd><dt>0.96</dt><dd>Added fractional compass offsets.</dd><dt>0.9</dt><dd>Added numeric pixel offsets.</dd><dt>0.8</dt><dd>Added ability to specify node offset.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_TARGET">TARGET</a></h2><div class="definition">TARGET <em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> <em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> -<em class="meta">targetspec</em></div><div class="definition">TARGET <em class="meta">targetspec</em> n*<em class="meta">targetspec</em></div><div class="definition">TARGET "<em class="meta">targetspec</em>"</div><div class="description"><p>Specifies where to look for the current throughputinformation for this <a href="#LINK_LINK">LINK.</a> You can also specify multiple targets, which will then be added together to make the aggregate bandwidthwhich is then displayed. Specify the targets on one <a href="#LINK_TARGET">TARGET</a> line, seperated with a space. If a targetspec starts with a '-', then it's value will be <i>subtracted</i> from the final result instead. </p><p>Also, if a targetspec starts with a number, then a *, then it's used a scaling factor on the result. You can do basic maths with this, especially if you remember that multiplyingby a number below 1 is the same as dividing by 1 divided by that number (0.5* is the same as divide by 2). </p><p>For both the '-' and '*' options, <em>there must be no spaces</em> between any modifiers and the actual target string after it. </p><p>The actual contents of the <em>targetspec</em> depend on the data source plugins that areavailable. <a href="targets.html">The standard plugins are documented here</a>. </p><p>To help with filenames that can contain spaces, or for the external script data source, you can enclose the entiretargetspec in double-quotes (") to show that it is a single targetspec. <em>The quotes must be around the whole targetspec, including any prefixes.</em> </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Using multiple data sources for one link</h5><pre>TARGET link1a.rrd link1b.rrd</pre></div><div class="example"><h5>Taking the input from one file, and output from another</h5><pre>TARGET poot.rrd:-:DS1 poot2.rrd:DS0:-</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added quotes option for targets with spaces.</dd><dt>0.96</dt><dd>Added scale factors for all datasources.</dd><dt>0.91</dt><dd>Added 'negative' datasources.</dd><dt>0.9</dt><dd>Added plugin data sources, node targets, and added new plugins.</dd><dt>0.8</dt><dd>Added ability to specify multiple targets. Added tab-delimited data source. Added 'ignore' DS name.</dd><dt>0.5</dt><dd>Added ability to specify DS names.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_USESCALE">USESCALE</a></h2><div class="definition">USESCALE <em class="meta">scalename</em></div><div class="definition">USESCALE <em class="meta">scalename</em> percent</div><div class="definition">USESCALE <em class="meta">scalename</em> absolute</div><div class="description"><p>Specify which <a href="#GLOBAL_SCALE">SCALE</a> to use to decide the colour of this link. </p><p>After the percentage usage is calculated (using <a href="#LINK_BANDWIDTH">BANDWIDTH</a> and data from the <a href="#LINK_TARGET">TARGET</a> line),the colour is decided by looking up the percentage against this <a href="#GLOBAL_SCALE">SCALE.</a> If there is no <a href="#LINK_USESCALE">USESCALE</a>line, then the default scale is used. </p><p>If you also specify 'absolute', then no percentage calculation is performed. The raw valuesfrom the <a href="#LINK_TARGET">TARGET</a> line are just looked up in the named <a href="#GLOBAL_SCALE">SCALE.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.97</dt><dd>Added absolute scale support.</dd><dt>0.9</dt><dd>Added named scales and USESCALE.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_WIDTH">WIDTH</a></h2><div class="definition">WIDTH <em class="meta">width</em></div><div class="description"><p>Specifies the width of this link when drawn. The <em>width</em> value can be any positive number (including non-integers). </p><p>The actual width of the final link arrow will be <em>roughly</em> 2*width+1 pixels, due to the way links are drawn, and rounding errors asthe internal floating-point values are finally forced onto an integer pixel-grid. </p><p> What it actually does is calculate a centre-line (or spine), divide that up into so many segments, and then at each point along the spine, find the normal (90 degrees to the direction of the line). Then step <a href="#LINK_WIDTH">WIDTH</a> pixels along the normal in each direction to get a point to draw. This apparently-complex scheme is required to allow for <a href="#LINK_VIA">VIAs</a> - both angled and curved links have special handling, and regular straight links are treated as curved links with no <a href="#LINK_VIA">VIA</a> by default. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.97a</dt><dd>Added non-integer widths. Retconned explanation.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_BANDWIDTH">BANDWIDTH</a></h2><div class="definition">BANDWIDTH <em class="meta">max-bandwidth</em></div><div class="definition">BANDWIDTH <em class="meta">max-in-bandwidth</em> <em class="meta">max-out-bandwidth</em></div><div class="description"><p>Specifies the maximum throughput of this link, in bits per second. </p><p>This is used to calculate the percentage utilisation, which in turn is used to make thecolour for the link arrow, and optionally the label on the link. </p><p>The second form allows you to have 'asymmetric' links, like an ADSL, where the first number is the maximumbandwidth from node1 to node2 and the second is the maximum from node2 to node1, as they aregiven in the <a href="#LINK_NODES">NODES</a> line. </p><p>Bandwidths can also use K,M,G and T suffixes to specify large values. Also see the <a href="#GLOBAL_KILO">KILO</a> global option though. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>A typical ADSL line (as seen from the CPE)</h5><pre>BANDWIDTH 2M 256K</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added MAXVALUE as a synonym to match NODE MAXVALUE. No change in functionality.</dd><dt>0.5</dt><dd>Added support for decimals in BANDWIDTH specifications.</dd><dt>0.4</dt><dd>Added support for K,M,G,T suffixes on bandwidth specs. Changed bandwidth from bytes to bits.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_DUPLEX">DUPLEX</a></h2><div class="definition">DUPLEX <em class="meta">full</em></div><div class="definition">DUPLEX <em class="meta">half</em></div><div class="description"><p>'half' indicates that the bandwidth specified by the <a href="#LINK_BANDWIDTH">BANDWIDTH</a> keyword is half-duplex rather than the default full. </p><p>This means that the percentages calculated are calculated as (in+out)/max instead of (in/max) and (out/max) separately. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added DUPLEX.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_BWLABEL">BWLABEL</a></h2><div class="definition">BWLABEL <em class="meta">formatname</em></div><div class="description"><p>Specifies the type of 'bandwidth' label shown on each link. </p><p>The default is 'percent', but you can also have 'none', 'unformatted' or 'bits'.'bits' shows the actual bandwidth, formatted using K,M,T,G suffixes where appropriate.'unformatted' takes the value from the <a href="#LINK_TARGET">TARGET</a> and displays it without any formatting -this can be useful for mapping things other than bandwidth.'none' hides the bandwidth label altogether.</p></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>Added unformatted format.</dd><dt>0.7</dt><dd>Changed from global BWLABELS to per-link BWLABEL.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_INBWFORMAT">INBWFORMAT</a></h2><div class="definition">INBWFORMAT <em class="meta">string</em></div><div class="description"><p>Specifies a custom string to use for the inbound data <a href="#LINK_BWLABEL">BWLABEL</a> bandwidth labels. </p><p>This command is intended as an advanced alternative to the <a href="#LINK_BWLABEL">BWLABEL</a> command, for situations whereyou want more control over the content of the labels. </p><p>Instead of using bits, percent, etc, you can use any string in the label. Most importantly,the text for the label can contain <a href="advanced.html#tokens">special tokens</a> to show map data.In most normal situations you <em>need</em> to use the tokens, or the label won't do much useful </p><p>There is also a matching <a href="#LINK_OUTBWFORMAT">OUTBWFORMAT</a> command to do the ame job for the outbound bandwidth label. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Providing more information in the bwlabel</h5><pre>INBWFORMAT {link:this:inpercent}% of {link:this:max_bandwidth_in:%k}b/sec</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.94</dt><dd>Added INBWFORMAT.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTBWFORMAT">OUTBWFORMAT</a></h2><div class="definition">OUTBWFORMAT <em class="meta">string</em></div><div class="description"><p>Specifies a custom string to use for the outbound data <a href="#LINK_BWLABEL">BWLABEL</a> bandwidth labels. </p><p>See the <a href="#LINK_INBWFORMAT">INBWFORMAT</a> entry for more information. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.94</dt><dd>Added OUTBWFORMAT.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_BWSTYLE">BWSTYLE</a></h2><div class="definition">BWSTYLE <em class="meta">formatname</em></div><div class="description"><p>Specifies the style used to draw the box around the 'bandwidth' label shown on each link. </p><p>Two styles are currently available: 'classic' leaves the box horizontal, regardlessof the direction of the link. 'angled' rotates the box to follow the directiong of the link arrow. </p><p>The <a href="#LINK_BWFONT">BWFONT</a> <em>must be a TrueType font</em> as these are the only font type to support rotating text. </p><p>To change the contents of the label, use <a href="#LINK_BWLABEL">BWLABEL</a> or INBWFORMAT/OUTBWFORMAT. </p><p><img src="../images/bwstyle-classic.png"></img> Classic label style </p><p><img src="../images/bwstyle-angled.png"></img> Angled label style </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.92</dt><dd>Added BWSTYLE.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_BWLABELPOS">BWLABELPOS</a></h2><div class="definition">BWLABELPOS <em class="meta">inposition</em> <em class="meta">outposition</em></div><div class="description"><p>Specifies the position of the 'bandwidth' labels shown on each link. </p><p>The two position values are percentages along the link arrow, from the first to the second node. Therefore <tt><a href="#LINK_BWLABELPOS">BWLABELPOS</a> 75 25</tt> is the default. </p><p>Weathermap will produce a warning if the outpostion is greater than the inposition. In most cases, you have probably made a mistake, but if you havea good reason to do this, then you can disable that warning using <a href="#LINK_SET">'SET</a> nowarn_bwlabelpos 1' in the top section of you map config file. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added warning for proably-wrong positions</dd><dt>0.9</dt><dd>Added BWLABELPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_BWFONT">BWFONT</a></h2><div class="definition">BWFONT <em class="meta">fontnumber</em></div><div class="description"><p>Specify the font used for drawing the <a href="#LINK_BWLABEL">BWLABEL</a> boxes. </p><p>Fonts are specified by number. The GD library that Weathermap uses has 5 built-in fonts, 1-5. You can define new fonts based on TrueType or GD fonts by using the <a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a> directive. </p><p><img src="../images/font-sizes.png"></img>The built-in GD fonts. </p></div></div><div class="referenceentry"><h2><a name="LINK_INCOMMENT">INCOMMENT</a></h2><div class="definition">INCOMMENT <em class="meta">string</em></div><div class="description"><p>Specifies a comment for the input side of a <a href="#LINK_LINK">LINK.</a> </p><p>The link comment appears as text running alongside the link arrow. The font used is governed by <a href="#LINK_COMMENTFONT">COMMENTFONT</a> and the colour by <a href="#LINK_COLORS">COMMENTFONTCOLOR.</a> </p><p>The text for the comment can contain <a href="advanced.html#tokens">special tokens</a> to show map data. </p><p>The <a href="#LINK_COMMENTFONT">COMMENTFONT</a> <em>must be a TrueType font</em> as these are the only font type to support rotating text. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added link comments</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTCOMMENT">OUTCOMMENT</a></h2><div class="definition">OUTCOMMENT <em class="meta">string</em></div><div class="description"><p>Specifies a comment for the output side of a <a href="#LINK_LINK">LINK.</a> </p><p>The link comment appears as text running alongside the link arrow. The font used is governed by <a href="#LINK_COMMENTFONT">COMMENTFONT</a> and the colour by <a href="#LINK_COLORS">COMMENTFONTCOLOR.</a> </p><p>The text for the comment can contain <a href="advanced.html#tokens">special tokens</a> to show map data. </p><p>The <a href="#LINK_COMMENTFONT">COMMENTFONT</a> <em>must be a TrueType font</em> as these are the only font type to support rotating text. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added link comments</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_COMMENTFONT">COMMENTFONT</a></h2><div class="definition">COMMENTFONT <em class="meta">fontnumber</em></div><div class="description"><p>Specify the font used for drawing the <a href="#LINK_INCOMMENT">INCOMMENT</a> and <a href="#LINK_OUTCOMMENT">OUTCOMMENT</a> text. </p><p>Fonts are specified by number. The GD library that Weathermap uses has 5 built-in fonts, 1-5. You can define new fonts based on TrueType or GD fonts by using the <a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a> directive. </p><p>For Link Comments, you <em>must</em> define a TrueType font. These are the only font that can rotate text through any angle, as required by comments. You can change the colour used to render the font with <a href="#LINK_COLORS">COMMENTFONTCOLOR</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added link comments</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_COMMENTPOS">COMMENTPOS</a></h2><div class="definition">COMMENTPOS <em class="meta">inposition</em> <em class="meta">outposition</em></div><div class="description"><p>Specify the position along the link used for drawing the <a href="#LINK_INCOMMENT">INCOMMENT</a> and <a href="#LINK_OUTCOMMENT">OUTCOMMENT</a> text. </p><p>The positions are specified as a percentage position along the link, like <a href="#LINK_BWLABELPOS">BWLABELPOS.</a> The default positions are equivalent to <strong><a href="#LINK_COMMENTPOS">COMMENTPOS</a> 95 5</strong>. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.92</dt><dd>Added COMMENTPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_COMMENTSTYLE">COMMENTSTYLE</a></h2><div class="definition">COMMENTSTYLE edge</div><div class="definition">COMMENTSTYLE center</div><div class="description"><p>Specify whether link comments run along the outside edge of the link, or down the centre of the link arrow. </p><p><img src="../images/commentstyle-edge.png"></img> 'edge' comment style </p><p><img src="../images/commentstyle-center.png"></img> 'center' comment style </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added COMMENTSTYLE</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_SPLITPOS">SPLITPOS</a></h2><div class="definition">SPLITPOS <em class="meta">position</em></div><div class="description"><p>Specify the position of the 'split' between the in and out arrows in a link. <em>position</em> is a percentage, and defaults to 50. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added SPLITPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_COLORS">*COLOR</a></h2><div class="definition">OUTLINECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">BWOUTLINECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">BWFONTCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">BWBOXCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">COMMENTFONTCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="description"><p>Specify the colours used for drawing the link. </p><p>red, green and blue are numbers from 0 to 255. </p><p><a href="#LINK_COLORS">OUTLINECOLOR,</a> <a href="#LINK_COLORS">BWOUTLINECOLOR</a> and <a href="#LINK_COLORS">BWBOXCOLOR</a> have an additional option - 'none' - which stops that element of the link being drawn. </p><p><a href="#LINK_COLORS">COMMENTFONTCOLOR</a> also has an extra option - 'contrast' - which will choose black or white, depending on the colour of the link. This is most useful with <a href="#LINK_COMMENTSTYLE">COMMENTSTYLE</a> center. </p><p>The colours are used as follows: </p><ul><li><a href="#LINK_COLORS">OUTLINECOLOR</a> is the colour of the line around the edge of the arrow.</li><li><a href="#LINK_COLORS">BWOUTLINECOLOR</a> is the colour of the line surrounding the 'bandwidth label' box</li><li><a href="#LINK_COLORS">BWBOXCOLOR</a> is the background colour for the same box</li><li><a href="#LINK_COLORS">BWFONTCOLOR</a> is the colour used for text within that box</li><li><a href="#LINK_COLORS">COMMENTFONTCOLOR</a> is the colour used for the text produced by <a href="#LINK_INCOMMENT">INCOMMENT</a> and <a href="#LINK_OUTCOMMENT">OUTCOMMENT,</a> along the side of a link arrow</li></ul><p><img src="../images/contrast.png"></img> <tt><a href="#LINK_COLORS">COMMENTFONTCOLOR</a> contrast</tt> with <tt><a href="#LINK_COMMENTSTYLE">COMMENTSTYLE</a> center</tt> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added COMMENTFONTCOLOR contrast.</dd><dt>0.93</dt><dd>Added correction - COMMENTCOLOR was shown instead of COMMENTFONTCOLOR.</dd><dt>0.9</dt><dd>Added COMMENTCOLOR.</dd><dt>0.8</dt><dd>Added OUTLINECOLOR, BWOUTLINECOLOR, BWFONTCOLOR and BWBOXCOLOR.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_INFOURL">INFOURL</a></h2><div class="definition">INFOURL <em class="meta">url</em></div><div class="description"><p>Creates a hyperlink in the HTML output. </p><p>If you are using the HTML output facility, then a link is added to the<map> section of the HTML so that when you click on the (weathermap) link, you aretaken to the url specified here. </p><p>It is also possible to specify the <a href="#LINK_INFOURL">INFOURL</a> for the 'in' and 'out' halves of a link individually, using <a href="#LINK_ININFOURL">ININFOURLand</a> <a href="#LINK_OUTINFOURL">OUTINFOURL.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_ININFOURL">ININFOURL</a></h2><div class="definition">ININFOURL <em class="meta">url</em></div><div class="definition">ININFOURL <em class="meta">url</em> </div><div class="description"><p>Same as INFOURL, but specifies a hyperlink for only the 'in' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTINFOURL">OUTINFOURL</a></h2><div class="definition">OUTINFOURL <em class="meta">url</em></div><div class="definition">OUTINFOURL <em class="meta">url</em></div><div class="description"><p>Same as INFOURL, but specifies a hyperlink for only the 'out' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OVERLIBGRAPH">OVERLIBGRAPH</a></h2><div class="definition">OVERLIBGRAPH <em class="meta">url</em></div><div class="description"><p>Creates a popup image in the HTML output. </p><p>If you are using the HTML output facility, and <a href="#GLOBAL_HTMLSTYLE">HTMLSTYLE</a> is set to 'overlib', then a link is added to the<map> section of the HTML so that when you move the mouse pointer over the the (weathermap) link, a box will pop upcontaining the image that you specify. Typically used to link to historical data in your network monitoring system. </p><p>You can also specify more than one url, in which case the images are 'stacked' one after another in the popup box. </p><p>If a <a href="#LINK_NOTES">NOTES</a> line is also specified for a link, then the image specified here appears with the <a href="#LINK_NOTES">NOTES</a> text underneath it. </p><p>It is also possible to specify the <a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> for the 'in' and 'out' halves of a link individually, using <a href="#LINK_INOVERLIBGRAPH">INOVERLIBGRAPH</a> and <a href="#LINK_OUTOVERLIBGRAPH">OUTOVERLIBGRAPH.</a> </p><p>You can influence how Weathermap positions the popup box, using the <a href="#LINK_OVERLIBWIDTH">OVERLIBWIDTH</a> and <a href="#LINK_OVERLIBHEIGHT">OVERLIBHEIGHT</a> keywords. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Typical use of OVERLIBGRAPH</h5><pre>OVERLIBGRAPH http://www.yoursite.net/mrtg/router1-link2-daily.png</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd><dt>0.95</dt><dd>Added IN/OUT support</dd><dt>0.0pre</dt><dd>Odd fact: This command, and the accompanying code to generate overlib imagemaps, were the first modification I ever made to the GRNET perl weathermap,and was what got me interested in writing my own version.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_INOVERLIBGRAPH">INOVERLIBGRAPH</a></h2><div class="definition">INOVERLIBGRAPH <em class="meta">url</em></div><div class="definition">INOVERLIBGRAPH <em class="meta">url</em> <em class="meta">url</em>...</div><div class="description"><p>Same as OVERLIBGRAPH, but specifies a pop-up graph for only the 'in' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTOVERLIBGRAPH">OUTOVERLIBGRAPH</a></h2><div class="definition">OUTOVERLIBGRAPH <em class="meta">url</em></div><div class="definition">OUTOVERLIBGRAPH <em class="meta">url</em> <em class="meta">url</em>...</div><div class="description"><p>Same as OVERLIBGRAPH, but specifies a pop-up graph for only the 'out' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OVERLIBWIDTH">OVERLIBWIDTH</a></h2><div class="definition">OVERLIBWIDTH <em class="meta">imagewidth</em></div><div class="description"><p>Specify the width, in pixels of the graph image referred to by <a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> line. </p><p>This is an optional extra that allows the OverLib library to make a better job ofpositioning the 'popup' image so that it doesn't appear off the edge of the screen.Typically, you would use this once, in the DEFAULT link. If you use this, you mustalso use <a href="#LINK_OVERLIBHEIGHT">OVERLIBHEIGHT,</a> for either to have any effect. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Originally added OVERLIBWIDTH and OVERLIBHEIGHT based on code by Niels Baggesen.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OVERLIBHEIGHT">OVERLIBHEIGHT</a></h2><div class="definition">OVERLIBHEIGHT <em class="meta">imagewidth</em></div><div class="description"><p>Specify the width, in pixels of the graph image referred to by <a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> line. </p><p>This is an optional extra that allows the OverLib library to make a better job ofpositioning the 'popup' image so that it doesn't appear off the edge of the screen.Typically, you would use this once, in the DEFAULT link. If you use this, you mustalso use <a href="#LINK_OVERLIBWIDTH">OVERLIBWIDTH,</a> for either to have any effect. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Originally added OVERLIBWIDTH and OVERLIBHEIGHT based on code by Niels Baggesen.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OVERLIBCAPTION">OVERLIBCAPTION</a></h2><div class="definition">OVERLIBCAPTION <em class="meta">caption text</em></div><div class="description"><p>Specify the caption used for the popup HTML 'window' if you have also specified an <a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> line. By default, this is the name of the <a href="#LINK_LINK">LINK.</a> </p><p>The text for the caption can contain <a href="advanced.html#tokens">special tokens</a> to show map data. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added OVERLIBCAPTION.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_INOVERLIBCAPTION">INOVERLIBCAPTION</a></h2><div class="definition">INOVERLIBCAPTION <em class="meta">caption text</em></div><div class="description"><p>Same as OVERLIBCAPTION, but specifies a pop-up graph caption for only the 'in' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd><dt>0.9</dt><dd>Originally added OVERLIBCAPTION.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTOVERLIBCAPTION">OUTOVERLIBCAPTION</a></h2><div class="definition">OUTOVERLIBCAPTION <em class="meta">caption text</em></div><div class="description"><p>Same as OVERLIBCAPTION, but specifies a pop-up graph caption for only the 'out' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added multiple URL support</dd><dt>0.9</dt><dd>Originally added OVERLIBCAPTION.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_NOTES">NOTES</a></h2><div class="definition">NOTES <em class="meta">notes text</em></div><div class="description"><p>Specifies the text or HTML notes for a link. </p><p>The <em>notes text</em> appears in a popup box when the user hovers their mouse over the link. If an <a href="#LINK_OVERLIBGRAPH">OVERLIBGRAPH</a> is specified too, then the text appears below the graph. </p><p>The map <a href="#GLOBAL_HTMLSTYLE">HTMLSTYLE</a> must be set to 'overlib' to enable any of the mouse-hover functionality. </p><p>It is also possible to specify the <a href="#LINK_NOTES">NOTES</a> for the 'in' and 'out' halves of a link individually, using <a href="#LINK_INNOTES">INNOTES</a> and <a href="#LINK_OUTNOTES">OUTNOTES.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd><dt>0.9</dt><dd>Originally added NOTES.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_INNOTES">INNOTES</a></h2><div class="definition">INNOTES <em class="meta">url</em></div><div class="definition">INNOTES <em class="meta">notes text</em></div><div class="description"><p>Same as NOTES, but specifies a text box for only the 'in' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_OUTNOTES">OUTNOTES</a></h2><div class="definition">OUTNOTES <em class="meta">url</em></div><div class="definition">OUTNOTES <em class="meta">notes text</em></div><div class="description"><p>Same as NOTES, but specifies a pop-up text box for only the 'out' side of a link. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.95</dt><dd>Added IN/OUT support</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_VIA">VIA</a></h2><div class="definition">VIA <em class="meta">x-coord</em> <em class="meta">y-coord</em></div><div class="definition">VIA <em class="meta">nodename</em> <em class="meta">x-offset</em> <em class="meta">y-offset</em></div><div class="description"><p>Specify an additional point that a link must pass through. </p><p>A link normally goes in a straight line between the two nodes listed in the <a href="#LINK_NODES">NODES</a> configuration line.If you need it to go around something else, or to seperate two parallel links so that the bandwidth labelsare all visible, you can make the link curve. </p><p>If you specify multiple <a href="#LINK_VIA">VIA</a> lines, then the link will pass through each in turn, in the order they are specified. </p><p>You can choose between curved or angled links with <a href="#LINK_VIASTYLE">VIASTYLE.</a> </p><p>Any <a href="#LINK_VIA">VIA</a> can also be specified relative to a <a href="#NODE_NODE">NODE</a> on the map. This makes it easier to have curves keep the intended shape as you re-organise a map. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added angled VIAs.</dd><dt>0.95</dt><dd>Added relative-positioned VIA.</dd><dt>0.8</dt><dd>Originally added VIA.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_VIASTYLE">VIASTYLE</a></h2><div class="definition">VIASTYLE curved</div><div class="definition">VIASTYLE angled</div><div class="description"><p>When using <a href="#LINK_VIA">VIA</a> to define a non-straight <a href="#LINK_LINK">LINK,</a> you can choose to have a curved link, where thecurve passes through each <a href="#LINK_VIA">VIA</a> point, or an angled link where each <a href="#LINK_VIA">VIA</a> point is a 'corner'. The defaultis for a curved link. </p><p><img src="../images/viastyle-curved.png"></img>Curved <a href="#LINK_VIA">VIA</a> </p><p><img src="../images/viastyle-angled.png"></img>Angled <a href="#LINK_VIA">VIA</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added 'angled' style, and VIASTYLE.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_LINKSTYLE">LINKSTYLE</a></h2><div class="definition">LINKSTYLE oneway</div><div class="definition">LINKSTYLE twoway</div><div class="description"><p>Specifies the whether the link should be drawn with one or two arrows. </p><p>A 'standard' (twoway) link has two arrows - one for inbound data and one for outbound data. In somesituations (e.g. round-trip latency), you might only want an arrow in one direction. </p><p>One-way arrows only show the outbound <a href="#LINK_BWLABEL">BWLABEL,</a> but they show it in the standard position - 25% of the way along.Change the position of the label with <a href="#LINK_BWLABELPOS">BWLABELPOS</a> as usual (you still need to specify <em>two</em> positions in the <a href="#LINK_BWLABELPOS">BWLABELPOS</a> line, however). </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.94</dt><dd>Added LINKSTYLE.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_ARROWSTYLE">ARROWSTYLE</a></h2><div class="definition">ARROWSTYLE <em class="meta">stylename</em></div><div class="definition">ARROWSTYLE <em class="meta">width</em> <em class="meta">length</em></div><div class="description"><p>Specifies the style of arrowhead used for drawing links. </p><p>The default is 'classic' which has a wide arrowhead. You can also choose 'compact' which gives narrower heads. </p><p>Finally, you can get finer control by adjusting the size yourself. The width and length of the head are in units of link-width. </p><p>Classic is equivalent to '4 2' and Compact is equivalent to '1 1'. </p><p><img src="../images/arrowstyle-classic.png"></img> Classic arrow style </p><p><img src="../images/arrowstyle-compact.png"></img> Compact arrow style </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>Added custom numeric form.</dd><dt>0.7</dt><dd>First added.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_SET">SET</a></h2><div class="definition">SET <em class="meta">hintname</em> <em class="meta">hintvalue</em></div><div class="description"><p>Specifies a value for a <em>hint variable</em>. </p><p>Hint Variables allow the user to pass settings to the internals of Weathermap thatwouldn't normally need to be changed, or that aren't part of the core Weathermap application.Examples are: small rendering changes, parameters for datasources plugins and similar. </p><p>Hint Variables are either Global for the map, or assigned to a specific link or node. </p><p>There is more about Hint Variables in the <a href="advanced.html">Advanced Topics</a> section. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added SET.</dd></dl></div></div><div class="referenceentry"><h2><a name="LINK_ZORDER">ZORDER</a></h2><div class="definition">ZORDER <em class="meta">z-coord</em> </div><div class="description"><p>Specifies the order in which to draw this item on the map. </p><p>By default, all nodes are drawn above all links.There are some situations where you might like to change this, for exampleif you use a <a href="#NODE_NODE">NODE</a> as a background image, and you want links to show in frontof that image. </p><p>By default, all nodes have a Z coordinate of 600, and all links have 300. The map legendis at 1000, which cannot be changed (you can move everything else above it, if you like, of course).Items are drawn from lowest Z up to highest Z, so if you want a particular node to appear underneath thedefault links, you can use <a href="#LINK_ZORDER">'ZORDER</a> 250' to do that.</p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added Z-ordering support.</dd></dl></div></div><h1 id="s_scope_GLOBAL" class="configsection">Global Configuration Directives</h1><div class="referenceentry"><h2><a name="GLOBAL_BACKGROUND">BACKGROUND</a></h2><div class="definition">BACKGROUND <em class="meta">imagefile</em></div><div class="description"><p>Specify an PNG, JPEG or GIF image file to be used as a background image. </p><p>Any <a href="#GLOBAL_WIDTH">WIDTH</a> and <a href="#GLOBAL_HEIGHT">HEIGHT</a> specifications will be ignored - the map will take the size of the background. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added JPEG and GIF support for backgrounds.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_WIDTH">WIDTH</a></h2><div class="definition">WIDTH <em class="meta">map-width</em></div><div class="description"><p>Specifies the width of the map image in pixels. </p><p>If a <a href="#GLOBAL_BACKGROUND">BACKGROUND</a> is specified, and the imagefile is successfully loaded, thenany <a href="#GLOBAL_WIDTH">WIDTH</a> specified is ignored.If neither a <a href="#GLOBAL_BACKGROUND">BACKGROUND</a> or <a href="#GLOBAL_WIDTH">WIDTH</a> is specified, then the default <a href="#GLOBAL_WIDTH">WIDTH</a> is 800 pixels. </p></div></div><div class="referenceentry"><h2><a name="GLOBAL_HEIGHT">HEIGHT</a></h2><div class="definition">HEIGHT <em class="meta">map-height</em></div><div class="description"><p>Specifies the height of the map image in pixels. </p><p>If a <a href="#GLOBAL_BACKGROUND">BACKGROUND</a> is specified, and the imagefile is successfully loaded, thenany <a href="#GLOBAL_HEIGHT">HEIGHT</a> specified is ignored.If neither a <a href="#GLOBAL_BACKGROUND">BACKGROUND</a> or <a href="#GLOBAL_HEIGHT">HEIGHT</a> is specified, then the default <a href="#GLOBAL_HEIGHT">HEIGHT</a> is 600 pixels. </p></div></div><div class="referenceentry"><h2><a name="GLOBAL_HTMLOUTPUTFILE">HTMLOUTPUTFILE</a></h2><div class="definition">HTMLOUTPUTFILE <em class="meta">htmlfile</em></div><div class="description"><p>This specifies the name of the HTML file that will be generated. </p><p>The equivalent command-line option takes precedence over this configuration line, if both are used. If you are generating maps using the Cacti plugin, then this directive is ignored. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.7</dt><dd>Added HTMLOUTPUTFILE.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_HTMLSTYLESHEET">HTMLSTYLESHEET</a></h2><div class="definition">HTMLSTYLESHEET <em class="meta">URL</em></div><div class="description"><p>Specifies a CSS stylesheet to reference, when generating HTML. </p><p>When HTML output is enabled, this allows you to include your own CSS stylesheet in the result, allowingfor customisation of the output without needing to use awk/perl/etc to modify the HTML. </p><p>If you are generating maps using the Cacti plugin, then this directive is ignored. </p><changes><change version="0.96">Added HTMLSTYLESHEET.</change></changes></div></div><div class="referenceentry"><h2><a name="GLOBAL_IMAGEOUTPUTFILE">IMAGEOUTPUTFILE</a></h2><div class="definition">IMAGEOUTPUTFILE <em class="meta">imagefile</em></div><div class="description"><p>This specifies the name of the PNG, JPEG or GIF file that will be generated. The format chosen is based on the file-extension. </p><p>The equivalent command-line option takes precedence over this configuration line, ifboth are used. </p><p>If you are generating maps using the Cacti plugin, then this directive is ignored.You can set the output format in the Cacti Settings page. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added JPEG and GIF support.</dd><dt>0.7</dt><dd>Added IMAGEOUTPUTFILE.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_IMAGEURI">IMAGEURI</a></h2><div class="definition">IMAGEURI <em class="meta">image-uri</em></div><div class="description"><p>If you are generating output files using <a href="#GLOBAL_HTMLOUTPUTFILE">HTMLOUTPUTFILE</a> and <a href="#GLOBAL_IMAGEOUTPUTFILE">IMAGEOUTPUTFILE</a> that are in a different directory to the weathermapinstallation, then the HTML will probably contain an incorrect IMG tag. This keyword allows you to replace the IMG SRC attributein the HTML output with a corrected one. </p><p>The equivalent command-line option (--image-uri) takes precedence over this configuration line, if both are used. </p><p>If you are generating maps using the Cacti plugin, then this directive is ignored, as the filename and uri are calculated instead. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added IMAGEURI.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_FONTDEFINE">FONTDEFINE</a></h2><div class="definition">FONTDEFINE <em class="meta">fontnumber</em> <em class="meta">gdfontfile</em></div><div class="definition">FONTDEFINE <em class="meta">fontnumber</em> <em class="meta">ttffontfile</em> <em class="meta">fontsize</em></div><div class="description"><p>Defines a custom font to be used for text within the map. </p><p>By default, the GD library used by Weathermap has 5 fonts, numbered 1-5. <a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a> allows you todefine new font numbers, and link them to fonts in two other formats. </p><p>The first format is 'GD fonts', which are a bitmapped format used by GD alone. They are not scalable, and are alsoplatform-specific (they use a different byte-order depending on the host). You should specify the full filename including any extensions. </p><p>The second format is TrueType fonts, which are scalable, standard and generally a lot nicer! This time, you need to specify thesize that the font should be rendered at. The size is in pixels. You can load the same font into multiple fontnumbers withdifferent sizes to use in different parts of a map. </p><p>The freetype library used in PHP makes a somewhat complex set of rules for where it will search for truetype fonts. The two easiest options are:<ul><li>Use the full absolute path to your .ttf file</li><li>Keep your .ttf files in the Weathermap directory, and use the first part of the filename only, with no '.ttf' on the end.</li></ul>The full set of rules is <a href="http://www.boutell.com/gd/manual2.0.33.html#gdImageStringFT">available here</a> </p><p>Regardless of the format, the newly defined font can be used anywhere that you'd normally use a font number (for example, <a href="#LINK_BWFONT">BWFONT</a> or <a href="#GLOBAL_FONT">KEYFONT).</a></p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Defining a new Truetype font, with the font file in the weathermap directory</h5><pre>FONTDEFINE 10 VeraBd 16</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>First added FONTDEFINE</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_FONT">*FONT</a></h2><div class="definition">TITLEFONT <em class="meta">fontnumber</em></div><div class="definition">KEYFONT <em class="meta">fontnumber</em></div><div class="definition">TIMEFONT <em class="meta">fontnumber</em></div><div class="description"><p>Specify the fonts used for various text. </p><p>Fonts are specified by number. The GD library that Weathermap uses has 5 built-in fonts, 1-5. You can define new fonts based on TrueType or GD fonts by using the <a href="#GLOBAL_FONTDEFINE">FONTDEFINE</a> directive. </p><p><img src="../images/font-sizes.png"></img>The built-in GD fonts. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>Originally added TITLEFONT.</dd><dt>0.7</dt><dd>Originally added TIMEFONT.</dd><dt>0.6</dt><dd>Originally added KEYFONT.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_COLORS">*COLOR</a></h2><div class="definition">BGCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">TIMECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">TITLECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">KEYTEXTCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">KEYOUTLINECOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">KEYBGCOLOR <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="description"><p>Specify the colours used for drawing the global elements of the map. </p><p>red, green and blue are numbers from 0 to 255. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>Added TIMECOLOR, TITLECOLOR, KEYTEXTCOLOR, KEYOUTLINECOLOR and KEYBGCOLOR.</dd><dt>0.7</dt><dd>Added BGCOLOR.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_TIMEPOS">TIMEPOS</a></h2><div class="definition">TIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">TIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">formatstring</em></div><div class="description"><p>Specifies where to draw the timestamp on the map. </p><p>If no <a href="#GLOBAL_TIMEPOS">TIMEPOS</a> line is given, then the timestamp is drawn in the top-right corner. To hide it completely, set y to be <nobr>-200</nobr> or so. </p><p>You can optionally specify an additional parameter to change the text of the timestamp. This text cancontain special tokens which are substituted with parts of the current time. The default timestamptext is <nobr><tt>Created: %b %d %Y %H:%M:%S</tt></nobr>. The tokens used are those accepted by the PHP strftimefunction. For a full list see the <a href="http://www.php.net/manual/en/function.strftime.php">PHP manual page</a>. </p><p>You can control the font used to draw the timestamp with <a href="#GLOBAL_FONT">TIMEFONT,</a> and the colour that it is drawn in, using <a href="#GLOBAL_COLORS">TIMECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.6</dt><dd>Added ability to change text.</dd><dt>0.5</dt><dd>Originally added TIMEPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_MINTIMEPOS">MINTIMEPOS</a></h2><div class="definition">MINTIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">MINTIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">formatstring</em></div><div class="description"><p>Specifies where to draw the 'oldest data' timestamp on the map. </p><p>The data collection part of weathermap collects a timestamp for each piece of data, alongside the actual data.This is intended to signify the time that the data was actually valid - it would be the file modification date ifit was a text file, or the current time if it was a live SNMP query. The minimum and maximum of these times arecollated, and can be shown on the map with <a href="#GLOBAL_MINTIMEPOS">MINTIMEPOS</a> and <a href="#GLOBAL_MAXTIMEPOS">MAXTIMEPOS.</a> </p><p>If no <a href="#GLOBAL_MINTIMEPOS">MINTIMEPOS</a> line is given, then the timestamp is not drawn. </p><p>You can optionally specify an additional parameter to change the text of the timestamp. This text cancontain special tokens which are substituted with parts of the current time. The default timestamptext is <nobr><tt>Oldest Data: %b %d %Y %H:%M:%S</tt></nobr>. The tokens used are those accepted by the PHP strftimefunction. For a full list see the <a href="http://www.php.net/manual/en/function.strftime.php">PHP manual page</a>. </p><p>You can control the font used to draw the timestamp with <a href="#GLOBAL_FONT">TIMEFONT,</a> and the colour that it is drawn in, using <a href="#GLOBAL_COLORS">TIMECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Originally added MINTIMEPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_MAXTIMEPOS">MAXTIMEPOS</a></h2><div class="definition">MAXTIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">MAXTIMEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">formatstring</em></div><div class="description"><p>Specifies where to draw the 'newest data' timestamp on the map. </p><p>The data collection part of weathermap collects a timestamp for each piece of data, alongside the actual data.This is intended to signify the time that the data was actually valid - it would be the file modification date ifit was a text file, or the current time if it was a live SNMP query. The minimum and maximum of these times arecollated, and can be shown on the map with <a href="#GLOBAL_MINTIMEPOS">MINTIMEPOS</a> and <a href="#GLOBAL_MAXTIMEPOS">MAXTIMEPOS.</a> </p><p>If no <a href="#GLOBAL_MAXTIMEPOS">MAXTIMEPOS</a> line is given, then the timestamp is not drawn. </p><p>You can optionally specify an additional parameter to change the text of the timestamp. This text cancontain special tokens which are substituted with parts of the current time. The default timestamptext is <nobr><tt>Newest Data: %b %d %Y %H:%M:%S</tt></nobr>. The tokens used are those accepted by the PHP strftimefunction. For a full list see the <a href="http://www.php.net/manual/en/function.strftime.php">PHP manual page</a>. </p><p>You can control the font used to draw the timestamp with <a href="#GLOBAL_FONT">TIMEFONT,</a> and the colour that it is drawn in, using <a href="#GLOBAL_COLORS">TIMECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Originally added MAXTIMEPOS</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_TITLE">TITLE</a></h2><div class="definition">TITLE <em class="meta">titlestring</em></div><div class="description"><p>Specifies the title text. </p><p>The <a href="#GLOBAL_TITLE">TITLE</a> is shown in file-selectors for both the editor and the Cacti plugin. If you'd like the title to be shown on the map too, then add <a href="#GLOBAL_TITLEPOS">TITLEPOS</a> line also. </p></div></div><div class="referenceentry"><h2><a name="GLOBAL_TITLEPOS">TITLEPOS</a></h2><div class="definition">TITLEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">TITLEPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">headingstring</em></div><div class="description"><p>Specifies the position of the title text. </p><p>If no <a href="#GLOBAL_TITLEPOS">TITLEPOS</a> line is given, then no title is drawn. You can optionally specify an additional parameter, to change the title. Any text after the second coordinate is taken as a new <a href="#GLOBAL_TITLE">TITLE.</a> </p><p>You can control the font used to draw the title with <a href="#GLOBAL_FONT">TITLEFONT,</a> and the colour that it is drawn in, using <a href="#GLOBAL_COLORS">TITLECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.8</dt><dd>Originally added TITLEPOS.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_KILO">KILO</a></h2><div class="definition">KILO <em class="meta">number</em></div><div class="description"><p>Specifies base value for kilo, mega and giga abbreviations. </p><p>Both <a href="#LINK_BANDWIDTH">BANDWIDTH</a> and <a href="#LINK_BWLABEL">BWLABEL</a> can use K,M,G,T as abbreviations for thousands, millions and so on. You can define what the multiple used is. The default is 1000. </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.4</dt><dd>Originally added KILO.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_HTMLSTYLE">HTMLSTYLE</a></h2><div class="definition">HTMLSTYLE <em class="meta">formatname</em></div><div class="description"><p>Specifies the HTML output style. </p><p>When HTML output is enabled, there are two variations, which you can choose between. 'static' is a basic HTML page with client-side imagemap, but no 'pop up' graphs. 'overlib' adds the use of the OverLib library to the page, so that pop up graphs can work, too. This requires Javascript, which is why 'static' is the default. </p></div></div><div class="referenceentry"><h2><a name="GLOBAL_SCALE">SCALE</a></h2><div class="definition">SCALE <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">SCALE <em class="meta">scalename</em> <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em></div><div class="definition">SCALE <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">red2</em> <em class="meta">green2</em> <em class="meta">blue2</em></div><div class="definition">SCALE <em class="meta">scalename</em> <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">red2</em> <em class="meta">green2</em> <em class="meta">blue2</em></div><div class="definition">SCALE <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">tagtext</em></div><div class="definition">SCALE <em class="meta">scalename</em> <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">tagtext</em></div><div class="definition">SCALE <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">red2</em> <em class="meta">green2</em> <em class="meta">blue2</em> <em class="meta">tagtext</em></div><div class="definition">SCALE <em class="meta">scalename</em> <em class="meta">min</em> <em class="meta">max</em> <em class="meta">red</em> <em class="meta">green</em> <em class="meta">blue</em> <em class="meta">red2</em> <em class="meta">green2</em> <em class="meta">blue2</em> <em class="meta">tagtext</em></div><div class="definition">SCALE <em class="meta">min</em> <em class="meta">max</em> none</div><div class="description"><p>Defines one 'span' within the link colour-coding table. </p><p><a href="#GLOBAL_SCALE">SCALE</a> is used to specify how <a href="#NODE_NODE">NODEs</a> and <a href="#LINK_LINK">LINKs</a> are colour-coded according to their percent usage.If the percentage usage falls between min and max then the colour specified by red, green and blue is used to colour the link.Colour values are between 0 and 255. Percentages are between 0 and 100, obviously. </p><p>In combination with the 'absolute' option of <a href="#LINK_USESCALE">USESCALE,</a> you can also use raw data from <a href="#LINK_TARGET">TARGET</a> lines. Justuse the absolute values for min and max in <a href="#GLOBAL_SCALE">SCALE</a> lines. In this format, min and max can use the same abbreviations for mega, giga etc as<a href="#LINK_BANDWIDTH">BANDWIDTH</a> and <a href="#NODE_MAXVALUE">MAXVALUE</a> can. </p><p>If you specify <i>two</i> colours on the line (the third and fourth forms above), then the colour chosen for the link will be calculated asa proportion between the two colours. You can avoid specifying many <a href="#GLOBAL_SCALE">SCALE</a> lines this way. </p><p>If you specify the word 'none' instead of a colour, then a transparent colour is used for that range of values. </p><p>Without a <i>scalename</i>, the <a href="#GLOBAL_SCALE">SCALE</a> line will add a definition to the scale named 'DEFAULT'. If you define any other named scales, you can then use the <a href="#LINK_USESCALE">USESCALE</a> directive to specify that a particular <a href="#NODE_NODE">NODE</a> or <a href="#LINK_LINK">LINK</a> use your new scale. </p><p>With any of the formats, you can specify a 'tag' on the end of the line. When the colour is decided for the 'in' and 'out' parts of a <a href="#NODE_NODE">NODE</a> or <a href="#LINK_LINK">LINK,</a>then a special <a href="#GLOBAL_SET">SET</a> variable is defined called {node:this:inscaletag} (or outscaletag, or link:this...) which contains the tagtext from the <a href="#GLOBAL_SCALE">SCALE</a> line thatmatched. You can use this to do things like choose an icon, or change the label of a node or link based on a percentage. There are examples of this (and most other node-related formatting things) in the suite-1.conf map found in the random-bits/ folder of the weathermap distribution. </p><p>If you don't add <i>any</i> <a href="#GLOBAL_SCALE">SCALE</a> lines to a configuration file, then a default set is added for you, but as soon as you add one, you'll need to make enough to cover the whole 0-100 range to get nice colours.Any percentage not matched by <a href="#GLOBAL_SCALE">SCALE</a> rules is rendered in grey. </p><p>You can specify a colour for an <em>exact</em> percentage (e.g. zero) by using that value for both the min and max values. The scale lines are sorted by min then max, and scanned from top to bottom. The first match wins. </p><p>To show a legend in the map for a given <a href="#GLOBAL_SCALE">SCALE,</a> you should use <a href="#GLOBAL_KEYPOS">KEYPOS</a> and <a href="#GLOBAL_KEYSTYLE">KEYSTYLE.</a> </p><p>You can also apply <a href="#GLOBAL_SCALE">SCALEs</a> to colorise <a href="#NODE_ICON">ICON</a> images. You do this using <a href="#NODE_USEICONSCALE">USEICONSCALE.</a> </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Setting up a (very simple) colour scale. Colours run smoothly from green to red.</h5><pre>SCALE 0 100 0 255 0 255 0 0</pre></div><div class="example"><h5>The default scale set</h5><pre>SCALE 1 10 140 0 255SCALE 10 25 32 32 255SCALE 25 40 0 192 255SCALE 40 55 0 240 0SCALE 55 70 240 240 0SCALE 70 85 255 192 0SCALE 85 100 255 0 0</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.97</dt><dd>Added absolute scale support.</dd><dt>0.96</dt><dd>Added 'none' colour option.</dd><dt>0.95</dt><dd>Added USEICONSCALE.</dd><dt>0.95</dt><dd>Added scale tags.</dd><dt>0.9</dt><dd>Added named scales.</dd><dt>0.9</dt><dd>Added considtently sorted scales.</dd><dt>0.8</dt><dd>Added interpolated scale colours.</dd><dt>0.5</dt><dd>Changed to allow min and max to be fractional.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_KEYPOS">KEYPOS</a></h2><div class="definition">KEYPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">KEYPOS <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">headingstring</em></div><div class="definition">KEYPOS <em class="meta">scalename</em> <em class="meta">x-pos</em> <em class="meta">y-pos</em></div><div class="definition">KEYPOS <em class="meta">scalename</em> <em class="meta">x-pos</em> <em class="meta">y-pos</em> <em class="meta">headingstring</em></div><div class="description"><p>Specifies the position of the key, or legend, that shows what each colour-range in a scale means. If a scalename is not given,then "DEFAULT" is assumed.If no <a href="#GLOBAL_KEYPOS">KEYPOS</a> line is given for a scale, then no legend is drawn - handy if you have many many colour ranges. You can also hide any legend bygiving it a position with negative coordinates. </p><p>You can optionally specify an additional parameter, to change the heading above the colours inthe key. This can be used to change the language of the map, for example. If a scalename is given, then you <em>must also specify a title</em> - there is no useful default title for non-DEFAULT scales. </p><p>You can control the font used to draw the key with <a href="#GLOBAL_FONT">KEYFONT,</a> and the colours that it is drawn in, using <a href="#GLOBAL_COLORS">KEYTEXTCOLOR,</a> <a href="#GLOBAL_COLORS">KEYBGCOLOR</a> and <a href="#GLOBAL_COLORS">KEYOUTLINECOLOR.</a> </p></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Added support for multiple SCALEs.</dd><dt>0.6</dt><dd>Added ability to change text.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_KEYSTYLE">KEYSTYLE</a></h2><div class="definition">KEYSTYLE <em class="meta">stylename</em></div><div class="definition">KEYSTYLE <em class="meta">stylename</em> <em class="meta">size</em></div><div class="definition">KEYSTYLE <em class="meta">scalename</em> <em class="meta">stylename</em></div><div class="definition">KEYSTYLE <em class="meta">scalename</em> <em class="meta">stylename</em> <em class="meta">size</em></div><div class="description"><p>Specifies the style of the key, or legend, that shows what each colour-range means. If a scalename is not given,then "DEFAULT" is assumed. Valid stylenames are: 'classic', 'horizontal', 'vertical', 'inverted' and 'tags'. </p><p>Classic has a line for each <a href="#GLOBAL_SCALE">SCALE</a> range defined. 'vertical' and 'horizontal' are fixed-size, showing acontinuous block from 0-100% usage, which is much more useful when gradient <a href="#GLOBAL_SCALE">SCALEs</a> are used, or when you havea large number of <a href="#GLOBAL_SCALE">SCALE</a> lines in one scale. 'inverted' is the same as 'vertical', but with the zero point at the bottom, thermometer-style. Finally, 'tags' is the same style as 'classic', butinstead of percentages, it shows the tag string from the end of the <a href="#GLOBAL_SCALE">SCALE</a> lines, if there are any. </p><p>For 'horizontal' and 'vertical' styles, you can optionally add an additional parameter, which specifies the longer dimension of the legend in pixels. That is, for a horizontal legend, it specifies the width. The other dimension is calculated from the size of the font used (see <a href="#GLOBAL_FONT">KEYFONT).</a></p><p><img src="../images/keystyle-classic.png"></img>Classic Style </p><p><img src="../images/keystyle-horizontal.png"></img>Horizontal Style </p><p><img src="../images/keystyle-vertical.png"></img>Vertical Style </p><p><img src="../images/keystyle-inverted.png"></img>Inverted Style </p><p><img src="../images/keystyle-tags.png"></img>Tags Style </p><p>You can hide the percentage signs in the key, by setting key_hidepercent_<em>scalename</em> to 1 </p><p>If you have a 0->0 line in your <a href="#GLOBAL_SCALE">SCALE,</a> then you can hide that in the key, by setting key_hidezero_<em>scalename</em> to 1 </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Hiding percentage signs, and the 'absolute zero' SCALE entry in a key.</h5><pre>SET key_hidezero_DEFAULT 1SET key_hidepercent_DEFAULT 1</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.96</dt><dd>Added tags and inverted styles.</dd><dt>0.92</dt><dd>Added hidepercent and hidezero SET variables.</dd><dt>0.9</dt><dd>Added support for multiple key styles (classic, horizontal, vertical).</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_SET">SET</a></h2><div class="definition">SET <em class="meta">hintname</em> <em class="meta">hintvalue</em></div><div class="description"><p>Specifies a value for a <em>hint variable</em>. </p><p>Hint Variables allow the user to pass settings to the internals of Weathermap thatwouldn't normally need to be changed, or that aren't part of the core Weathermap application.Examples are: small rendering changes, parameters for datasources plugins and similar. </p><p>Hint Variables are either Global for the map, or assigned to a specific link or node. </p><p>There is more about Hint Variables in the <a href="advanced.html">Advanced Topics</a> section. </p></div><div class="examples"><h3>Examples</h3><div class="example"><h5>Enabling 'bulging link mode' in the link-rendering code.</h5><pre>SET link_bulge 1</pre></div><div class="example"><h5>Enabling 'screenshot mode' to anonymise a map in 0.95 or newer.</h5><pre>SET screenshot_mode 1</pre></div></div><div class="changes"><h3>Change History</h3><dl><dt>0.9</dt><dd>Originally added SET.</dd></dl></div></div><div class="referenceentry"><h2><a name="GLOBAL_INCLUDE">INCLUDE</a></h2><div class="definition">INCLUDE <em class="meta">filename</em></div><div class="description"><p>Include the contents of an additional file within the current map configuration file. </p><p>Allows you to use a common set of definition across several map files. There are several restrictions:<ul><li><a href="#GLOBAL_INCLUDE">INCLUDE</a> can <em>only</em> be used in the 'global' section of the the map configuration file - that is, before the first <a href="#NODE_NODE">NODE</a> or LINK.</li><li>INCULDEd files must contain complete <a href="#NODE_NODE">NODE</a> or <a href="#LINK_LINK">LINK</a> definitions.</li><li>If you intend to use the web-based editor, then you can't currently use any commands other than<a href="#NODE_NODE">NODE</a> or <a href="#LINK_LINK">LINK</a> definitions - that is, no <a href="#GLOBAL_SCALE">SCALEs</a> or <a href="#GLOBAL_FONTDEFINE">FONTDEFINEs</a> etc.</li></ul>The <a href="#GLOBAL_INCLUDE">INCLUDE</a> file can still be useful to define a set of standard templates that can then be used across maps. Some of the other restrictions will hopefully be lifted in a future version. The reason for the restrictions isthat the way config files are read and written doesn't keep track of where a particular setting came from, apart from at the NODE/LINK level. This is also the reason why comments are 'lost' by the editor.</p></div><div class="changes"><h3>Change History</h3><dl><dt>0.96b</dt><dd>Originally added INCLUDE.</dd></dl></div></div></div></body></html>