X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdxport.pod;h=a668a20f33434ecaddf514a75e37a80c7e32c07a;hb=2e3ab4d5b17d1264c1908026df77242aeefb9b18;hp=fcaaa0dddda2440f6869f8feae8ef24b72d15006;hpb=23be36896d8cf89dd9dbcdb2bb62677ca01810f8;p=rrdtool.git diff --git a/doc/rrdxport.pod b/doc/rrdxport.pod index fcaaa0d..a668a20 100644 --- a/doc/rrdxport.pod +++ b/doc/rrdxport.pod @@ -1,13 +1,11 @@ =head1 NAME -rrdtool xport - Export data in XML format based on data from one or several RRD - -=for html
PDF version.
+rrdxport - Export data in XML format based on data from one or several RRD =head1 SYNOPSIS -B B -S<[B<-s>|B<--start> I]> +B B +S<[B<-s>|B<--start> I]> S<[B<-e>|B<--end> I]> S<[B<-m>|B<--maxrows> I]> S<[B<--step> I]> @@ -17,9 +15,9 @@ S<[BB<:>I[B<:>I]]> =head1 DESCRIPTION -The B functions main purpose is to write XML formatted +The B function's main purpose is to write an XML formatted representation of the data stored in one or several Bs. It -can also extract numerical reports. +can also extract numerical reports. If no I statements are found, there will be no output. @@ -48,7 +46,13 @@ for details. =item B<--step> I (default automatic) -See I documentation. +See L documentation. + +=item B<--enumds> + +The generated xml should contain the data values in enumerated tags. + + valval =item BIB<=>IB<:>IB<:>I @@ -63,13 +67,13 @@ See I documentation. At least one I statement should be present. The values referenced by I are printed. Optionally add a legend. -=over +=back =head1 Output format -The output is enclosed in a B element and contains two +The output is enclosed in an B element and contains two blocks. The first block is enclosed by a B element and -contains some meta data. The second block is enclosed by a +contains some meta data. The second block is enclosed by a B element and contains the data rows. Let's assume that the I command looks like this: @@ -82,9 +86,9 @@ Let's assume that the I command looks like this: XPORT:xx:"out bytes" \ XPORT:aa:"in and out bits" -The resulting meta data section (the values will depend on the +The resulting meta data section is (the values will depend on the RRD characteristics): - + 1020611700 300 @@ -96,8 +100,8 @@ RRD characteristics): in and out bits - -The resulting data section: + +The resulting data section is: 10206117003.4000000000e+005.4400000000e+01 @@ -136,5 +140,5 @@ The resulting data section: =head1 AUTHOR -Tobias Oetiker Eoetiker@ee.ethz.chE +Tobias Oetiker Etobi@oetiker.chE