X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.html;h=089851538e576f408918560b1b05291df38a1a47;hb=8892808f3a79ec485e273390213ef3f16792eb54;hp=d53067015a9be7f28148b9c5d795553038744ed8;hpb=ba531669d795b10244c358135249016c5898519b;p=pkg-rrdtool.git diff --git a/doc/rrdgraph_graph.html b/doc/rrdgraph_graph.html index d530670..0898515 100644 --- a/doc/rrdgraph_graph.html +++ b/doc/rrdgraph_graph.html @@ -67,51 +67,42 @@ Similarly, no report is generated if you don't use print options.

PRINT

-
PRINT:vname:format[:strftime] +
PRINT:vname:format[:strftime]

Depending on the context, either the value component or the time component of a VDEF is printed using format. It is an error to specify a vname generated by a DEF or CDEF.

-
-

Any text in format is printed literally with one exception: The percent character introduces a formatter string. This string can be:

-
-

For printing values:

-
-
%% +
%%

just prints a literal '%' character

- -
%#.#le +
%#.#le

prints numbers like 1.2346e+04. The optional integers # denote field width and decimal precision.

- -
%#.#lf +
%#.#lf

prints numbers like 12345.6789, with optional field width and precision.

- -
%s +
%s

place this after %le, %lf or %lg. This will be replaced by the appropriate SI magnitude unit and the value will be scaled accordingly (123456 -> 123.456 k).

- -
%S +
%S

is similar to %s. It does, however, use a previously defined @@ -120,80 +111,68 @@ one (just like %s) unless the value is zero, in which case the unit stays undefined. Thus, formatter strings using %S and no %s will all use the same magnitude unit except for zero values.

-

If you PRINT a VDEF value, you can also print the time associated with it by appending the string :strftime to the format. Note that rrdtool uses the strftime function of your OSs clibrary. This means that the conversion specifier may vary. Check the manual page if you are uncertain. The following is a list of conversion specifiers usually supported across the board.

-
%a +
%a

The abbreviated weekday name according to the current locale.

- -
%A +
%A

The full weekday name according to the current locale.

- -
%b +
%b

The abbreviated month name according to the current locale.

- -
%B +
%B

The full month name according to the current locale.

- -
%c +
%c

The preferred date and time representation for the current locale.

- -
%d +
%d

The day of the month as a decimal number (range 01 to 31).

- -
%H +
%H

The hour as a decimal number using a 24-hour clock (range 00 to 23).

- -
%I +
%I

The hour as a decimal number using a 12-hour clock (range 01 to 12).

- -
%j +
%j

The day of the year as a decimal number (range 001 to 366).

- -
%m +
%m

The month as a decimal number (range 01 to 12).

- -
%M +
%M

The minute as a decimal number (range 00 to 59).

- -
%p +
%p

Either `AM' or `PM' according to the given time value, or the corresponding @@ -201,113 +180,98 @@ strings for the current locale. Noon is treated as `pm' and midnight as `am'. Note that in many locales and `pm' notation is unsupported and in such cases %p will return an empty string.

- -
%S +
%S

The second as a decimal number (range 00 to 61).

- -
%U +
%U

The week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. See also %V and %W.

- -
%V +
%V

The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week. See also %U and %W.

- -
%w +
%w

The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.

- -
%W +
%W

The week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.

- -
%x +
%x

The preferred date representation for the current locale without the time.

- -
%X +
%X

The preferred time representation for the current locale without the date.

- -
%y +
%y

The year as a decimal number without a century (range 00 to 99).

- -
%Y +
%Y

The year as a decimal number including the century.

- -
%Z +
%Z

The time zone or name or abbreviation.

- -
%% +
%%

