← Back to branch summary

~ubuntu-branches/ubuntu/maverick/rrdtool/maverick

« back to all changes in this revision

Viewing changes to doc/rrdgraph_graph.1

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2010-07-22 08:07:01 UTC
  • mfrom: (1.2.8 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100722080701-k46mgdfz6euxwqsm
Tags: 1.4.3-1ubuntu1
* Merge from debian unstable, Remaining changes:
  - debian/control: Don't build against ruby1.9 as we don't want
    it in main.
* require libdbi >= 0.8.3 to prevent aborts when using dbi datasources

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rrdgraph_graph.1
124
124
.\" ========================================================================
125
125
.\"
126
126
.IX Title "RRDGRAPH_GRAPH 1"
127
 
.TH RRDGRAPH_GRAPH 1 "2009-02-21" "1.3.8" "rrdtool"
 
127
.TH RRDGRAPH_GRAPH 1 "2010-01-25" "1.4.3" "rrdtool"
128
128
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129
129
.\" way too many mistakes in technical documents.
130
130
.if n .ad l
204
204
will all use the same magnitude unit except for zero values.
205
205
.PP
206
206
If you \s-1PRINT\s0 a \s-1VDEF\s0 value, you can also print the time associated with it by appending the string
207
 
\&\fB:strftime\fR to the format. Note that rrdtool uses the strftime function of your OSs C library. This means that
 
207
\&\fB:strftime\fR to the format. Note that RRDtool uses the strftime function of your OSs C library. This means that
208
208
the conversion specifier may vary. Check the manual page if you are uncertain. The following is a list of
209
209
conversion specifiers usually supported across the board.
210
210
.ie n .IP "\fB\fB%a\fB\fR" 4
265
265
.ie n .IP "\fB\fB%S\fB\fR" 4
266
266
.el .IP "\fB\f(CB%S\fB\fR" 4
267
267
.IX Item "%S"
268
 
The seconds since the epoch (1.1.1970) (libc dependant non standard!)
 
268
The seconds since the epoch (1.1.1970) (libc dependent non standard!)
269
269
.ie n .IP "\fB\fB%U\fB\fR" 4
270
270
.el .IP "\fB\f(CB%U\fB\fR" 4
271
271
.IX Item "%U"
452
452
example showing how to use centered formatting.
453
453
.PP
454
454
\&\fB\en\fR is a valid alias for \fB\el\fR since incomplete parsing in earlier
455
 
versions of rrdtool lead to this behavior and a number of people has been using it.
 
455
versions of RRDtool lead to this behavior and a number of people has been using it.
456
456
.PP
457
457
Normally there are two space characters inserted between every two items
458
458
printed into the graph. The space following a string can be suppressed by
467
467
A special case is \s-1COMMENT:\s0\fB\es\fR which inserts some additional vertical space
468
468
before placing the next row of legends.
469
469
.PP
470
 
If you are using the proportional font in your graph, you can use tab
471
 
characters or the sequence \fB\et\fR to line-up legend elements. Note that
 
470
If you want to have left and right aligned legends on the same line use \s-1COMMENT:\s0\fB\eu\fR
 
471
to go one line back like this:
 
472
.PP
 
473
.Vb 3
 
474
\& COMMENT:left\el
 
475
\& COMMENT:\eu
 
476
\& COMMENT:right\er
 
477
.Ve
 
478
.PP
 
479
When using a proportional font in your graph, the tab
 
480
characters or the sequence \fB\et\fR will line-up legend elements. Note that
472
481
the tabs inserted are relative to the start of the current legend
473
482
element!
474
483
.PP
526
535
\&'true' or 'false' whether to strike through the text
527
536
.IP "\fBstrikethrough_color\fR" 4
528
537
.IX Item "strikethrough_color"
529
 
The color of strikethrough lines; an \s-1RGB\s0 color specification such as '#00FF00' or a color name such as 'red'
 
538
The color of crossed out lines; an \s-1RGB\s0 color specification such as '#00FF00' or a color name such as 'red'
530
539
.IP "\fBfallback\fR" 4
531
540
.IX Item "fallback"
532
541
\&'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.
555
564
Italic
556
565
.IP "\fBs\fR" 4
557
566
.IX Item "s"
558
 
Strikethrough
 
567
Strike through
559
568
.IP "\fBsub\fR" 4
560
569
.IX Item "sub"
561
570
Subscript