From: Marek Schimara <Marek.Schimara@bull.net>
Date: Wed, 24 Aug 2016 13:20:43 +0000 (+0200)
Subject: doc: adds documentation for the LIST command
X-Git-Tag: v1.7.0~36^2~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=99a8d92f5e5282155310ce9d3465f367d2415a23;p=thirdparty%2Frrdtool-1.x.git

doc: adds documentation for the LIST command
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index ad097cf9..008bd70d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -11,7 +11,7 @@ POD = bin_dec_hex.pod        rrddump.pod            rrdgraph_examples.pod  rrdre
       rpntutorial.pod        rrdfirst.pod           rrdgraph_rpn.pod       rrdtool.pod            rrdcached.pod  \
       rrd-beginners.pod      rrdinfo.pod            rrdtune.pod            rrdbuild.pod           rrdflushcached.pod   \
       rrdcgi.pod             rrdgraph.pod           rrdlast.pod            rrdlastupdate.pod                     \
-      rrdcreate.pod          rrdgraph_data.pod      rrdresize.pod          rrdtutorial.pod                       
+      rrdcreate.pod          rrdgraph_data.pod      rrdresize.pod          rrdtutorial.pod        rrdlist.pod
 
 if BUILD_LIBDBI
   POD += rrdgraph_libdbi.pod
diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 8e2afa76..582a85de 100644
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -367,6 +367,10 @@ xport
 
 create
 
+=item *
+
+list
+
 =back
 
 The B<update> command can send values to the daemon instead of writing them to
@@ -740,6 +744,11 @@ message itself.  The first user command after B<BATCH> is command number one.
     server:  1 message for command 1
     server:  12 message for command 12
 
+=item B<LIST> I<path>
+
+This command allows to list directories and rrd databases as seen by the daemon.
+The root "directory" is the base_dir (see '-b dir').
+
 =item B<QUIT>
 
 Disconnect from rrdcached.
diff --git a/doc/rrdlist.pod b/doc/rrdlist.pod
new file mode 100644
index 00000000..cd501078
--- /dev/null
+++ b/doc/rrdlist.pod
@@ -0,0 +1,51 @@
+=head1 NAME
+
+rrdlist - List directories and rrd databases.
+
+=head1 SYNOPSIS
+
+B<rrdtool> B<list>
+S<[B<--daemon>|B<-d> I<address>]>
+I<path>
+
+=head1 DESCRIPTION
+
+The B<list> function connects to L<rrdcached>, the RRD caching daemon,
+and issues a "list" command for the given path. This provides an 'ls-like'
+interface for traversing and listing the rrd database tree.
+
+=over 8
+
+=item I<path>
+
+The path (starting with '/') with '/' being the rrdcached base_dir.
+
+=item B<--daemon>|B<-d> I<address>
+
+Address of the L<rrdcached> daemon. If not specified, the
+RRDCACHED_ADDRESS environment variable must be set (see below).  For a
+list of accepted formats, see the B<-l> option in the L<rrdcached>
+manual.
+
+ rrdtool list --daemon 127.0.0.1:42218 /cluster/nodes/node1
+
+=back
+
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables may be used to change the behavior of
+C<rrdtoolE<nbsp>list>:
+
+=over 4
+
+=item B<RRDCACHED_ADDRESS>
+
+If this environment variable is set it will have the same effect as specifying
+the C<--daemon> option on the command line. If both are present, the command
+line argument takes precedence.
+
+=back
+
+=head1 AUTHOR
+
+Sebastien Dugue <sebastien.dugue@atos.net>
diff --git a/doc/rrdtool.pod b/doc/rrdtool.pod
index 46368fb7..df8058c5 100644
--- a/doc/rrdtool.pod
+++ b/doc/rrdtool.pod
@@ -111,6 +111,10 @@ Export data retrieved from one or several RRDs. Check L<rrdxport>.
 
 Flush the values for a specific RRD file from memory. Check L<rrdflushcached>.
 
+=item B<list>
+
+List the directories and rrd databases remotely. Check L<rrdlist>.
+
 =back
 
 =head2 HOW DOES RRDTOOL WORK?