]> git.ipfire.org Git - thirdparty/rrdtool-1.x.git/commitdiff
Update documentation 860/head
authorWolfgang Stöggl <c72578@yahoo.de>
Thu, 4 Jan 2018 13:45:43 +0000 (14:45 +0100)
committerWolfgang Stöggl <c72578@yahoo.de>
Thu, 4 Jan 2018 13:45:43 +0000 (14:45 +0100)
- Some typos corrected
- Minor updates and corrections

15 files changed:
doc/librrd.pod
doc/rrdbuild.pod
doc/rrdcached.pod
doc/rrdcgi.pod
doc/rrdcreate.pod
doc/rrddump.pod
doc/rrdfetch.pod
doc/rrdgraph.pod
doc/rrdgraph_graph.pod
doc/rrdgraph_libdbi.pod
doc/rrdgraph_rpn.pod
doc/rrdinfo.pod
doc/rrdtool.pod
doc/rrdtune.pod
doc/rrdupdate.pod

index b47665ee9bc6795c16113dae10b761fd16fed92e..4853be96e68c745fe68c1e4b47d77b63f62fefd9 100644 (file)
@@ -24,7 +24,7 @@ the B<librrd> functions, always consult the source code.
 
 In some situations it is necessary to get the output of C<rrd_dump> without
 writing it to a file or the standard output. In such cases an application
-can ask B<rrd_dump_cb_r> to call an user-defined function each time there
+can ask B<rrd_dump_cb_r> to call a user-defined function each time there
 is output to be stored somewhere. This can be used, to e.g. directly feed
 an XML parser with the dumped output or transfer the resulting string
 in memory.
@@ -55,7 +55,7 @@ where the last parameter specifies the file handle B<rrd_dump_opt_cb_fileout>
 should write to. There's no specific condition for the callback to detect
 when it is called for the first time, nor for the last time. If you require
 this for initialization and cleanup you should do those tasks before and
-after calling B<rrd_dump_cr_r> respectively.
+after calling B<rrd_dump_cb_r> respectively.
 
 =item B<rrd_fetch_cb_register(rrd_fetch_cb_t c)>
 
@@ -63,7 +63,7 @@ If your data does not reside in rrd files, but you would like to draw charts usi
 rrd_graph functionality, you can supply your own rrd_fetch function and register it using
 the B<rrd_fetch_cb_register> function.
 
-The argument signature and api must be the same of the callback function must be aequivalent to the on of B<rrd_fetch_fn> in 
+The argument signature and api must be the same of the callback function and must be equivalent to the one of B<rrd_fetch_fn> in 
 F<rrd_fetch.c>.
 
 To activate the callback function you can use the pseudo filename F<cb//>I<free_form_text>.
index 07b15592d54d01f764c4485e98bccf95b490c787..2dc20c9b2b04cded1ce590dd54d09b10171c8736 100644 (file)
@@ -231,7 +231,7 @@ Chances are very high that you already have that on your system ...
 Libpng itself requires zlib to build, so we need to help a bit. If you
 already have a copy of zlib on your system (which is very likely) you can
 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
-the end of line 4 means that line 4 and line 5 are on one line.
+the end of lines means that the command is split over multiple lines.
 
  cd $BUILD_DIR
  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
index 586449d5517cf1bcdf0578cc96594a9df51f02df..bcbb1c52a613454861587cfaf01bd73c709fe353 100644 (file)
@@ -516,7 +516,7 @@ accepted commands to those needed by external clients. If, for example,
 external clients want to draw graphs of the cached data, they should only be
 allowed to use the C<FLUSH> command.
 
-Authorization does not work when rrcached is socket-activated by systemd.
+Authorization does not work when rrdcached is socket-activated by systemd.
 
 =head2 Encryption
 
index 5d2a81b612065c841f2cf39bfebf87d2996539fb..f30ebc4b8c55b2f0484390fb8cbbdb0a3c996597 100644 (file)
@@ -134,9 +134,9 @@ directories given in the PNG file argument will get dropped.
 
 =item RRD::PRINT I<number>
 
-If the preceding  B<RRD::GRAPH> tag contained and B<PRINT> arguments,
+If the preceding  B<RRD::GRAPH> tag contained any B<PRINT> arguments,
 then you can access their output with this tag. The I<number> argument refers to the
-number of the B<PRINT> argument. This first B<PRINT> has I<number> 0.
+number of the B<PRINT> argument. The first B<PRINT> has I<number> 0.
 
 =item RRD::INTERNAL <var>
 
index b61a8081f298a859cbddc56364ab1c0576207450..76021933a6a90158aa0767bfa9245dc78ffcb3d8 100644 (file)
@@ -83,7 +83,7 @@ destination once it has been written in its entirety.
 
 Prefilling is done by matching up DS names, RRAs and consolidation
 functions and choosing the best available data resolution when doing
