X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdgraph_graph.pod;h=c7ca4fa2b96983283249a50be04e1fa38d02e034;hb=65878d5b2342b37186d9557f314e8a37dbc86de2;hp=7e3aaf2c47b910045b4d21a9d9b9710fa2b84a7d;hpb=324d0ab730bd682d6561576dd85d46c9fb99afa7;p=rrdtool.git diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod index 7e3aaf2..c7ca4fa 100644 --- a/doc/rrdgraph_graph.pod +++ b/doc/rrdgraph_graph.pod @@ -24,19 +24,12 @@ BB<:>IB<#>I[I][B<:>I[B<:>I]] BB<:>IB<:>I -=cut - -# -#BB<:>IB<#>I[I][B<:>I] -# - -=pod +BB<:>{B|B|B|B
} BB<:>IB<:>IB<:>I (deprecated) BB<:>IB<:>IB<:>I (deprecated) - BB<:>IB<#>I[B<:>I] (deprecated) =head1 DESCRIPTION @@ -50,7 +43,7 @@ Similarly, no report is generated if you don't use print options. =over 4 -=item BIB<:>I +=item BIB<:>I[B<:strftime>] Depending on the context, either the value component or the time component of a B is printed using I. It is an error @@ -64,29 +57,29 @@ For printing values: =over 4 -=item * +=item B<%%> -B<%%> just prints a literal '%' character +just prints a literal '%' character -=item * +=item B<%#.#le> -B<%#.#le> prints numbers like 1.2346e+04. The optional integers # denote field +prints numbers like 1.2346e+04. The optional integers # denote field width and decimal precision. -=item * +=item B<%#.#lf> -B<%#.#lf> prints numbers like 12345.6789, with optional field width +prints numbers like 12345.6789, with optional field width and precision. -=item * +=item B<%s> -B<%s> place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the +place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the appropriate SI magnitude unit and the value will be scaled accordingly (123456 -> 123.456 k). -=item * +=item B<%S> -B<%S> is similar to B<%s>. It does, however, use a previously defined +is similar to B<%s>. It does, however, use a previously defined magnitude unit. If there is no such unit yet, it tries to define one (just like B<%s>) unless the value is zero, in which case the magnitude unit stays undefined. Thus, formatter strings using B<%S> and no B<%s> @@ -94,55 +87,115 @@ will all use the same magnitude unit except for zero values. =back -For printing times: +If you PRINT a VDEF value, you can also print the time associated with it by appending the string +B<: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. =over 4 -=item * +=item B<%a> + +The abbreviated weekday name according to the current locale. + +=item B<%A> + +The full weekday name according to the current locale. + +=item B<%b> + +The abbreviated month name according to the current locale. + +=item B<%B> + +The full month name according to the current locale. + +=item B<%c> + +The preferred date and time representation for the current locale. + +=item B<%d> + +The day of the month as a decimal number (range 01 to 31). -B<%%> just prints a literal '%' character +=item B<%H> -=item * +The hour as a decimal number using a 24-hour clock (range 00 to 23). -B<%a, %A> print the abbreviated or full name of the day of the week. +=item B<%I> -=item * +The hour as a decimal number using a 12-hour clock (range 01 to 12). -B<%b, %B> print the abbreviated or full name of the month. +=item B<%j> -=item * +The day of the year as a decimal number (range 001 to 366). -B<%d, %m, %y, %H, %M, %S> print day, month, year, hour, minute, and -second in two-digit format. +=item B<%m> -=item * +The month as a decimal number (range 01 to 12). -B<%Y> prints the year in 4-digit format. +=item B<%M> -=item * +The minute as a decimal number (range 00 to 59). -B<%I, %p> print the hour (01..12), 'am' or 'pm'. +=item B<%p> -=item * +Either `AM' or `PM' 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 %p will return an empty string. -B<%j, %w> print day of the week (0..6), day of the year (1..366) +=item B<%S> -=item * +The second as a decimal number (range 00 to 61). -B<%c, %x, %X> print date+time, date only, time only. +=item B<%U> -=item * +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. -B<%U, %W> number of the week of the current year, with either the -first Sunday (%U) or the first Monday (%W) determining the first week. +=item B<%V> -=item * +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. -B<%Z> prints the time zone. +=item B<%w> + +The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u. + +=item B<%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. + +=item B<%x> + +The preferred date representation for the current locale without the time. + +=item B<%X> + +The preferred time representation for the current locale without the date. + +=item B<%y> + +The year as a decimal number without a century (range 00 to 99). + +=item B<%Y> + +The year as a decimal number including the century. + +=item B<%Z> + +The time zone or name or abbreviation. + +=item B<%%> + +A literal `%' character. =back -=item BIB<:>I<:>I +=item BIB<:>IB<:>I I The first form of this command is to be used with B Is. @@ -219,6 +272,14 @@ 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. +=item BB<:>{B|B|B|B
} + +Labels are placed below the graph. When they overflow to the left, they wrap +to the next line. By default, lines are justified left and right. The +B function lets you change this default. This is a command and +not an option, so that you can change the default several times in your +argument list. + =cut # This section describes the curruently defunct @@ -284,6 +345,9 @@ Valid markers are: B<\j> for justified, B<\l> for left aligned, B<\r> for right aligned, and B<\c> for centered. In the next section there is an example showing how to use centered formatting. +B<\n> is a valid alias for B<\l> since incomplete parsing in earlier +versions of rrdtool lead to this behaviour and a number of people has been using it. + Normally there are two space characters inserted between every two items printed into the graph. The space following a string can be suppressed by putting a B<\g> at the end of the string. The B<\g> also ignores any space