


CONFIG(1)                     picnet                    CONFIG(1)


NNNNAAAAMMMMEEEE
       config - PICNET 1.1 configuration reference

OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW
       PicNet needs a rrrreeeeffffeeeerrrreeeennnncccceeee PPPPNNNNGGGG iiiimmmmaaaaggggeeee (actually 1 per map)
       and a ccccoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn ffffiiiilllleeee (check the picnet manpage)...

       This document describes all the configuration options
       understood by the picnet software.

SSSSYYYYNNNNTTTTAAAAXXXX
       PicNet configuration file looks like MRTG one. So it is
       very easy if you are familiar to mrtg.cfg...

       If you used automatic generation of your MRTG config file,
       you should have a look at this file to get the name of
       targets. Then, you can edit the PPPPiiiiccccNNNNeeeetttt ccccoooonnnnffffiiiigggg ffffiiiilllleeee eeeexxxxaaaammmmpppplllleeee
       (_e_x_._c_f_g) to meet your needs.

       PicNet configuration file syntax follows some simple rules
       :

       +o   Keywords must start at the beginning of a line or
           after the symbol '*' (so the leading string is
           supposed to be a map name).

       +o   Lines which first character is '#' or a space are
           ignored (comments).

       +o   Other lines are analysed but without effect if no
           valid mandatory keyword is found.

MMMMAAAAPPPPSSSS NNNNAAAAMMMMIIIINNNNGGGG
       Note than you can use PicNet with one map or with sssseeeevvvveeeerrrraaaallll
       mmmmaaaappppssss (tree hierarchies are possible with _M_a_p_C_o_l_o_r_I_d_x). For
       using several maps, you must specify the name of each map
       as a prefix to its parameters ('*' is the separator).

       All the parameters (even global parameters if used with a
       prefix) can apply to one specified map.

       Example :

        net1*ImageRef: ex.png

       The default map (no '*' prefix) is named _i_n_d_e_x_m_a_p.

       All the non-global parameters without prefix apply to this
       default map (_i_n_d_e_x_m_a_p). Global parameters without prefix
       obviously apply to all the maps defined.

GGGGLLLLOOOOBBBBAAAALLLL PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS





2000-10-25                     1.1                              1





CONFIG(1)                     picnet                    CONFIG(1)


       WWWWoooorrrrkkkkddddiiiirrrr

       Workdir specifies where the logfiles and reference image
       are and where the resulting image and webpage should be
       created.

       Example:

        WorkDir: /www/html/mrtg

       Note that you can specify a WorkDir per map.

       RRRReeeeffffrrrreeeesssshhhh

       How many seconds apart should the browser (Netscape, IE)
       be instructed to reload the page? If this is not defined,
       the default is 300 seconds (5 minutes).

       Example:

        Refresh: 600

       Note that you can specify a Refresh per map.

PPPPEEEERRRR MMMMAAAAPPPP CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
       IIIImmmmaaaaggggeeeeRRRReeeeffff

       The name of the reference image. To create such a file,
       read the instructions in the picnet manpage.

       This parameter is mandatory.  You must not use the map
       name as the ImageRef name if you use the default ImageNet
       name : your reference image will be replaced !

       Examples:

        ImageRef: mynet.png
        net1*ImageRef: imref1.png


       IIIImmmmaaaaggggeeeeNNNNeeeetttt

       The name of the image resulting of the PicNet process.

       This parameter is optional. If not specified, the name of
       this image is the name of the map followed by '.png'.

       Examples:

        ImageNet: traffic.png
        mynet*ImageNet: imnet2.png






2000-10-25                     1.1                              2





CONFIG(1)                     picnet                    CONFIG(1)


       HHHHttttmmmmllllTTTTiiiittttlllleeee

       This is the title of the HTML page displaying the
       processed image.

       You must specify _H_t_m_l_T_i_t_l_e or _H_t_m_l_P_a_g_e_H_e_a_d_e_r in order to
       generate the HTML page for a map.

       TTTThhhheeee nnnnaaaammmmeeee ooooffff aaaannnn HHHHTTTTMMMMLLLL ppppaaaaggggeeee ffffoooorrrr aaaa mmmmaaaapppp iiiissss tttthhhheeee nnnnaaaammmmeeee ooooffff tttthhhhiiiissss mmmmaaaapppp
       ffffoooolllllllloooowwwweeeedddd bbbbyyyy ''''....hhhhttttmmmmllll''''....

       Example:

        HtmlTitle: Current traffic on my network (indexmap.html)
        net3*HtmlTitle: Current traffic on a distant network


       HHHHttttmmmmllllPPPPaaaaggggeeeeHHHHeeeeaaaaddddeeeerrrr

       This is the first HTML code line in the HTML page.  Sorry,
       the header is limited to the line and about 100
       characters.

       You must specify _H_t_m_l_t_i_t_l_e or _H_t_m_l_P_a_g_e_H_e_a_d_e_r in order to
       generate the HTML page for a map.

       Examples:

        HtmlPageHeader: <H2 ALIGN=CENTER>Our Company Network<BR>Current Traffic</H2>
        Net1*HtmlPageHeader: <H2 ALIGN=CENTER>NET1 Current Traffic</H2>


       HHHHttttmmmmllllAAAArrrreeeeaaaassssDDDDeeeeffff

       So, you can specify a file with definitions of other
       clickable areas on your network image. These areas are
       defined using the HTML AREA tag. The file must be in the
       WorkDir directory.

       HtmlAreasDef is useful only if you specify HtmlTitle or
       HtmlPageHeader in order to generate the HTML page for the
       map.

       Examples:

        HtmlAreasDef: other.areas
        net*HtmlAreasDef: webmin.areas

       And the content of other.areas is :

        <area href="info.html" alt="info" shape="poly" coords="126,76,234,75,250,74,248,80,129,84">
        <area href="mypage.html" alt="mypage" shape="rect" coords="110,66,126,97">
        ...




