From ba5c9c2d0857acbfc1fbde7f4f2ad97163b7cd89 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Wolfgang=20St=C3=B6ggl?= Date: Thu, 4 Jan 2018 14:45:43 +0100 Subject: [PATCH] Update documentation - Some typos corrected - Minor updates and corrections --- doc/librrd.pod | 6 +++--- doc/rrdbuild.pod | 2 +- doc/rrdcached.pod | 2 +- doc/rrdcgi.pod | 4 ++-- doc/rrdcreate.pod | 4 ++-- doc/rrddump.pod | 2 +- doc/rrdfetch.pod | 6 +++--- doc/rrdgraph.pod | 6 +++--- doc/rrdgraph_graph.pod | 8 ++++---- doc/rrdgraph_libdbi.pod | 21 ++++++++++----------- doc/rrdgraph_rpn.pod | 6 +++--- doc/rrdinfo.pod | 2 +- doc/rrdtool.pod | 2 +- doc/rrdtune.pod | 2 +- doc/rrdupdate.pod | 2 +- 15 files changed, 37 insertions(+), 38 deletions(-) diff --git a/doc/librrd.pod b/doc/librrd.pod index b47665ee..4853be96 100644 --- a/doc/librrd.pod +++ b/doc/librrd.pod @@ -24,7 +24,7 @@ the B functions, always consult the source code. In some situations it is necessary to get the output of C without writing it to a file or the standard output. In such cases an application -can ask B to call an user-defined function each time there +can ask B 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 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 respectively. +after calling B respectively. =item B @@ -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 function. -The argument signature and api must be the same of the callback function must be aequivalent to the on of B in +The argument signature and api must be the same of the callback function and must be equivalent to the one of B in F. To activate the callback function you can use the pseudo filename FI. diff --git a/doc/rrdbuild.pod b/doc/rrdbuild.pod index 07b15592..2dc20c9b 100644 --- a/doc/rrdbuild.pod +++ b/doc/rrdbuild.pod @@ -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 diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod index 586449d5..bcbb1c52 100644 --- a/doc/rrdcached.pod +++ b/doc/rrdcached.pod @@ -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 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 diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod index 5d2a81b6..f30ebc4b 100644 --- a/doc/rrdcgi.pod +++ b/doc/rrdcgi.pod @@ -134,9 +134,9 @@ directories given in the PNG file argument will get dropped. =item RRD::PRINT I -If the preceding B tag contained and B arguments, +If the preceding B tag contained any B arguments, then you can access their output with this tag. The I argument refers to the -number of the B argument. This first B has I 0. +number of the B argument. The first B has I 0. =item RRD::INTERNAL diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod index b61a8081..76021933 100644 --- a/doc/rrdcreate.pod +++ b/doc/rrdcreate.pod @@ -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 Edon.baarda@baesystems.comE> 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" diff --git a/doc/rrddump.pod b/doc/rrddump.pod index 01516ebd..3aaa4907 100644 --- a/doc/rrddump.pod +++ b/doc/rrddump.pod @@ -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
diff --git a/doc/rrdfetch.pod b/doc/rrdfetch.pod index 70ecde09..e50aeb84 100644 --- a/doc/rrdfetch.pod +++ b/doc/rrdfetch.pod @@ -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. 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 or I -- 3 weeks before end time I or I -- 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 diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod index ec426c0f..f4cf4def 100644 --- a/doc/rrdgraph.pod +++ b/doc/rrdgraph.pod @@ -241,7 +241,7 @@ of valstrfduration qualified PRINT/GPRINT. See L. [B<--left-axis-format> I] 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. [B<--right-axis-format> I] 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 ,,,...), +XML, XMLENUM (enumerates the value tags ,,,...), 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") diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod index f1f40539..8958cfe6 100644 --- a/doc/rrdgraph_graph.pod +++ b/doc/rrdgraph_graph.pod @@ -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 tags for inline formatting instructions.: +Pango uses the xml B 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 -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