A literal `%' character.

-
-
PRINT:vname:CF:format + +
PRINT:vname:CF:format

Deprecated. Use the new form of this command in new scripts. The first form of this command is to be used with CDEF vnames.

-

GRAPH

-
GPRINT:vname:format +
GPRINT:vname:format

This is the same as PRINT, but printed inside the graph.

- -
GPRINT:vname:CF:format +
GPRINT:vname:CF:format

Deprecated. Use the new form of this command in new scripts. This is the same as PRINT, but printed inside the graph.

- -
COMMENT:text +
COMMENT:text

Text is printed literally in the legend section of the graph. Note that in RRDtool 1.2 you have to escape colons in COMMENT text in the same way you have to escape them in *PRINT commands by writing '\:'.

- -
VRULE:time#color[:legend][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]] +
VRULE:time#color[:legend][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]]

Draw a vertical line at time. Its color is composed from three @@ -318,16 +282,14 @@ from a VDEF. It is an error to use vnames from dashes modifier. See LINE for more details.

- -
HRULE:value#color[:legend][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]] +
HRULE:value#color[:legend][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]]

Draw a horizontal line at value. HRULE acts much like LINE except that will have no effect on the scale of the graph. If a HRULE is outside the graphing area it will just not be visible.

- -
LINE[width]:value[#color][:[legend][:STACK]][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]] +
LINE[width]:value[#color][:[legend][:STACK]][:dashes[=on_s[,off_s[,on_s,off_s]...]][:dash-offset=offset]]

Draw a line of the specified width onto the graph. width can be a @@ -338,8 +300,6 @@ the legend section if specified. The value can be generated by VDEF, and CDEF. If the optional STACK modifier is used, this line is stacked on top of the previous element which can be a LINE or an AREA.

-
-

The dashes modifier enables dashed line style. Without any further options a symmetric dashed line with a segment length of 5 pixels will be drawn. The dash pattern can be changed if the dashes= parameter is followed by either @@ -347,20 +307,16 @@ one value or an even number (1, 2, 4, 6, ...) of positive values. Each value provides the length of alternate on_s and off_s portions of the stroke. The dash-offset parameter specifies an offset into the pattern at which the stroke begins.

-
-

When you do not specify a color, you cannot specify a legend. Should you want to use STACK, use the ``LINEx:<value>::STACK'' form.

- -
AREA:value[#color][:[legend][:STACK]] +
AREA:value[#color][:[legend][:STACK]]

See LINE, however the area between the x-axis and the line will be filled.

- -
TICK:vname#rrggbb[aa][:fraction[:legend]] +
TICK:vname#rrggbb[aa][:fraction[:legend]]

Plot a tick mark (a vertical line) for each value of vname that is @@ -370,8 +326,7 @@ the axis). Note that the color specification is not optional. The TICK marks nor start at the lower edge of the graphing area. If the fraction is negative they start at the upper border of the graphing area.

- -
SHIFT:vname:offset +
SHIFT:vname:offset

Using this command RRDtool will graph the following elements @@ -381,8 +336,7 @@ week. Make sure to tell the viewer of your graph you did this ... As with the other graphing elements, you can specify a number or a variable here.

- -
TEXTALIGN:{left|right|justified|center} +
TEXTALIGN:{left|right|justified|center}

Labels are placed below the graph. When they overflow to the left, they wrap @@ -391,13 +345,11 @@ to the next line. By default, lines are justified left and right. The not an option, so that you can change the default several times in your argument list.

- -
STACK:vname#color[:legend] +
STACK:vname#color[:legend]

Deprecated. Use the STACK modifiers on the other commands.

-

Some notes on stacking

When stacking, an element is not placed above the X-axis but rather @@ -454,183 +406,154 @@ Pango uses the xml span tags for inline formatting instructions <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!

The complete list of attributes for the span tag (taken from the pango documentation):

-
font_desc +
font_desc

A font description string, such as ``Sans Italic 12''; note that any other span attributes will override this description. So if you have ``Sans Italic'' and also a style=``normal'' attribute, you will get Sans normal, not italic.

- -
font_family +
font_family

A font family name

- -
face +
face

Synonym for font_family

- -
size +
size

Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If you want to specify a absolute size, it's usually easier to take advantage of the ability to specify a partial font description using 'font_desc'; you can use font_desc='12.5' rather than size='12800'.

- -
style +
style

One of 'normal', 'oblique', 'italic'

- -
weight +
weight

One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight

- -
variant +
variant

'normal' or 'smallcaps'

- -
stretch +
stretch

One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'

- -
foreground +
foreground

An RGB color specification such as '#00FF00' or a color name such as 'red'

- -
background +
background

An RGB color specification such as '#00FF00' or a color name such as 'red'

- -
underline +
underline

One of 'none', 'single', 'double', 'low', 'error'

- -
underline_color +
underline_color

The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'

- -
rise +
rise

Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.

- -
strikethrough +
strikethrough

'true' or 'false' whether to strike through the text

- -
strikethrough_color +
strikethrough_color

The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'

- -
fallback +
fallback

'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.

- -
lang +
lang

A language code, indicating the text language

- -
letter_spacing +
letter_spacing

Inter-letter spacing in 1024ths of a point.

- -
gravity +
gravity

One of 'south', 'east', 'north', 'west', 'auto'.

- -
gravity_hint +
gravity_hint

One of 'natural', 'strong', 'line'.

-

To save you some typing, there are also some shortcuts:

-
b +
b

Bold

- -
big +
big

Makes font relatively larger, equivalent to <span size=``larger''>

- -
i +
i

Italic

- -
s +
s

Strikethrough

- -
sub +
sub

Subscript

- -
sup +
sup

Superscript

- -
small +
small

Makes font relatively smaller, equivalent to <span size=``smaller''>

- -
tt +
tt

Monospace font

- -
u +
u

Underline

-