2000-10-25                     1.1                              3





CONFIG(1)                     picnet                    CONFIG(1)


PPPPEEEERRRR MMMMAAAAPPPP AAAANNNNDDDD TTTTAAAARRRRGGGGEEEETTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
       CCCCoooolllloooorrrrIIIIddddxxxx

       ColorIdx is the color index value of the graphical object
       (line...)  which color will change depending on values in
       the corresponding mrtg log file (traffic present on a
       link).

       The new color depends on the mmmmaaaaxxxxiiiimmmmuuuummmm ooooffff tttthhhheeee 2222 vvvvaaaalllluuuueeeessss
       extracted from the mrtg log file (incoming and outgoing
       traffic for a router interface). Nowadays, there are 10
       different colors (0-10 %, 10-20%, ...) but they can be
       modified before compiling in cfg.h and def.h.

       Examples:

        ColorIdx[ezwf]: 250
        net2*ColorIdx[r1.1]: 245


       CCCCoooolllloooorrrrIIIIddddxxxxIIIInnnn

       ColorIdxIn is the color index value of the graphical
       object (line...)  which color will change depending on the
       first value in the corresponding mrtg log file (iiiinnnnccccoooommmmiiiinnnngggg
       ttttrrrraaaaffffffffiiiicccc on a link).

       Examples:

        ColorIdxIn[ezwf]: 251
        net2*ColorIdxIn[r1.1]: 246


       CCCCoooolllloooorrrrIIIIddddxxxxOOOOuuuutttt

       ColorIdxOut is the color index value of the graphical
       object (line...)  which color will change depending on the
       second value in the corresponding mrtg log file (oooouuuuttttggggooooiiiinnnngggg
       ttttrrrraaaaffffffffiiiicccc on a link).

       Examples:

        ColorIdxOut[ezwf]: 252
        net2*ColorIdxOut[r1.1]: 247


       MMMMaaaaxxxxRRRRaaaatttteeee

       MaxRate is the maximum possible value processed from the
       corresponding MRTG log file. Actually, it is the mmmmaaaaxxxxiiiimmmmuuuummmm
       ooooffff tttthhhheeee ttttwwwwoooo vvvvaaaalllluuuueeeessss.

       It is essential for computing the percentage which final
       color of ColorIdx depends on. Nowadays, there are 10



2000-10-25                     1.1                              4





CONFIG(1)                     picnet                    CONFIG(1)


       different colors (0-10 %, 10-20%, ...) but they can be
       modified before compiling in cfg.h and def.h.

       For a router interface, it is the maximum traffic rate on
       the link. By default, the value is in bytes per second.
       But you can specify it in bits per second by adding "bps"
       after the value.

       Examples:

        MaxRate[ezwf]: 64000 bps
        net1*MaxRate[r1.1]: 128000 bps


       MMMMaaaaxxxxRRRRaaaatttteeeeIIIInnnn

       MaxRateIn is the maximum possible value processed from the
       corresponding MRTG log file. Actually, it is the mmmmaaaaxxxxiiiimmmmuuuummmm
       ooooffff tttthhhheeee ffffiiiirrrrsssstttt vvvvaaaalllluuuueeee.

       It is essential for computing the percentage which final
       color of ColorIdxIn depends on.

       For a router interface, it is the maximum incoming traffic
       rate on the link. By default, the value is in bytes per
       second.  But you can specify it in bits per second by
       adding "bps" after the value.

       Examples:

        MaxRateIn[ezwf]: 128000 bps
        net1*MaxRateIn[temp]: 80


       MMMMaaaaxxxxRRRRaaaatttteeeeOOOOuuuutttt

       MaxRateOut is the maximum possible value processed from
       the corresponding MRTG log file. Actually, it is the
       mmmmaaaaxxxxiiiimmmmuuuummmm ooooffff tttthhhheeee sssseeeeccccoooonnnndddd vvvvaaaalllluuuueeee.

       It is essential for computing the percentage which final
       color of ColorIdxOut depends on.

       For a router interface, it is the maximum outgoing traffic
       rate on the link. By default, the value is in bytes per
       second.  But you can specify it in bits per second by
       adding "bps" after the value.

       Examples:

        MaxRateOut[ezwf]: 8000
        net2*MaxRateOut[r1.1]: 64000 bps





