Code

Imported upstream version 1.4.8
[pkg-rrdtool.git] / doc / rrddump.txt
index 717982676ad83b5459561bec40d272b01795cf89..cad185cd3a25fc89fed602f44c6be33050fce57e 100644 (file)
@@ -6,11 +6,8 @@ N\bNA\bAM\bME\bE
        rrddump - dump the contents of an RRD to XML format
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
        rrddump - dump the contents of an RRD to XML format
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
-       r\brr\brd\bdt\bto\boo\bol\bl d\bdu\bum\bmp\bp [-\b--\b-n\bno\bo-\b-h\bhe\bea\bad\bde\ber\br|-\b-n\bn] _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\br_\br_\bd > _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\bx_\bm_\bl
-
-       or
-
-       r\brr\brd\bdt\bto\boo\bol\bl d\bdu\bum\bmp\bp [-\b--\b-n\bno\bo-\b-h\bhe\bea\bad\bde\ber\br|-\b-n\bn] _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\br_\br_\bd _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\bx_\bm_\bl
+       r\brr\brd\bdt\bto\boo\bol\bl d\bdu\bum\bmp\bp _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\br_\br_\bd [_\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\bx_\bm_\bl] [-\b--\b-h\bhe\bea\bad\bde\ber\br|-\b-h\bh {none,xsd,dtd}]
+       [-\b--\b-n\bno\bo-\b-h\bhe\bea\bad\bde\ber\br] [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs] > _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be_\b._\bx_\bm_\bl
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        The d\bdu\bum\bmp\bp function writes the contents of an R\bRR\bRD\bD in human readable (?)
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        The d\bdu\bum\bmp\bp function writes the contents of an R\bRR\bRD\bD in human readable (?)
@@ -26,11 +23,24 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
                The (optional) filename that you want to write the XML output
                to.  If not specified, the XML will be printed to stdout.
 
                The (optional) filename that you want to write the XML output
                to.  If not specified, the XML will be printed to stdout.
 
-       [-\b--\b-n\bno\bo-\b-h\bhe\bea\bad\bde\ber\br|-\b-n\bn]
-               In rrdtool 1.3, the dump function started producing correct
-               xml-headers.  Unfortunately the rrdtool restore function from
-               the 1.2 series can not handle these headers. With this option
-               you can supress the creatinon of the xml headers.
+       -\b--\b-h\bhe\bea\bad\bde\ber\br|-\b-h\bh {none,xsd,dtd}
+               By default RRDtool will add a dtd header to the xml file. Here
+               you can customize this to and xsd header or no header at all.
+
+       -\b--\b-n\bno\bo-\b-h\bhe\bea\bad\bde\ber\br
+               A shortcut for --header=none.
+
+               If you want to restore the dump with RRDtool 1.2 you should use
+               the --no-header option since 1.2 can not deal with xml headers.
+
+       -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
+               Address of the rrdcached daemon. If specified, a "flush"
+               command is sent to the server before reading the RRD files.
+               This allows r\brr\brd\bdt\bto\boo\bol\bl 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 -\b-l\bl option in the rrdcached manual.
+
+                rrdtool dump --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
 E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
        To transfer an RRD between architectures, follow these steps:
 
 E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
        To transfer an RRD between architectures, follow these steps:
@@ -43,9 +53,18 @@ E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
        3.  Run r\brr\brd\bdt\bto\boo\bol\bl r\bre\bes\bst\bto\bor\bre\be to create a new RRD from the XML dump. See
            r\brr\brd\bdr\bre\bes\bst\bto\bor\bre\be for details.
 
        3.  Run r\brr\brd\bdt\bto\boo\bol\bl r\bre\bes\bst\bto\bor\bre\be to create a new RRD from the XML dump. See
            r\brr\brd\bdr\bre\bes\bst\bto\bor\bre\be for details.
 
+E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
+       The following environment variables may be used to change the behavior
+       of "rrdtool dump":
+
+       R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
+           If this environment variable is set it will have the same effect as
+           specifying the "--daemon" option on the command line. If both are
+           present, the command line argument takes precedence.
+
 A\bAU\bUT\bTH\bHO\bOR\bR
        Tobias Oetiker <tobi@oetiker.ch>
 
 
 
 A\bAU\bUT\bTH\bHO\bOR\bR
        Tobias Oetiker <tobi@oetiker.ch>
 
 
 
-1.3.5                             2008-05-16                        RRDDUMP(1)
+1.4.8                             2013-05-23                        RRDDUMP(1)