]> git.ipfire.org Git - thirdparty/rrdtool-1.x.git/commitdiff
Update rrdlist manual
authorJean-Michel Vourgère <nirgal@debian.org>
Tue, 12 Nov 2019 10:29:48 +0000 (11:29 +0100)
committerTobias Oetiker <tobi@oetiker.ch>
Tue, 12 Nov 2019 17:01:36 +0000 (18:01 +0100)
Add documentation for --noflush and --recursive options.

doc/rrdlist.pod

index cd501078de596e6e1e6de773c19aafa2cdacf7de..6c2667e2843e33c6dfb73bd115bab8197dd9cf65 100644 (file)
@@ -6,13 +6,18 @@ rrdlist - List directories and rrd databases.
 
 B<rrdtool> B<list>
 S<[B<--daemon>|B<-d> I<address>]>
+S<[B<--noflush>|B<-F>]>
+S<[B<--recursive>|B<-r>]>
 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.
+The B<list> function provides an 'ls-like' interface for traversing and listing
+the rrd database tree.
+
+When using the B<--daemon> option, the B<list> function connects to
+L<rrdcached>, the RRD caching daemon, and issues a "list" command for the given
+path.
 
 =over 8
 
@@ -29,6 +34,15 @@ manual.
 
  rrdtool list --daemon 127.0.0.1:42218 /cluster/nodes/node1
 
+=item B<--noflush>|B<-F>
+
+When using a daemon, C<rrdtoolE<nbsp>list> will usually flush its cache to the
+disk before performing operations. This option disables cache flushing.
+
+=item B<--recursive>|B<-r>
+
+Make the list of rrd databases recursive.
+
 =back
 
 =head1 ENVIRONMENT VARIABLES