![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_graph.1 b/doc/rrdgraph_graph.1
index 6222d6c826f19aa6095004f0c98bcd32f0a12bc7..fddaa85c2dd5f1dda0fe6fd949695a65e07e3ab8 100644 (file)
--- a/doc/rrdgraph_graph.1
+++ b/doc/rrdgraph_graph.1
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.08)
.\"
.\" Standard preamble:
.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds R" ''
'br\}
.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+. de IX
+..
+.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
.\" ========================================================================
.\"
.IX Title "RRDGRAPH_GRAPH 1"
-.TH RRDGRAPH_GRAPH 1 "2009-02-21" "1.3.99909060808" "rrdtool"
+.TH RRDGRAPH_GRAPH 1 "2009-05-10" "1.3.999" "rrdtool"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
.SH "NAME"
rrdgraph_graph \- rrdtool graph command reference
.SH "SYNOPSIS"
These instructions allow you to generate your image or report.
If you don't use any graph elements, no graph is generated.
Similarly, no report is generated if you don't use print options.
-.Sh "\s-1PRINT\s0"
+.SS "\s-1PRINT\s0"
.IX Subsection "PRINT"
\fI\f(BI\s-1PRINT:\s0\fI\fIvname\fI\f(BI:\fI\fIformat\fI[\f(BI:strftime\fI]\fR
.IX Subsection "PRINT:vname:format[:strftime]"
.IX Item "%#.#lf"
prints numbers like 12345.6789, with optional field width
and precision.
-.IP "\fB%s\fR" 4
+.ie n .IP "\fB\fB%s\fB\fR" 4
+.el .IP "\fB\f(CB%s\fB\fR" 4
.IX Item "%s"
-place this after \fB%le\fR, \fB%lf\fR or \fB%lg\fR. This will be replaced by the
+place this after \fB\f(CB%le\fB\fR, \fB\f(CB%lf\fB\fR or \fB\f(CB%lg\fB\fR. This will be replaced by the
appropriate \s-1SI\s0 magnitude unit and the value will be scaled
accordingly (123456 \-> 123.456 k).
-.IP "\fB%S\fR" 4
+.ie n .IP "\fB\fB%S\fB\fR" 4
+.el .IP "\fB\f(CB%S\fB\fR" 4
.IX Item "%S"
-is similar to \fB%s\fR. It does, however, use a previously defined
+is similar to \fB\f(CB%s\fB\fR. It does, however, use a previously defined
magnitude unit. If there is no such unit yet, it tries to define
-one (just like \fB%s\fR) unless the value is zero, in which case the magnitude
-unit stays undefined. Thus, formatter strings using \fB%S\fR and no \fB%s\fR
+one (just like \fB\f(CB%s\fB\fR) unless the value is zero, in which case the magnitude
+unit stays undefined. Thus, formatter strings using \fB\f(CB%S\fB\fR and no \fB\f(CB%s\fB\fR
will all use the same magnitude unit except for zero values.
.PP
If you \s-1PRINT\s0 a \s-1VDEF\s0 value, you can also print the time associated with it by appending the string
\&\fB:strftime\fR to the format. Note that rrdtool uses the strftime function of your OSs C library. 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.
-.IP "\fB%a\fR" 4
+conversion specifiers usually supported across the board.
+.ie n .IP "\fB\fB%a\fB\fR" 4
+.el .IP "\fB\f(CB%a\fB\fR" 4
.IX Item "%a"
The abbreviated weekday name according to the current locale.
-.IP "\fB%A\fR" 4
+.ie n .IP "\fB\fB%A\fB\fR" 4
+.el .IP "\fB\f(CB%A\fB\fR" 4
.IX Item "%A"
The full weekday name according to the current locale.
-.IP "\fB%b\fR" 4
+.ie n .IP "\fB\fB%b\fB\fR" 4
+.el .IP "\fB\f(CB%b\fB\fR" 4
.IX Item "%b"
The abbreviated month name according to the current locale.
-.IP "\fB%B\fR" 4
+.ie n .IP "\fB\fB%B\fB\fR" 4
+.el .IP "\fB\f(CB%B\fB\fR" 4
.IX Item "%B"
The full month name according to the current locale.
-.IP "\fB%c\fR" 4
+.ie n .IP "\fB\fB%c\fB\fR" 4
+.el .IP "\fB\f(CB%c\fB\fR" 4
.IX Item "%c"
The preferred date and time representation for the current locale.
-.IP "\fB%d\fR" 4
+.ie n .IP "\fB\fB%d\fB\fR" 4
+.el .IP "\fB\f(CB%d\fB\fR" 4
.IX Item "%d"
The day of the month as a decimal number (range 01 to 31).
-.IP "\fB%H\fR" 4
+.ie n .IP "\fB\fB%H\fB\fR" 4
+.el .IP "\fB\f(CB%H\fB\fR" 4
.IX Item "%H"
The hour as a decimal number using a 24\-hour clock (range 00 to 23).
-.IP "\fB%I\fR" 4
+.ie n .IP "\fB\fB%I\fB\fR" 4
+.el .IP "\fB\f(CB%I\fB\fR" 4
.IX Item "%I"
The hour as a decimal number using a 12\-hour clock (range 01 to 12).
-.IP "\fB%j\fR" 4
+.ie n .IP "\fB\fB%j\fB\fR" 4
+.el .IP "\fB\f(CB%j\fB\fR" 4
.IX Item "%j"
The day of the year as a decimal number (range 001 to 366).
-.IP "\fB%m\fR" 4
+.ie n .IP "\fB\fB%m\fB\fR" 4
+.el .IP "\fB\f(CB%m\fB\fR" 4
.IX Item "%m"
The month as a decimal number (range 01 to 12).
-.IP "\fB%M\fR" 4
+.ie n .IP "\fB\fB%M\fB\fR" 4
+.el .IP "\fB\f(CB%M\fB\fR" 4
.IX Item "%M"
The minute as a decimal number (range 00 to 59).
-.IP "\fB%p\fR" 4
+.ie n .IP "\fB\fB%p\fB\fR" 4
+.el .IP "\fB\f(CB%p\fB\fR" 4
.IX Item "%p"
Either `\s-1AM\s0' or `\s-1PM\s0' according to the given time value, or the corresponding
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 \f(CW%p\fR will return an empty string.
-.IP "\fB%s\fR" 4
+.ie n .IP "\fB\fB%s\fB\fR" 4
+.el .IP "\fB\f(CB%s\fB\fR" 4
.IX Item "%s"
The second as a decimal number (range 00 to 61).
-.IP "\fB%S\fR" 4
+.ie n .IP "\fB\fB%S\fB\fR" 4
+.el .IP "\fB\f(CB%S\fB\fR" 4
.IX Item "%S"
The seconds since the epoch (1.1.1970) (libc dependant non standard!)
-.IP "\fB%U\fR" 4
+.ie n .IP "\fB\fB%U\fB\fR" 4
+.el .IP "\fB\f(CB%U\fB\fR" 4
.IX Item "%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 \f(CW%V\fR and \f(CW%W\fR.
-.IP "\fB%V\fR" 4
+.ie n .IP "\fB\fB%V\fB\fR" 4
+.el .IP "\fB\f(CB%V\fB\fR" 4
.IX Item "%V"
The \s-1ISO\s0 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 \f(CW%U\fR and \f(CW%W\fR.
-.IP "\fB%w\fR" 4
+.ie n .IP "\fB\fB%w\fB\fR" 4
+.el .IP "\fB\f(CB%w\fB\fR" 4
.IX Item "%w"
The day of the week as a decimal, range 0 to 6, Sunday being 0. See also \f(CW%u\fR.
-.IP "\fB%W\fR" 4
+.ie n .IP "\fB\fB%W\fB\fR" 4
+.el .IP "\fB\f(CB%W\fB\fR" 4
.IX Item "%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.
-.IP "\fB%x\fR" 4
+.ie n .IP "\fB\fB%x\fB\fR" 4
+.el .IP "\fB\f(CB%x\fB\fR" 4
.IX Item "%x"
The preferred date representation for the current locale without the time.
-.IP "\fB%X\fR" 4
+.ie n .IP "\fB\fB%X\fB\fR" 4
+.el .IP "\fB\f(CB%X\fB\fR" 4
.IX Item "%X"
The preferred time representation for the current locale without the date.
-.IP "\fB%y\fR" 4
+.ie n .IP "\fB\fB%y\fB\fR" 4
+.el .IP "\fB\f(CB%y\fB\fR" 4
.IX Item "%y"
The year as a decimal number without a century (range 00 to 99).
-.IP "\fB%Y\fR" 4
+.ie n .IP "\fB\fB%Y\fB\fR" 4
+.el .IP "\fB\f(CB%Y\fB\fR" 4
.IX Item "%Y"
The year as a decimal number including the century.
-.IP "\fB%Z\fR" 4
+.ie n .IP "\fB\fB%Z\fB\fR" 4
+.el .IP "\fB\f(CB%Z\fB\fR" 4
.IX Item "%Z"
The time zone or name or abbreviation.
.IP "\fB%%\fR" 4
.PP
\&\fIDeprecated. Use the new form of this command in new scripts.\fR
The first form of this command is to be used with \fB\s-1CDEF\s0\fR \fIvname\fRs.
-.Sh "\s-1GRAPH\s0"
+.SS "\s-1GRAPH\s0"
.IX Subsection "GRAPH"
\fI\f(BI\s-1GPRINT\s0\fI\f(BI:\fI\fIvname\fI\f(BI:\fI\fIformat\fI\fR
.IX Subsection "GPRINT:vname:format"
@@ -409,14 +433,14 @@ make sure never to stack upon the unknown value. Use a \s-1CDEF\s0 instruction
with \fB\s-1IF\s0\fR and \fB\s-1UN\s0\fR to do so.
.SH "NOTES on legend arguments"
.IX Header "NOTES on legend arguments"
-.Sh "Escaping the colon"
+.SS "Escaping the colon"
.IX Subsection "Escaping the colon"
A colon ':' in a \fIlegend\fR argument will mark the end of the
legend. To enter a ':' as part of a legend, the colon must be escaped
with a backslash '\e:'. Beware that many environments process
backslashes themselves, so it may be necessary to write two
backslashes in order to one being passed onto rrd_graph.
-.Sh "String Formatting"
+.SS "String Formatting"
.IX Subsection "String Formatting"
The text printed below the actual graph can be formatted by appending special
escape characters at the end of a text. When ever such a character occurs,
printed into the graph. The space following a string can be suppressed by
putting a \fB\eg\fR at the end of the string. The \fB\eg\fR also ignores any space
inside the string if it is at the very end of the string. This can be used
-in connection with \fB%s\fR to suppress empty unit strings.
+in connection with \fB\f(CB%s\fB\fR to suppress empty unit strings.
.PP
.Vb 1
\& GPRINT:a:MAX:%lf%s\eg
Since RRDtool 1.3 is using Pango for rending text, you can use Pango markup.
Pango uses the xml \fBspan\fR tags for inline formatting instructions.:
.PP
-A simple example of a marked-up string might be:
+A simple example of a marked-up string might be:
.PP
.Vb 1
\& <span foreground="blue" size="x\-large">Blue text</span> is <i>cool</i>!
Monospace font
.IP "\fBu\fR" 4
.IX Item "u"
-Underline
+Underline
.SH "SEE ALSO"
.IX Header "SEE ALSO"
rrdgraph gives an overview of how \fBrrdtool graph\fR works.