X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdxport.1;h=335e97542425f5111df0bc1e6a57dfc226d44abe;hb=d9822df7ed5e8122cf3a62e4e99678e94007f504;hp=186dc1fa7347a748feac213f95154fe035ac50b2;hpb=1559397b94b4af3de73cfa23c04be31d8bee53e7;p=pkg-rrdtool.git diff --git a/doc/rrdxport.1 b/doc/rrdxport.1 index 186dc1f..335e975 100644 --- a/doc/rrdxport.1 +++ b/doc/rrdxport.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 @@ -48,22 +40,25 @@ . 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. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "RRDXPORT 1" -.TH RRDXPORT 1 "2008-03-15" "1.3.7" "rrdtool" +.TH RRDXPORT 1 "2013-05-23" "1.4.8" "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" rrdxport \- Export data in XML format based on data from one or several RRD .SH "SYNOPSIS" @@ -139,6 +138,8 @@ rrdxport \- Export data in XML format based on data from one or several RRD [\fB\-e\fR|\fB\-\-end\fR\ \fIseconds\fR] [\fB\-m\fR|\fB\-\-maxrows\fR\ \fIrows\fR] [\fB\-\-step\fR\ \fIvalue\fR] +[\fB\-\-json\fR] +[\fB\-\-daemon\fR\ \fIaddress\fR] [\fB\s-1DEF:\s0\fR\fIvname\fR\fB=\fR\fIrrd\fR\fB:\fR\fIds-name\fR\fB:\fR\fI\s-1CF\s0\fR] [\fB\s-1CDEF:\s0\fR\fIvname\fR\fB=\fR\fIrpn-expression\fR] [\fB\s-1XPORT\s0\fR\fB:\fR\fIvname\fR[\fB:\fR\fIlegend\fR]] @@ -170,6 +171,19 @@ for details. .IP "\fB\-\-step\fR \fIvalue\fR (default automatic)" 4 .IX Item "--step value (default automatic)" See rrdgraph documentation. +.IP "\fB\-\-daemon\fR \fIaddress\fR" 4 +.IX Item "--daemon address" +Address of the rrdcached daemon. If specified, a \f(CW\*(C`flush\*(C'\fR command is sent +to the server before reading the \s-1RRD\s0 files. This allows \fBrrdtool\fR to return +fresh data even if the daemon is configured to cache values for a long time. +For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual. +.Sp +.Vb 1 +\& rrdtool xport \-\-daemon unix:/var/run/rrdcached.sock ... +.Ve +.IP "\fB\-\-json\fR" 4 +.IX Item "--json" +produce json formated output (instead of xml) .IP "\fB\-\-enumds\fR" 4 .IX Item "--enumds" The generated xml should contain the data values in enumerated tags. @@ -225,7 +239,7 @@ The resulting meta data section is (the values will depend on the .PP The resulting data section is: .PP -.Vb 16 +.Vb 10 \& \& 10206117003.4000000000e+005.4400000000e+01 \& 10206120003.4000000000e+005.4400000000e+01 @@ -261,6 +275,15 @@ The resulting data section is: \& XPORT:out2:"if2 out bytes" \e \& XPORT:sum:"output sum" .Ve +.SH "ENVIRONMENT VARIABLES" +.IX Header "ENVIRONMENT VARIABLES" +The following environment variables may be used to change the behavior of +\&\f(CW\*(C`rrdtool\ xport\*(C'\fR: +.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4 +.IX Item "RRDCACHED_ADDRESS" +If this environment variable is set it will have the same effect as specifying +the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command +line argument takes precedence. .SH "AUTHOR" .IX Header "AUTHOR" Tobias Oetiker