-so. Prefilling may not be mathematically correct in all cases (eg. if
+so. Prefilling may not be mathematically correct in all cases (e.g. if
 resolutions have to change due to changed stepping of the target RRD
 and old and new resolutions do not match up with old/new bin
 boundaries in RRAs).
@@ -594,7 +594,7 @@ same average rate. I<-- Don Baarda E<lt>don.baarda@baesystems.comE<gt>>
        u|15|/     "swt" expired
        u|16|
         |17|----* sample4, restart "hb", create "pdp" for step1 = 
-        |18|   /  = unknown due to 10 "u" labled secs > 0.5 * step
+        |18|   /  = unknown due to 10 "u" labeled secs > 0.5 * step
         |19|  /
         |20| /
         |21|----* sample5, restart "hb"
index 01516ebd369787141bba8b1e0bf222f6bb9e61e4..3aaa49077ea1b245ecc056e5fb65a371067c8448 100644 (file)
@@ -41,7 +41,7 @@ you can customize this to and xsd header or no header at all.
 A shortcut for S<--header=none>.
 
 If you want to restore the dump with RRDtool 1.2 you should use the
-S<--no-header> option since 1.2 can not deal with xml headers.
+S<--no-header> option since 1.2 cannot deal with xml headers.
 
 =item B<--daemon>|B<-d> I<address>
 
index 70ecde09b5e54d67283f9d37d5545178bd3317bc..e50aeb8421b374b1a2c34d60aaf2c8055edbd5c1 100644 (file)
@@ -75,7 +75,7 @@ and B<-e> cannot use the complex forms described in
 L<"AT-STYLE TIME SPECIFICATION">. The only accepted arguments are "simple
 integers". Positive values are interpreted as seconds since epoch, negative
 values (and zero) are interpreted as relative to I<now>. So "1272535035" refers
-to "09:57:15 (UCT), April 29th 2010" and "-3600" means "one hour ago".
+to "09:57:15 (UTC), April 29th 2010" and "-3600" means "one hour ago".
 
 =back
 
@@ -290,11 +290,11 @@ I<end-3weeks> or I<e-3w> -- 3 weeks before end time
 I<start+6hours> or I<s+6h> -- 6 hours after start time
 (may be used as end time specification).
 
-I<931225537> -- 18:45  July 5th, 1999
+I<931200300> -- 18:45 (UTC), July 5th, 1999
 (yes, seconds since 1970 are valid as well).
 
 I<19970703 12:45> -- 12:45  July 3th, 1997
-(my favorite, and its even got an ISO number (8601)).
+(my favorite, and it has even got an ISO number (8601)).
 
 =head1 ENVIRONMENT VARIABLES
 
index ec426c0fffc12e6474bc69edc23c27179fdf9d50..f4cf4defdfce29cb565ff5c175b075594cf793d4 100644 (file)
@@ -241,7 +241,7 @@ of valstrfduration qualified PRINT/GPRINT. See L<rrdgraph_graph>.
 [B<--left-axis-format> I<format-string>]
 
 By default the format of the axis labels gets determined automatically. If
-you want to do this your self, use this option with the same %lf arguments
+you want to do this yourself, use this option with the same %lf arguments
 you know from the PRINT and GPRINT commands, or others if using different
 formatter.
 
@@ -323,7 +323,7 @@ of valstrfduration qualified PRINT/GPRINT. See L<rrdgraph_graph>.
 [B<--right-axis-format> I<format-string>]
 
 By default the format of the axis labels gets determined automatically. If
-you want to do this your self, use this option with the same %lf arguments
+you want to do this yourself, use this option with the same %lf arguments
 you know from the PRINT and GPRINT commands, or others if using different
 formatter.
 
@@ -521,7 +521,7 @@ Helvetica-BoldOblique, Helvetica-Oblique, Helvetica, Symbol,
 Times-Bold, Times-BoldItalic, Times-Italic, Times-Roman, and ZapfDingbats.
 
 For Export type you can define 
-XML, XMLENUM (enummerates the value tags <v0>,<v1>,<v2>,...),
+XML, XMLENUM (enumerates the value tags <v0>,<v1>,<v2>,...),
 JSON, JSONTIME (adds a timestamp to each data row),
 CSV (=comma separated values), TSV (=tab separated values), SSV (=semicolon separated values),
 (for comma/tab/semicolon separated values the time format by default is in the form of unix time. to change it to something else use: --x-grid MINUTE:10:HOUR:1:HOUR:4:0:"%Y-%m-%d %H:%M:%S")
index f1f40539c1cfe80792ce06b910f04e9374ea64da..8958cfe69c3ded4352062c9c608fb1b1e5a1eab0 100644 (file)
@@ -140,7 +140,7 @@ The minute as a decimal number (range 00 to 59).
 
 Either `AM' or `PM' according to the given time value, or the corresponding
 strings for the current locale.  Noon is treated as `pm' and midnight as
-`am'.  Note that in many locales and `pm' notation is unsupported and in
+`am'.  Note that in many locales a `pm' notation is unsupported and in
 such cases %p will return an empty string.
 
 =item B<%s>
@@ -416,7 +416,7 @@ backslashes in order to one being passed onto rrd_graph.
 =head2 String Formatting
 
 The text printed below the actual graph can be formatted by appending special
-escape characters at the end of a text. When ever such a character occurs,
+escape characters at the end of a text. Whenever such a character occurs,
 all pending text is pushed onto the graph according to the character
 specified.
 
@@ -456,7 +456,7 @@ the tabs inserted are relative to the start of the current legend
 element!
 
 Since RRDtool 1.3 is using Pango for rending text, you can use Pango markup.
-Pango uses the xml B<span> tags for inline formatting instructions.:
+Pango uses the xml B<span> tags for inline formatting instructions.
 
 A simple example of a marked-up string might be: 
 
@@ -480,7 +480,7 @@ Synonym for font_family
 
 =item B<size>
 
-Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If you want to specify a absolute size, it's usually easier to take advantage of the ability to specify a partial font description using 'font_desc'; you can use font_desc='12.5' rather than size='12800'.
+Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'. If you want to specify an absolute size, it's usually easier to take advantage of the ability to specify a partial font description using 'font_desc'; you can use font_desc='12.5' rather than size='12800'.
 
 =item B<style>
 
index fed531b73abbb6b9295bb74c3f8bdf046d32e6b2..f0e863be6530faa61834174518660dff8f929a91 100644 (file)
@@ -18,7 +18,7 @@ This pseudo-rrd-filename defines a sql datasource:
 
 =item B<E<lt>libdbi driverE<gt>>
 
-  which libdbi driver to use (e.g: mysql)
+  which libdbi driver to use (e.g.: mysql)
 
 =item B<E<lt>driver-option-nameE<gt>>=B<E<lt>driver-option-valueE<gt>>
 
@@ -43,14 +43,14 @@ This pseudo-rrd-filename defines a sql datasource:
 
 =item B<E<lt>[*]unixtimestamp columnE<gt>>
 
-  defines the column of E<lt>tableE<gt> which contains the unix-timestamp 
+  defines the column of <table> which contains the unix-timestamp 
   - if this is a DATETIME field in the database, then prefix with leading '*'
 
   hex-type-encoding via %xx are translated to the actual value, use %% to use %
 
 =item B<E<lt>data value columnE<gt>>
 
-  defines the column of E<lt>tableE<gt> which contains the value column, which should be graphed
+  defines the column of <table> which contains the value column, which should be graphed
 
   hex-type-encoding via %xx are translated to the actual value, use %% to use %
 
@@ -60,7 +60,7 @@ This pseudo-rrd-filename defines a sql datasource:
 
 =item B</E<lt>where clause(s)E<gt>>
 
-  defines one (ore more) where clauses that are joined with AND to filter the entries in the <lt>table<gt>
+  defines one (ore more) where clauses that are joined with AND to filter the entries in the <table>
 
   hex-type-encoding via %xx are translated to the actual value, use %% to use %
 
@@ -119,7 +119,7 @@ To illustrate this here a command to create a graph that contains the actual val
 
 =head1 NOTES
 
-* Naturally you can also use any other kind of driver that libdbi supports - e.g postgres, ...
+* Naturally you can also use any other kind of driver that libdbi supports - e.g. postgres, ...
 
 * From the way the data source is joined, it should also be possible to do joins over different tables 
   (separate tables with "," in table and add in the WHERE Clauses the table equal joins. 
@@ -142,19 +142,18 @@ To illustrate this here a command to create a graph that contains the actual val
 
 =head1 Performance issues with MySQL backend
 
-LibDBI has a big performance issue when you retrieve data from a MySQL server. Performance impact is exponentially based on the number of 
-values you retrieve from the database. 
+Previous versions of LibDBI have a big performance issue when retrieving data from a MySQL server. Performance impact is exponentially based 
+on the number of values you retrieve from the database. 
 For example, it would take more than 2 seconds to graph 5DS on 150 hours of data with a precision of 5 minutes 
-(against 100ms when data comes from a RRD file). This bug has been fixed on latest version of LibDBI (not release yet). 
-At that time, you would need to compile libdbi and libdbi-drivers from CVS repository to fix it.
-You can find more information on this libdbi-users mailing list thread : http://sourceforge.net/mailarchive/message.php?msg_id=30320894
+(against 100ms when data comes from a RRD file). This bug has been fixed in version 0.9.0 of LibDBI. 
+You can find more information on this libdbi-users mailing list thread: http://sourceforge.net/mailarchive/message.php?msg_id=30320894
 
 
 =head1 BUGS
 
 * at least on Linux please make sure that the libdbi driver is explicitly linked against libdbi.so.0 
   check via ldd /usr/lib/dbd/libmysql.so, that there is a line with libdbi.so.0. 
-  otherwise at least the perl module RRDs will fail because the dynamic linker can not find some symbols from libdbi.so.
+  otherwise at least the perl module RRDs will fail because the dynamic linker cannot find some symbols from libdbi.so.
   (this only happens when the libdbi driver is actually used the first time!)
   This is KNOWN to be the case with RHEL4 and FC4 and FC5! (But actually this is a bug with libdbi make files!)
 
index 51a0bf1b54cc663a7bb55896a015361de728eae1..de769ae3c49dca94dfa2527d65df61709d790bf9 100644 (file)
@@ -282,13 +282,13 @@ average is essentially computed as shown here:
 
 The function is by design NAN-safe.
 This also allows for extrapolation into the future (say a few days)
-- you may need to define the data series whit the optional start= parameter, so that
+- you may need to define the data series with the optional start= parameter, so that
 the source data series has enough data to provide prediction also at the beginning of a graph...
 
 The percentile can be between [-100:+100].
 The positive percentiles interpolates between values while the negative will take the closest.
 
-Example: you run 7 shifts with a window of 1800seconds. Assuming that the rrd-file
+Example: you run 7 shifts with a window of 1800 seconds. Assuming that the rrd-file
 has a step size of 300 seconds this means we have to do the percentile calculation
 based on a max of 42 distinct values (less if you got NAN). that means that in the
 best case you get a step rate between values of 2.4 percent.
@@ -374,7 +374,7 @@ Pushes the current time on the stack.
 
 B<STEPWIDTH>
 
-The with of the current step in seconds. You can use this to go back from
+The width of the current step in seconds. You can use this to go back from
 rate based presentations to absolute numbers
 
   CDEF:abs=rate,STEPWIDTH,*,PREV,ADDNAN
index 0ddde17f51d438168f68e5a71616f190912cfd46..62fadffeae02e85bb2d33c7f59bf6586c9cacae4 100644 (file)
@@ -33,7 +33,7 @@ For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 =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
+data.  If all you are interested in is the RRD structure, and not the last update
 time or current values, then this will improve efficiency.
 
 =back
index df8058c583cf6aeda30412860d1fd64b647edde9..c1baf6885b83cb3ee4173ec85b1f37c423c5adcb 100644 (file)
@@ -141,7 +141,7 @@ could do this by simply storing the data in 1 minute intervals for the
 whole year. While this would take considerable disk space it would
 also take a lot of time to analyze the data when you wanted to create
 a graph covering the whole year. B<RRDtool> offers a solution to this
-problem through its data consolidation feature. When setting up an
+problem through its data consolidation feature. When setting up a
 Round Robin Database (B<RRD>), you can define at which interval this
 consolidation should occur, and what consolidation function (B<CF>)
 (average, minimum, maximum, last) should be used to build the
index b04c5e7fa501983f13fc238ea4875c17946bcd43..4875ecdc742b45951abfdf7bec313e507c3b47ca 100644 (file)
@@ -48,7 +48,7 @@ used by the specialized function B<RRAs> for aberrant behavior detection.
 Still another application is to add or remove data sources (DS) or 
 add / remove or alter some aspects of round-robin archives (RRA). These operations 
 are not really done in-place, but rather generate a new RRD file internally and 
-move it over the original file. Data is kept intact during theses operations.
+move it over the original file. Data is kept intact during these operations.
 For even more in-depth modifications you may review the 
 S<B<--source>> and S<B<--template>> options of the B<create> function which  
 allow you to combine multiple RRD files into a new one and which is even more clever 
index 1d13155ec9ce4dd93145e181d7cb99e35d319389..8bc0c2e7c2cefc02158392949623e4a58dc4a595 100644 (file)
@@ -66,7 +66,7 @@ The caching daemon L<rrdcached> cannot be used together with templates yet.
 =item B<--skip-past-updates>|B<-s>
 
 When updating an rrd file with data earlier than the latest update already
-applied, rrdtool will issue an error message an abort. This option instructs
+applied, rrdtool will issue an error message and abort. This option instructs
 rrdtool to silently skip such data. It can be useful when re-playing old
 data into an rrd file and you are not sure how many updates have already
 been applied.