| 1 | 1 | simandl | In addition to the module specific options which can be configured in each |
| 2 | | | module's "settings" file, There are some common module options available (>= |
| 3 | | | 0.5.0-pre6) which allow some fine-tuning. |
| 4 | | | |
| 5 | | | There are options beginning with "GRAPH_" which will alter the graph's |
| 6 | | | standard layout and options which will alter the graph's coloring, which will |
| 7 | | | begin with "COLOR_". The latter sometimes have module dependent names. |
| 8 | | | |
| 9 | | | These are not global options! They are just available in every module and |
| 10 | | | configure the layout all diagrams created by the specific module. |
| 11 | | | |
| 12 | | | The graph options are: |
| 13 | | | |
| 14 | | | GRAPH_MAX |
| 15 | | | -------------------- |
| 16 | | | This configures the _initial_ maximum value. If the graph will overshoot this |
| 17 | | | value, it will automatically be scaled. This behaviour may be switched off by |
| 18 | | | setting "GRAPH_RIGID" to something true (1 / yes / true). |
| 19 | | | |
| 20 | | | |
| 21 | | | GRAPH_MIN |
| 22 | | | -------------------- |
| 23 | | | This configures the initial minimum value. Usually it's "0", sometimes it's |
| 24 | | | negative (which forbids logarithmic graphs - see GRAPH_STYLE) |
| 25 | | | |
| 26 | | | |
| 27 | | | GRAPH_MIN_LOG |
| 28 | | | -------------------- |
| 29 | | | This configures the minimum value in logarithmic mode. It may not be zero or |
| 30 | | | negative! |
| 31 | | | |
| 32 | | | |
| 33 | | | GRAPH_RIGID |
| 34 | | | -------------------- |
| 35 | | | When set to something true, the initial borders configured with "GRAPH_MIN" |
| 36 | | | and "GRAPH_MAX" will be fixed borders, no matter if the graph overshoots these |
| 37 | | | borders. |
| 38 | | | This option does not depend on any other option. |
| 39 | | | |
| 40 | | | |
| 41 | | | GRAPH_STYLE |
| 42 | | | -------------------- |
| 43 | | | This is usually set to "lin" or "linear". |
| 44 | | | You may set this to "log" or "logarithmic" to greate graphs with a |
| 45 | | | logarithmic scale on the data axis (Y-axis). This is of course impossible with |
| 46 | | | graphs that contain values below zero. When log style is enabled, the minimum |
| 47 | | | value to be used will be "GRAPH_MIN_LOG" instead of "GRAPH_MIN" (which might |
| 48 | | | be accidentally set to zero, producing errors. |
| 49 | | | |
| 50 | | | |
| 51 | | | GRAPH_UNIT |
| 52 | | | -------------------- |
| 53 | | | This defines the scientific base unit for 1k. Usually this is set to 1000 - |
| 54 | | | except for byte values, which usually use a unit of 1024. |
| 55 | | | |
| 56 | | | |
| 57 | | | GRAPH_BASE |
| 58 | | | -------------------- |
| 59 | | | This item may be set to: |
| 60 | | | - "percent" graphing values as "%" (factor 100) |
| 61 | | | - "bytes" graphing byte values as "bytes" |
| 62 | | | - "bits" graphing byte values as "bits" (factor 8) |
| 63 | | | - "ms" graphing time values as "milliseconds" (factor 1.000) |
| 64 | | | - "us" graphing time values as "microseconds" (factor 1.000.000) |
| 65 | | | set it to something else to use unscaled values |
| 66 | | | |
| 67 | | | |
| 68 | | | |
| 69 | | | The most frequently used color options are: |
| 70 | | | |
| 71 | | | COLOR_LINE for general line coloring |
| 72 | | | COLOR_AREA for general area coloring |
| 73 | | | COLOR_MINMAX for delta area coloring |
| 74 | | | COLOR_BORDER for delta area borders |
| 75 | | | |
| 76 | | | There are many more color options which depend on th emodules. Please take a |
| 77 | | | look at the module documentations for detailed descriptions of these options. |
| 78 | | | |
| 79 | | | Generally, all color options contain a hexadecimal value containing the red, |
| 80 | | | green and blue portions, these are in the format: "RRGGBB". For example a |
| 81 | | | saturated red will be "ff0000" while a saturated blue is "0000ff". |
| 82 | | | |
