hotsanic

Subversion Repositories:
[/] [branches/] [HotSaNIC-0.5.0-pre6/] [Documentation/] [module-options.txt] - Rev 23 Go to most recent revision
Compare with Previous - Blame - Download
In addition to the module specific options which can be configured in each
module's "settings" file, There are some common module options available (>=
0.5.0-pre6) which allow some fine-tuning.

There are options beginning with "GRAPH_" which will alter the graph's
standard layout and options which will alter the graph's coloring, which will
begin with "COLOR_". The latter sometimes have module dependent names.

These are not global options! They are just available in every module and
configure the layout all diagrams created by the specific module.

The graph options are:

GRAPH_MAX
--------------------
This configures the _initial_ maximum value. If the graph will overshoot this
value, it will automatically be scaled. This behaviour may be switched off by
setting "GRAPH_RIGID" to something true (1 / yes / true).


GRAPH_MIN
--------------------
This configures the initial minimum value. Usually it's "0", sometimes it's
negative (which forbids logarithmic graphs - see GRAPH_STYLE)


GRAPH_MIN_LOG
--------------------
This configures the minimum value in logarithmic mode. It may not be zero or
negative!


GRAPH_RIGID
--------------------
When set to something true, the initial borders configured with "GRAPH_MIN"
and "GRAPH_MAX" will be fixed borders, no matter if the graph overshoots these
borders.
This option does not depend on any other option.


GRAPH_STYLE
--------------------
This is usually set to "lin" or "linear".
You may  set this to "log" or "logarithmic" to greate graphs with a
logarithmic scale on the data axis (Y-axis). This is of course impossible with
graphs that contain values below zero. When log style is enabled, the minimum
value to be used will be "GRAPH_MIN_LOG" instead of "GRAPH_MIN" (which might
be accidentally set to zero, producing errors.


GRAPH_UNIT
--------------------
This defines the scientific base unit for 1k. Usually this is set to 1000 -
except for byte values, which usually use a unit of 1024.


GRAPH_BASE
--------------------
This item may be set to:
 - "percent"  graphing values as "%" (factor 100)
 - "bytes"    graphing byte values as "bytes"
 - "bits"     graphing byte values as "bits" (factor 8)
 - "ms"       graphing time values as "milliseconds" (factor 1.000)
 - "us"       graphing time values as "microseconds" (factor 1.000.000)
set it to something else to use unscaled values



The most frequently used color options are:

COLOR_LINE    for general line coloring
COLOR_AREA    for general area coloring
COLOR_MINMAX  for delta area coloring
COLOR_BORDER  for delta area borders

There are many more color options which depend on th emodules. Please take a
look at the module documentations for detailed descriptions of these options.

Generally, all color options contain a hexadecimal value containing the red,
green and blue portions, these are in the format: "RRGGBB". For example a
saturated red will be "ff0000" while a saturated blue is "0000ff".