Location: PHPKode > projects > Weathermap5rrd > weathermap5rrd-1.3.11/docs/config_file_struct.txt
# Weathermap5RRD config file
Documentation for Weathermap5RRD config file. Please, see examples and you can 
even refer to Weathermap4RRD documentaion as the aim was to keep as much as 
possible from Weathermap4RRD unchanged.

## Elements
### root
@arrowwidth(int = 4)
Sets arrow width.

@background(string = NULL)
Sets background image. Background should contain (full)path to image.

@drawgrid(bit = 1)
Switch for (not) drawing background grid. Accepts bit (0/1) only.

@font(int = 3)
Sets font size in GD units. Accepted values range from 1 to 5.

@height(int = 480)
Sets height of PNG-out image.

@ipcheck(bit = 0)
Do or don't network checks for nodes.

@outputfile(string = NULL)
Sets path to HTML-out file.

@refresh(int = 60)
Sets refresh rate of page.

@width(int = 640)
Sets width of PNG-out image.

### autoscale
@nodivisions(int)
Number of divisions.

@rstart(int)
Red colour range starts. Accepts int range 0-255.

@rend(int)
Red colour range ends. Accepts int range 0-255.

@gstart(int)
Green colour range starts. Accepts int range 0-255.

@gend(int)
Green colour range ends. Accepts int range 0-255.

@bstart(int)
Blue colour range starts. Accepts int range 0-255.

@bend(int)
Blue colour range ends. Accepts int range 0-255.
### /autoscale

### links
#### link-name(string)
@arrow(string)
Arrow type. Accepted values are 'normal', 'circle' or 'halfarrow';

@bandwidth(int)
Maximum bandwidth of the link.

@displayvalue(bit)
Display current bandwidth value. Default value is 0. Accepts 0 or 1.

@group(string)
Group name used for filtering of links by the name of group(s) they belong to. 
This is not supported at the moment.

@from(string)
Defines the first side of the link. This should point to existing element 
in nodes.

@inodegroup(int)
Internal variable used by editor. Unique random number.

@inpos(int)
Position of inbound traffic in RRD file.

##### internode
@x(int)
X position of internode.

@y(int)
Y position of internode.
##### /internode

@internodedisplay(bit)
Display internode(s). Accepts 0 or 1.

@internodedisplaynum(bit)
Display internode(s) number. Accepts 0 or 1.

@linkoverlibgraph(string)
Graph or some output displayed on mouse:hover over the link. Accepts '1', 
'linkgraph' which is equal to '1', 'currentvalues' or 'custom_link' 
ie. http://domain.tld/myscript.php.

@linkinfourl(string)
URL to info page about link. Accepted values are 'globalgraph' or url to some 
script or site.

@outpos(int)
Position of outbound traffic in RRD file.

@target(string)
Link RRD file or mtrg page.

@targetin(string)
Link input - RRD file or mrtg page.

@targetout(string)
Link output - RRD file or mrtg page.

@to(string)
Defines the second side of the link. This should point to existing element 
in nodes.

@unit(string)
Link units. Accepts 'kbits', 'Mbits', 'Kbytes' or 'Mbytes'.
#### /link-name
### /links

### legend
@legendstyle(string = 'original')
Legend style. Accepts 'original' or 'line'.

@x(int)
X position of legend.

@y(int)
Y position of legend.
### /legend

### nodes
#### node-name(string)
@name(string)
Node name. There are no whitespaces allowed!

@label(string)
Node label.

@labeltype(string)
Type of label. Accepts 'square' or 'round'.

@x(int)
X position of node.

@y(int)
Y position of node.

@icon(string)
Path to icon (png) image.

@iconx(int)
X position of icon. Be aware, icon postion is not relative to node position!

@icony(int)
Y position of icon. Be aware, icon postion is not relative to node position!

@icontpt(int)
Node icon transparency in per cents.

@iconresize(int)
Node icon resize in per cents.

@ip(string)
IP address of node. Accepts only valid IPv4 address.

