From: Benoît Monin <benoit.monin@gmx.fr>
Date: Sat, 25 Apr 2015 10:02:44 +0000 (+0200)
Subject: rrdinfo: fix options documentation
X-Git-Tag: v1.5.3~5^2^2~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=225e5be0bdf994efcded197026e6f9b8d6dd0ea2;p=thirdparty%2Frrdtool-1.x.git

rrdinfo: fix options documentation

* Document short option '-d' for daemon.
* Document short option '-F' for noflush.
* Add short-options '-d' and '-F' to error message.
* Add daemon and noflush to rrdtool help.
---

diff --git a/doc/rrdinfo.pod b/doc/rrdinfo.pod
index 1752b693..0ddde17f 100644
--- a/doc/rrdinfo.pod
+++ b/doc/rrdinfo.pod
@@ -5,7 +5,7 @@ rrdinfo - extract header information from an RRD
 =head1 SYNOPSIS
 
 B<rrdtool> B<info> I<filename>
-S<[B<--daemon> I<address>]>
+S<[B<--daemon>|B<-d> I<address> S<[B<--noflush>|B<-F>]>]>
 
 =head1 DESCRIPTION
 
@@ -21,7 +21,7 @@ individual keys.
 
 The name of the B<RRD> you want to examine.
 
-=item B<--daemon> I<address>
+=item B<--daemon>|B<-d> I<address>
 
 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
 to the server before reading the RRD files. This allows B<rrdtool> to return
@@ -30,7 +30,7 @@ For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 
  rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
-=item B<--noflush> 
+=item B<--noflush>|B<-F>
 
 Omit the C<flush> command usually sent to the daemon prior to retrieving the
 data.  If all you are interested in the the RRD Structure, and not the last update
diff --git a/src/rrd_info.c b/src/rrd_info.c
index 579318bc..29813238 100644
--- a/src/rrd_info.c
+++ b/src/rrd_info.c
@@ -127,7 +127,7 @@ rrd_info_t *rrd_info(
             break;
 
         default:
-            rrd_set_error ("Usage: rrdtool %s [--daemon <addr> [--noflush]] <file>",
+            rrd_set_error ("Usage: rrdtool %s [--daemon|-d <addr> [--noflush|-F]] <file>",
                     argv[0]);
             return (NULL);
             break;
@@ -135,7 +135,7 @@ rrd_info_t *rrd_info(
     }                   /* while (42) */
 
     if ((argc - optind) != 1) {
-        rrd_set_error ("Usage: rrdtool %s [--daemon <addr> [--noflush]] <file>",
+        rrd_set_error ("Usage: rrdtool %s [--daemon |-d <addr> [--noflush|-F]] <file>",
                 argv[0]);
         return (NULL);
     }
diff --git a/src/rrd_tool.c b/src/rrd_tool.c
index 385e5d81..74d57f7d 100644
--- a/src/rrd_tool.c
+++ b/src/rrd_tool.c
@@ -80,7 +80,7 @@ void PrintUsage(
 
     const char *help_info =
         N_("* info - returns the configuration and status of the RRD\n\n"
-           "\trrdtool info filename.rrd\n");
+           "\trrdtool info [--daemon|-d <addr> [--noflush|-F]] filename.rrd\n");
 
     const char *help_restore =
         N_("* restore - restore an RRD file from its XML form\n\n"