From dc4997373f9cc1c170bc378ff12fa2c3a23161e9 Mon Sep 17 00:00:00 2001 From: oetiker Date: Wed, 14 Oct 2009 08:04:59 +0000 Subject: [PATCH] Fixed various typos in the manpages. Debian bug #550919. -- Justin T. Pryzby git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@1936 a5681a0c-68f1-0310-ab6d-d61299d08faa --- bindings/perl-piped/RRDp.pm | 4 ++-- doc/rpntutorial.pod | 2 +- doc/rrd-beginners.pod | 4 ++-- doc/rrdbuild.pod | 18 ++++++++--------- doc/rrdcached.pod | 2 +- doc/rrdcreate.pod | 4 ++-- doc/rrddump.pod | 4 ++-- doc/rrdflushcached.pod | 2 +- doc/rrdgraph-old.pod | 4 ++-- doc/rrdgraph.pod | 48 ++++++++++++++++++++++----------------------- doc/rrdgraph_data.pod | 6 +++--- doc/rrdgraph_graph.pod | 10 +++++----- doc/rrdgraph_libdbi.pod | 4 ++-- doc/rrdgraph_rpn.pod | 4 ++-- doc/rrdpython.pod | 4 ++-- doc/rrdruby.pod | 4 ++-- doc/rrdtool.pod | 4 ++-- doc/rrdtutorial.pod | 8 ++++---- 18 files changed, 68 insertions(+), 68 deletions(-) diff --git a/bindings/perl-piped/RRDp.pm b/bindings/perl-piped/RRDp.pm index c3fbf91..32fb784 100644 --- a/bindings/perl-piped/RRDp.pm +++ b/bindings/perl-piped/RRDp.pm @@ -42,7 +42,7 @@ start RRDtool. The argument must be the path to the RRDtool executable =item B I -pass commands on to RRDtool. check the RRDtool documentation for +pass commands on to RRDtool. Check the RRDtool documentation for more info on the RRDtool commands. B: Due to design limitations, B does not support the @@ -69,7 +69,7 @@ running, System time is the time spend in system calls and real time is the total time RRDtool has been running. The difference between user + system and real is the time spent -waiting for things like the hard disk and new input from the perl +waiting for things like the hard disk and new input from the Perl script. =item B<$RRDp::error_mode> and B<$RRDp::error> diff --git a/doc/rpntutorial.pod b/doc/rpntutorial.pod index b830f27..dd86c68 100644 --- a/doc/rpntutorial.pod +++ b/doc/rpntutorial.pod @@ -102,7 +102,7 @@ with "A": 2) A,10,input,IF eval is A,10,input,IF read "if A then 10 else input". Now replace A with it's verbose -description again and--voila!--you have a easily readable description +description again and--voila!--you have an easily readable description of the expression: if input > 10 then 10 else input diff --git a/doc/rrd-beginners.pod b/doc/rrd-beginners.pod index 1c28515..f3c209b 100644 --- a/doc/rrd-beginners.pod +++ b/doc/rrd-beginners.pod @@ -112,7 +112,7 @@ every step interval, a new value of DS is supplied to update the database. This value is also called Primary Data Point B<(PDP)>. In our example mentioned above, a new PDP is generated every 300 seconds. -Note, that if you do NOT supply new datapoints exactly every 300 seconds, +Note, that if you do NOT supply new data points exactly every 300 seconds, this is not a problem, RRDtool will interpolate the data accordingly. B (Data Source Type) defines the type of the DS. It can be @@ -122,7 +122,7 @@ the value is always increasing (the difference between the current and the previous value is greater than 0). Traffic counters on a router are an ideal candidate for using COUNTER as DST. DERIVE is the same as COUNTER, but it allows negative values as well. If you want to see the -rate of I in free diskspace on your server, then you might +rate of I in free disk space on your server, then you might want to use the DERIVE data type. ABSOLUTE also saves the rate of change, but it assumes that the previous value is set to 0. The difference between the current and the previous value is always equal diff --git a/doc/rrdbuild.pod b/doc/rrdbuild.pod index 24570fb..f3d1f12 100644 --- a/doc/rrdbuild.pod +++ b/doc/rrdbuild.pod @@ -4,7 +4,7 @@ rrdbuild - Instructions for building RRDtool =head1 OVERVIEW -If you downloaded the source of rrdtool you have to compile it. This +If you downloaded the source of RRDtool you have to compile it. This document will give some information on how this is done. RRDtool relies on services of third part libraries. Some of these libraries @@ -68,9 +68,9 @@ B complaining about several missing libraries. If your OS lets you install additional packages from a software repository, you may get away with installing the missing packages. When the packages are installed, run configure again and try to compile again. Below you find some -hints on getting your OS ready for the rrdtool compilation. +hints on getting your OS ready for compiling RRDtool. -Additions to this list are welcome. In general rrdtool should work with the +Additions to this list are welcome. In general RRDtool should work with the latest versions of the libraries. The versions listed here are just what was current when I tested this. @@ -88,7 +88,7 @@ fix this: perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc -Make sure rrdtool finds your new compiler +Make sure the RRDtool build system finds your new compiler export PATH=/opt/SunStudioExpress/bin @@ -108,10 +108,10 @@ of packages will get added through dependencies. =head2 Gentoo -In Gentoo installing rrdtool is really simple you just need to B. All dependencies will be handled automatically by the portage system. The only thing you should care about are USE flags, which allow you -fine tune features rrdtool will be built with. Currently the following USE +fine tune features RRDtool will be built with. Currently the following USE flags are available: doc - install .html and .txt documentation @@ -143,10 +143,10 @@ expectations, so you may want to compile their latest versions. If you are working with AIX, you may find the B<--disable-shared> option will cause things to break for you. In that case you may have to install the -shared libraries into the rrdtool PREFIX and work with B<--disable-static> +shared libraries into the RRDtool PREFIX and work with B<--disable-static> instead. -Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler: +Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler: export CC=/usr/vac/bin/cc export PERLCC=$CC @@ -341,7 +341,7 @@ are running, the syntax for setting environment variables is different. And finally try building again. We disable the python and tcl bindings because it seems that a fair number of people have ill configured python and -tcl setups that would prevent rrdtool from building if they are included in +tcl setups that would prevent RRDtool from building if they are included in their current state. cd $BUILD_DIR/rrdtool-1.3.2 diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod index 460899c..043e020 100644 --- a/doc/rrdcached.pod +++ b/doc/rrdcached.pod @@ -29,7 +29,7 @@ work with up-to-date data. The daemon was written with big setups in mind. Those setups usually run into IOErelated problems sooner or later for reasons that are beyond the scope -of this document. Check the wiki at the RRDTool homepage for details. Also +of this document. Check the wiki at the RRDtool homepage for details. Also check L below before using this daemon! A detailed description of how the daemon operates can be found in the L section below. diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod index abb42fc..a4d9651 100644 --- a/doc/rrdcreate.pod +++ b/doc/rrdcreate.pod @@ -408,7 +408,7 @@ an average rate for that PDP. If the total "unknown" time accounts for more than B the "step", the entire PDP is marked as "unknown". This means that a mixture of known and "unknown" sample times in a single PDP "step" may or may not add up to enough "known" -time to warrent for a known PDP. +time to warrant a known PDP. The "heartbeat" can be short (unusual) or long (typical) relative to the "step" interval between PDPs. A short "heartbeat" means you @@ -477,7 +477,7 @@ together with the time. =item Mail Messages Assume you have a method to count the number of messages transported by -your mailserver in a certain amount of time, giving you data like '5 +your mail server in a certain amount of time, giving you data like '5 messages in the last 65 seconds'. If you look at the count of 5 like an B data type you can simply update the RRD with the number 5 and the end time of your monitoring period. RRDtool will then record the number of diff --git a/doc/rrddump.pod b/doc/rrddump.pod index f822e8e..e8d802e 100644 --- a/doc/rrddump.pod +++ b/doc/rrddump.pod @@ -32,7 +32,7 @@ If not specified, the XML will be printed to stdout. =item B<--header>|B<-h> {none,xsd,dtd} -By default rrdtool will add a dtd header to the xml file. Here +By default RRDtool will add a dtd header to the xml file. Here you can customize this to and xsd header or no header at all. @@ -40,7 +40,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 +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. =item B<--daemon> I
diff --git a/doc/rrdflushcached.pod b/doc/rrdflushcached.pod index 3c14201..c1aeeaa 100644 --- a/doc/rrdflushcached.pod +++ b/doc/rrdflushcached.pod @@ -1,6 +1,6 @@ =head1 NAME -rrdflush - Flush the values for a spcific RRD file from memory. +rrdflushcached - Flush the values for a spcific RRD file from memory. =head1 SYNOPSIS diff --git a/doc/rrdgraph-old.pod b/doc/rrdgraph-old.pod index 5bbf2a6..ac661a9 100644 --- a/doc/rrdgraph-old.pod +++ b/doc/rrdgraph-old.pod @@ -78,7 +78,7 @@ documentation for a detailed explanation of ways to specify time. =item B<-x>|B<--x-grid> I (default autoconfigure) The x-axis label is quite complex to configure. So if you don't have -very special needs, you can rely on the autoconfiguration to get this +very special needs, you can rely on the auto configuration to get this right. If you want no x-grid at all, use the magic setting B. @@ -115,7 +115,7 @@ you make sure that this happens. =item B<-y>|B<--y-grid> I:I