2000-10-25                     1.1                              5





CONFIG(1)                     picnet                    CONFIG(1)


       RRRRoooouuuunnnnddddssss

       With Rounds, you specify the number of MRTG intervals you
       want PicNet to average values on.

       Examples:

       Here, if MRTG is executed every 5 minutes for ezwf, you
       will display the average traffic on the last hour.

        Rounds[ezwf]: 12
        net2*Rounds[r1.1]: 12


       MMMMaaaappppRRRReeeecccctttt

       With MapRect, you can define a clickable rectangle on the
       image of your network to access an HTML MRTG stats page or
       a PicNet submap (see the next chapter).

       You must specify the X1,Y1,X2,Y2 where (X1,Y1) is the
       upper left corner of the clickable rectangle and (X2,Y2)
       is the lower right corner.

       For an object, you can define many MapRects (no limit
       other than memory). But these instructions will apply only
       if you specify HtmlTitle or HtmlPageHeader so that the
       HTML page will be created.

       Note that the linked HTML pages must be in the same
       directory as the PicNet map HTML page.

       Example:

       In this example, when you click into the rectangle defined
       by the corners (126,76) and (234,85) on the image, you
       will access the MRTG stats page for ezwf.

        MapRect[ezwf]: 126,76,234,85


       MMMMaaaappppPPPPoooollllyyyy

       With MapPoly, you can define a clickable polygon on the
       image of your network to access an HTML MRTG stats page or
       a PicNet submap (see the next chapter).

       You must specify the X1,Y1,X2,Y2,X3,Y3,...Xi,Yi where
       (Xi,Yi) are points of the polygon.

       Please, refer to the MapRect comments above.

       Example:




2000-10-25                     1.1                              6





CONFIG(1)                     picnet                    CONFIG(1)


       In this example, when you click into the polygon defined
       by the points (126,76), (234,85), (220,87) and (120,77) on
       the image, you will access the MRTG stats page for ezwf.

        net1*MapPoly[ezwf]: 126,76,234,85,220,87,120,77


LLLLIIIINNNNKKKKSSSS BBBBEEEETTTTWWWWEEEEEEEENNNN MMMMAAAAPPPPSSSS
       MMMMaaaappppCCCCoooolllloooorrrrIIIIddddxxxx

       MapColorIdx is the color index value of the specified
       submap which color will change depending on the mmmmaaaaxxxxiiiimmmmuuuummmm
       ccccoooolllloooorrrr vvvvaaaalllluuuueeee ooooffff aaaallllllll tttthhhheeee oooobbbbjjjjeeeeccccttttssss included in this submap.
       Obviously, the objects included in the submap can be MRTG
       targets or other submaps. So, you can define a tree
       hierarchy (as large as you want).

       TTTTaaaakkkkeeee ccccaaaarrrreeee nnnnooootttt ttttoooo ccccrrrreeeeaaaatttteeee llllooooooooppppssss wwwwhhhhiiiicccchhhh iiiissss nnnnoooonnnn----sssseeeennnnsssseeee !!!! PicNet
       does not check it.

       Examples:

        MapColorIdx[net2]: 250
        net2*MapColorIdx[net3]: 235
        net3*ColorIdx[ezwf]: 240


       MMMMaaaappppRRRReeeecccctttt

       With MapRect, you can define a clickable rectangle on the
       image of your network to access another PicNet map (or an
       HTML MRTG stats page).

       Please, refer to the description of MapRect above.

       You can create all the links you want between maps
       provided the HTML pages are in the same directory... There
       is no loop problem.

       Example:

       In this example, when you click into the rectangle defined
       by the corners (126,76) and (234,85) on the image of net1,
       you will access the map net2 and the reverse.

        net1*MapRect[net2]: 126,76,234,85
        net2*MapRect[net1]: 126,76,234,85


       MMMMaaaappppPPPPoooollllyyyy

       With MapPoly, you can define a clickable polygon on the
       image of your network to access an other PicNet map (or an
       HTML MRTG stats page).



2000-10-25                     1.1                              7





CONFIG(1)                     picnet                    CONFIG(1)


       Please, refer to the description of MapPoly above.

       You can create all the links you want between maps
       provided the HTML pages are in the same directory... There
       is no loop problem.

       Example:

       In this example, when you click into the polygon defined
       by the points (126,76), (234,85), (220,87) and (120,77) on
       the image, you will access the map net1.

        MapPoly[net1]: 126,76,234,85,220,87,120,77


AAAAUUUUTTTTHHHHOOOORRRR
       Laurent Derrien, <derrien@canl.nc>

       9.9.99 (last update 10.24.00)






































2000-10-25                     1.1                              8


