X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Frrdxport.txt;h=ba2c353ba4e328cc6ab12fc0ae4bf0320756f2ef;hb=ffa00ac697dccce18dca8880ca7a14066521ac5c;hp=2930d1b98fbe0b508d959e23abcbeb3f0569298b;hpb=51c3d3fb997c22e1ee828470413f1e84989e1f6c;p=pkg-rrdtool.git diff --git a/doc/rrdxport.txt b/doc/rrdxport.txt index 2930d1b..ba2c353 100644 --- a/doc/rrdxport.txt +++ b/doc/rrdxport.txt @@ -8,12 +8,13 @@ NNAAMMEE SSYYNNOOPPSSIISS rrrrddttooooll xxppoorrtt [--ss|----ssttaarrtt _s_e_c_o_n_d_s] [--ee|----eenndd _s_e_c_o_n_d_s] - [--mm|----mmaaxxrroowwss _r_o_w_s] [----sstteepp _v_a_l_u_e] [DDEEFF::_v_n_a_m_e==_r_r_d::_d_s_-_n_a_m_e::_C_F] - [CCDDEEFF::_v_n_a_m_e==_r_p_n_-_e_x_p_r_e_s_s_i_o_n] [XXPPOORRTT::_v_n_a_m_e[::_l_e_g_e_n_d]] + [--mm|----mmaaxxrroowwss _r_o_w_s] [----sstteepp _v_a_l_u_e] [----ddaaeemmoonn _a_d_d_r_e_s_s] + [DDEEFF::_v_n_a_m_e==_r_r_d::_d_s_-_n_a_m_e::_C_F] [CCDDEEFF::_v_n_a_m_e==_r_p_n_-_e_x_p_r_e_s_s_i_o_n] + [XXPPOORRTT::_v_n_a_m_e[::_l_e_g_e_n_d]] DDEESSCCRRIIPPTTIIOONN - The xxppoorrtt function's main purpose is to write an XML formatted - representation of the data stored in one or several RRRRDDs. It can also + The xxppoorrtt function's main purpose is to write an XML formatted repre- + sentation of the data stored in one or several RRRRDDs. It can also extract numerical reports. If no _X_P_O_R_T statements are found, there will be no output. @@ -22,15 +23,15 @@ DDEESSCCRRIIPPTTIIOONN The time when the exported range should begin. Time in seconds since epoch (1970-01-01) is required. Negative numbers are relative to the current time. By default one day worth of data will be - printed. See also AT-STYLE TIME SPECIFICATION section in the - _r_r_d_f_e_t_c_h documentation for a detailed explanation on how to specify + printed. See also AT-STYLE TIME SPECIFICATION section in the _r_r_d_- + _f_e_t_c_h documentation for a detailed explanation on how to specify time. --ee|----eenndd _s_e_c_o_n_d_s (default now) The time when the exported range should end. Time in seconds since - epoch. See also AT-STYLE TIME SPECIFICATION section in the - _r_r_d_f_e_t_c_h documentation for a detailed explanation of ways to - specify time. + epoch. See also AT-STYLE TIME SPECIFICATION section in the _r_r_d_- + _f_e_t_c_h documentation for a detailed explanation of ways to specify + time. --mm|----mmaaxxrroowwss _r_o_w_s (default 400 rows) This works like the --ww|----wwiiddtthh parameter of _r_r_d_g_r_a_p_h. In fact it @@ -40,6 +41,15 @@ DDEESSCCRRIIPPTTIIOONN ----sstteepp _v_a_l_u_e (default automatic) See rrdgraph documentation. + ----ddaaeemmoonn _a_d_d_r_e_s_s + Address of the rrdcached daemon. If specified, a "flush" command is + sent to the server before reading the RRD files. This allows rrrrdd-- + ttooooll 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 --ll + option in the rrdcached manual. + + rrdtool xport --daemon unix:/var/run/rrdcached.sock ... + ----eennuummddss The generated xml should contain the data values in enumerated tags. @@ -53,8 +63,8 @@ DDEESSCCRRIIPPTTIIOONN See _r_r_d_g_r_a_p_h documentation. XXPPOORRTT::_v_n_a_m_e::::_l_e_g_e_n_d - At least one _X_P_O_R_T statement should be present. The values - referenced by _v_n_a_m_e are printed. Optionally add a legend. + At least one _X_P_O_R_T statement should be present. The values refer- + enced by _v_n_a_m_e are printed. Optionally add a legend. OOuuttppuutt ffoorrmmaatt The output is enclosed in an xxppoorrtt element and contains two blocks. The @@ -120,9 +130,18 @@ EEXXAAMMPPLLEE 22 XPORT:out2:"if2 out bytes" \ XPORT:sum:"output sum" +EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS + The following environment variables may be used to change the behavior + of "rrdtool xport": + + RRRRDDCCAACCHHEEDD__AADDDDRREESSSS + 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. + AAUUTTHHOORR Tobias Oetiker -1.3.8 2008-03-15 RRDXPORT(1) +1.3.99909060808 2008-09-25 RRDXPORT(1)