Code

Imported upstream version 1.2.27
[pkg-rrdtool.git] / doc / rrdgraph_graph.txt
index f024a06ba14c6d7dd53135f460d6b214938ee1fb..800dcca6e79b3e6ad018559caaec01b2486793f8 100644 (file)
@@ -35,7 +35,9 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        don't use any graph elements, no graph is generated.  Similarly, no
        report is generated if you don't use print options.
 
-P\bPR\bRI\bIN\bNT\bT
+       P\bPR\bRI\bIN\bNT\bT
+
+
        P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt[:\b:s\bst\btr\brf\bft\bti\bim\bme\be]
            Depending on the context, either the value component or the time
            component of a V\bVD\bDE\bEF\bF is printed using _\bf_\bo_\br_\bm_\ba_\bt. It is an error to
@@ -47,26 +49,24 @@ P\bPR\bRI\bIN\bNT\bT
 
            For printing values:
 
-           %\b%%\b%  just prints a literal '%' character
+           %\b%%\b- just prints a literal '%' character
 
-           %\b%#\b#.\b.#\b#l\ble\be
-               prints numbers like 1.2346e+04. The optional integers # denote
-               field width and decimal precision.
+           %\b%#\b#.\b.#\b#l\ble\be - prints numbers like 1.2346e+04. The optional integers #
+           denote field width and decimal precision.
 
-           %\b%#\b#.\b.#\b#l\blf\bf
-               prints numbers like 12345.6789, with optional field width and
-               precision.
+           %\b%#\b#.\b.#\b#l\blf\bf - prints numbers like 12345.6789, with optional field width
+           and precision.
 
-           %\b%s\bs  place this after %\b%l\ble\be, %\b%l\blf\bf or %\b%l\blg\bg. This will be replaced by the
-               appropriate SI magnitude unit and the value will be scaled
-               accordingly (123456 -> 123.456 k).
+           %\b%s\b- place this after %\b%l\ble\be, %\b%l\blf\bf or %\b%l\blg\bg. This will be replaced by the
+           appropriate SI magnitude unit and the value will be scaled accord-
+           ingly (123456 -> 123.456 k).
 
-           %\b%S\bS  is similar to %\b%s\bs. 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\bs) unless the value is zero, in which
-               case the magnitude unit stays undefined. Thus, formatter
-               strings using %\b%S\bS and no %\b%s\bs will all use the same magnitude unit
-               except for zero values.
+           %\b%S\b- is similar to %\b%s\bs. 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\bs) unless the value is zero, in which case the
+           magnitude unit stays undefined. Thus, formatter strings using %\b%S\bS
+           and no %\b%s\bs will all use the same magnitude unit except for zero val-
+           ues.
 
            If you PRINT a VDEF value, you can also print the time associated
            with it by appending the string :\b:s\bst\btr\brf\bft\bti\bim\bme\be to the format. Note that
@@ -75,75 +75,77 @@ P\bPR\bRI\bIN\bNT\bT
            you are uncertain. The following is a list of conversion specifiers
            usually supported across the board.
 
-           %\b%a\ba  The abbreviated weekday name according to the current locale.
+           %\b%a\b- The abbreviated weekday name according to the current locale.
 
-           %\b%A\bA  The full weekday name according to the current locale.
+           %\b%A\b- The full weekday name according to the current locale.
 
-           %\b%b\bb  The abbreviated month name according to the current locale.
+           %\b%b\b- The abbreviated month name according to the current locale.
 
-           %\b%B\bB  The full month name according to the current locale.
+           %\b%B\b- The full month name according to the current locale.
 
-           %\b%c\bc  The preferred date and time representation for the current
-               locale.
+           %\b%c\b- The preferred date and time representation for the current
+           locale.
 
-           %\b%d\bd  The day of the month as a decimal number (range 01 to 31).
+           %\b%d\b- The day of the month as a decimal number (range 01 to 31).
 
-           %\b%H\b The hour as a decimal number using a 24-hour clock (range 00 to
-               23).
+           %\b%H\b- The hour as a decimal number using a 24-hour clock (range 00
+           to 23).
 
-           %\b%I\b The hour as a decimal number using a 12-hour clock (range 01 to
-               12).
+           %\b%I\b- The hour as a decimal number using a 12-hour clock (range 01
+           to 12).
 
-           %\b%j\bj  The day of the year as a decimal number (range 001 to 366).
+           %\b%j\b- The day of the year as a decimal number (range 001 to 366).
 
-           %\b%m\bm  The month as a decimal number (range 01 to 12).
+           %\b%m\b- The month as a decimal number (range 01 to 12).
 
-           %\b%M\bM  The minute as a decimal number (range 00 to 59).
+           %\b%M\b- The minute as a decimal number (range 00 to 59).
 
-           %\b%p\bp  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%p\b- 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%S\bS  The second as a decimal number (range 00 to 61).
+           %\b%S\b- The second as a decimal number (range 00 to 61).
 
-           %\b%U\bU  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\b- 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%V\bV  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%V\b- 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%w\b The day of the week as a decimal, range 0 to 6, Sunday being 0.
-               See also %u.
+           %\b%w\b- The day of the week as a decimal, range 0 to 6, Sunday being
+           0.  See also %u.
 
-           %\b%W\bW  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.
+           %\b%W\b- 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.
 
-           %\b%x\bx  The preferred date representation for the current locale with-
-               out the time.
+           %\b%x\b- The preferred date representation for the current locale with-
+           out the time.
 
-           %\b%X\bX  The preferred time representation for the current locale with-
-               out the date.
+           %\b%X\b- The preferred time representation for the current locale with-
+           out the date.
 
-           %\b%y\by  The year as a decimal number without a century (range 00 to
-               99).
+           %\b%y\b- The year as a decimal number without a century (range 00 to
+           99).
 
-           %\b%Y\bY  The year as a decimal number including the century.
+           %\b%Y\b- The year as a decimal number including the century.
 
-           %\b%Z\bZ  The time zone or name or abbreviation.
+           %\b%Z\b- The time zone or name or abbreviation.
 
-           %\b%%\b%  A literal `%' character.
+           %\b%%\b- A literal `%' character.
 
        P\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bC_\bF:\b:_\bf_\bo_\br_\bm_\ba_\bt
            _\bD_\be_\bp_\br_\be_\bc_\ba_\bt_\be_\bd_\b. _\bU_\bs_\be _\bt_\bh_\be _\bn_\be_\bw _\bf_\bo_\br_\bm _\bo_\bf _\bt_\bh_\bi_\bs _\bc_\bo_\bm_\bm_\ba_\bn_\bd _\bi_\bn _\bn_\be_\bw _\bs_\bc_\br_\bi_\bp_\bt_\bs_\b.  The
            first form of this command is to be used with C\bCD\bDE\bEF\bF _\bv_\bn_\ba_\bm_\bes.
 
-G\bGR\bRA\bAP\bPH\bH
+       G\bGR\bRA\bAP\bPH\bH
+
+
        G\bGP\bPR\bRI\bIN\bNT\bT:\b:_\bv_\bn_\ba_\bm_\be:\b:_\bf_\bo_\br_\bm_\ba_\bt
            This is the same as "PRINT", but printed inside the graph.
 
@@ -276,4 +278,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.2.26                            2007-11-20                 RRDGRAPH_GRAPH(1)
+1.2.27                            2008-02-17                 RRDGRAPH_GRAPH(1)