@check(string)
Accepts values 'ping' or 'tcp:port' ie. 'tcp:80'.

@nodeinfourl(string)
URL to info page about node.
#### /node-name
### /nodes

### scale
#### entry
@low(int)
Percentual low value of link. Accepts int range 0-100.

@high(int)
Percentual high value of link. Accepts int range 0-100.

@r(int)
Red colour. Accepts int range 0-255.

@g(int)
Green colour. Accepts int range 0-255.

@b(int)
Blue colour. Accepts int range 0-255.
#### /entry
### /scale

### title
@text(string)
Title of title.

@x(int)
X position of title.

@y
Y position of title.

#### bg - title background colour
@r(int)
Red colour. Accepts int range 0-255.

@g(int)
Green colour. Accepts int range 0-255.

@b(int)
Blue colour. Accepts int range 0-255.
#### /bg

#### fg - title foreground colour
@r(int)
Red colour. Accepts int range 0-255.

@g(int)
Green colour. Accepts int range 0-255.

@b(int)
Blue colour. Accepts int range 0-255.
#### /fg
### /title
### /root

## XML Tree view
root
  |
  |-- arrowwidth >> int;
  |-- autoscale
  |           |-- nodivisions >> int;
  |           |-- rstart >> int (0-255);
  |           |-- rend >> int (0-255);
  |           |-- gstart >> int (0-255);
  |           |-- gend >> int (0-255);
  |           |-- bstart >> int (0-255);
  |           `-- bend >> int (0-255);
  |-- background >> string;
  |-- drawgrid >> bit (0/1);
  |-- font >> int (1-5);
  |-- height >> int;
  |-- htmlfile >> string;
  |-- ipcheck >> bit (0/1);
  |-- links
  |      `- link-name >> string;
  |                |-- arrow >> string;
  |                |-- bandwidth >> int;
  |                |-- displayvalue >> bit (0/1);
  |                |-- group >> string;
  |                |-- from >> string;
  |                |-- inodegroup >> int;
  |                |-- inpos >> int;
  |                |-- internode
  |                |         |-- x >> int;
  |                |         `-- y >> int;
  |                |-- internodedisplay >> bit (0/1);
  |                |-- internodedisplaynum >> bit (0/1);
  |                |-- linkoverlibgraph >> string;
  |                |-- linkinfourl >> string;
  |                |-- outpos >> int;
  |                |-- target >> string;
  |                |-- targetin >> string;
  |                |-- targetout >> string;
  |                |-- to >> string;
  |                `-- unit >> string;
  |-- legend
  |       |-- x >> int;
  |       |-- y >> int;
  |       `-- legendstyle >> string;
  |-- nodes
  |      `- node-name >> string;
  |                |-- name >> string;
  |                |-- label >> string;
  |                |-- labeltype >> string;
  |                |-- x >> int;
  |                |-- y >> int;
  |                |-- icon >> string;
  |                |-- iconx >> int;
  |                |-- icony >> int;
  |                |-- icontpt >> int (0-100)
  |                |-- iconresize >> int;
  |                |-- ip >> string;
  |                |-- check >> string;
  |                `-- nodeinfourl >> string;
  |-- outputfile >> string;
  |-- refresh >> int;
  |-- scale
  |       `-- entry
  |               |-- low >> int;
  |               |-- high >> int;
  |               |-- r >> int (0-255);
  |               |-- g >> int (0-255);
  |               `-- b >> int (0-255);
  |-- title
  |       |-- bg
  |       |     |-- r >> int (0-255);
  |       |     |-- g >> int (0-255);
  |       |     `-- b >> int (0-255);
  |       |-- fg
  |       |     |-- r >> int (0-255);
  |       |     |-- g >> int (0-255);
  |       |     `-- b >> int (0-255);
  |       |-- text >> string;
  |       |-- x >> int;
  |       `-- y >> int;
  `-- width >> int;

Return current item: Weathermap5rrd