From d5f714526b520b1f70d9e6dd3e7b6fd59b69d2cb Mon Sep 17 00:00:00 2001
From: oetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Date: Thu, 14 Feb 2008 07:25:24 +0000
Subject: [PATCH] fixes for better web rendering

git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@1283 a5681a0c-68f1-0310-ab6d-d61299d08faa
---
 doc/rrdcreate.pod      |  10 +--
 doc/rrdgraph.pod       |  14 ++--
 doc/rrdgraph_graph.pod | 160 +++++++++--------------------------------
 doc/rrdgraph_rpn.pod   |   6 --
 doc/rrdtutorial.pod    |   2 +-
 5 files changed, 40 insertions(+), 152 deletions(-)

diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 27ef702..a47acbb 100644
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -16,7 +16,7 @@ The create function of RRDtool lets you set up new Round Robin
 Database (B<RRD>) files.  The file is created at its final, full size
 and filled with I<*UNKNOWN*> data.
 
-=over 8
+=over
 
 =item I<filename>
 
@@ -63,7 +63,7 @@ In order to decide which data source type to use, review the
 definitions that follow. Also consult the section on "HOW TO MEASURE"
 for further insight.
 
-=over 4
+=over
 
 =item B<GAUGE>
 
@@ -89,9 +89,7 @@ room. Internally, derive works exactly like COUNTER but without
 overflow checks. So if your counter does not reset at 32 or 64 bit you
 might want to use DERIVE and combine it with a MIN value of 0.
 
-=over
-
-=item NOTE on COUNTER vs DERIVE
+NOTE on COUNTER vs DERIVE
 
 by Don Baarda E<lt>don.baarda@baesystems.comE<gt>
 
@@ -110,8 +108,6 @@ probably preferable. If you are using a 64bit counter, just about any max
 setting will eliminate the possibility of mistaking a reset for a counter
 wrap.
 
-=back
-
 =item B<ABSOLUTE>
 
 is for counters which get reset upon reading. This is used for fast counters
diff --git a/doc/rrdgraph.pod b/doc/rrdgraph.pod
index 9060bd8..11b447e 100644
--- a/doc/rrdgraph.pod
+++ b/doc/rrdgraph.pod
@@ -43,7 +43,7 @@ it. For instance, you might be collecting B<bytes> per second, but
 want to display B<bits> per second. This is what the B<L<data
 calculation|rrdgraph_data/CDEF>> command is designed for. After
 B<consolidating> the data, a copy is made and this copy is modified
-using a rather powerful B<L<RPN|rrdgraph_rpn/>> command set.
+using a rather powerful L<rrdgraph_rpn> command set.
 
 When you are done fetching and processing the data, it is time to
 graph it (or print it).  This ends the B<rrdtool graph> sequence.
@@ -70,7 +70,7 @@ The start and end of the time series you would like to display, and which
 B<RRA> the data should come from.  Defaults are: 1 day ago until
 now, with the best possible resolution. B<Start> and B<end> can
 be specified in several formats, see
-L<AT-STYLE TIME SPECIFICATION|rrdfetch/> and L<rrdgraph_examples>.
+L<rrdfetch> and L<rrdgraph_examples>.
 By default, B<rrdtool graph> calculates the width of one pixel in
 the time domain and tries to get data from an B<RRA> with that
 resolution.  With the B<step> option you can alter this behaviour.
@@ -149,11 +149,7 @@ This might extend the scale too much for some logarithmic scales
 and for linear scales where B<--alt-autoscale> is needed.
 Using B<--no-gridfit> disables modification of the scale.
 
-=item Grid
-
-=over 4
-
-=item X-Axis
+=item X-Grid
 
 [B<-x>|B<--x-grid> I<GTM>B<:>I<GST>B<:>I<MTM>B<:>I<MST>B<:>I<LTM>B<:>I<LST>B<:>I<LPR>B<:>I<LFM>]
 
@@ -188,7 +184,7 @@ This places grid lines every 8 hours, major grid lines and labels
 each day. The labels are placed exactly between two major grid lines
 as they specify the complete day and not just midnight.
 
-=item Y-Axis
+=item Y-Grid
 
 [B<-y>|B<--y-grid> I<grid step>B<:>I<label factor>]
 
@@ -245,8 +241,6 @@ With this option y-axis values on logarithmic graphs will be scaled to
 the appropriate units (k, M, etc.) instead of using exponential notation.
 Note that for linear graphs, SI notation is used by default.
 
-=back
-
 =item Miscellaneous
 
 [B<-z>|B<--lazy>]
diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod
index 93bc1dd..85591e6 100644
--- a/doc/rrdgraph_graph.pod
+++ b/doc/rrdgraph_graph.pod
@@ -24,19 +24,10 @@ B<TICK>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<fraction>[B<:>I<legend>]]
 
 B<SHIFT>B<:>I<vname>B<:>I<offset>
 
-=cut
-
-#
-#B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
-#
-
-=pod
-
 B<PRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
 B<GPRINT>B<:>I<vname>B<:>I<CF>B<:>I<format> (deprecated)
 
-
 B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>] (deprecated)
 
 =head1 DESCRIPTION
@@ -45,10 +36,9 @@ These instructions allow you to generate your image or report.
 If you don't use any graph elements, no graph is generated.
 Similarly, no report is generated if you don't use print options.
 
-=head1 PRINT
-
-=over 4
+=head2 PRINT
 
+=over
 
 =item B<PRINT:>I<vname>B<:>I<format>[B<:strftime>]
 
@@ -62,145 +52,81 @@ can be:
 
 For printing values:
 
-=over 4
+B<%%> - just prints a literal '%' character
 
-=item B<%%>
-
-just prints a literal '%' character
-
-=item B<%#.#le>
-
-prints numbers like 1.2346e+04. The optional integers # denote field
+B<%#.#le> - prints numbers like 1.2346e+04. The optional integers # denote field
 width and decimal precision.
 
-=item B<%#.#lf>
-
-prints numbers like 12345.6789, with optional field width
+B<%#.#lf> - prints numbers like 12345.6789, with optional field width
 and precision.
 
-=item B<%s>
-
-place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the
+B<%s> - place this after B<%le>, B<%lf> or B<%lg>. This will be replaced by the
 appropriate SI magnitude unit and the value will be scaled
 accordingly (123456 -> 123.456 k).
 
-=item B<%S>
-
-is similar to B<%s>. It does, however, use a previously defined
+B<%S> - is similar to B<%s>. It does, however, use a previously defined
 magnitude unit. If there is no such unit yet, it tries to define
 one (just like B<%s>) unless the value is zero, in which case the magnitude
 unit stays undefined. Thus, formatter strings using B<%S> and no B<%s>
 will all use the same magnitude unit except for zero values.
 
-=back
-
 If you PRINT a VDEF value, you can also print the time associated with it by appending the string
 B<:strftime> to the format. Note that rrdtool uses the strftime function of your OSs clibrary. This means that
 the conversion specifier may vary. Check the manual page if you are uncertain. The following is a list of
 conversion specifiers usually supported across the board. 
 
-=over 4
-
-=item B<%a>
-
-The abbreviated weekday name according to the current locale.
-
-=item B<%A>
-
-The full weekday name according to the current locale.
-
-=item B<%b>
-
-The abbreviated month name according to the current locale.
-
-=item B<%B>
-
-The full month name according to the current locale.
+B<%a> - The abbreviated weekday name according to the current locale.
 
-=item B<%c>
+B<%A> - The full weekday name according to the current locale.
 
-The preferred date and time representation for the current locale.
+B<%b> - The abbreviated month name according to the current locale.
 
-=item B<%d>
+B<%B> - The full month name according to the current locale.
 
-The day of the month as a decimal number (range 01 to 31).
+B<%c> - The preferred date and time representation for the current locale.
 
-=item B<%H>
+B<%d> - The day of the month as a decimal number (range 01 to 31).
 
-The hour as a decimal number using a 24-hour clock (range 00 to 23).
+B<%H> - The hour as a decimal number using a 24-hour clock (range 00 to 23).
 
-=item B<%I>
+B<%I> - The hour as a decimal number using a 12-hour clock (range 01 to 12).
 
-The hour as a decimal number using a 12-hour clock (range 01 to 12).
+B<%j> - The day of the year as a decimal number (range 001 to 366).
 
-=item B<%j>
+B<%m> - The month as a decimal number (range 01 to 12).
 
-The day of the year as a decimal number (range 001 to 366).
+B<%M> - The minute as a decimal number (range 00 to 59).
 
-=item B<%m>
-
-The month as a decimal number (range 01 to 12).
-
-=item B<%M>
-
-The minute as a decimal number (range 00 to 59).
-
-=item B<%p>
-
-Either `AM' or `PM' according to the given time value, or the corresponding
+B<%p> - 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
 such cases %p will return an empty string.
 
-=item B<%S>
-
-The second as a decimal number (range 00 to 61).
+B<%S> - The second as a decimal number (range 00 to 61).
 
-=item B<%U>
-
-The  week  number  of  the current year as a decimal number, range 00 to 53, starting with the
+B<%U> - The  week  number  of  the current year as a decimal number, range 00 to 53, starting with the
 first Sunday as the first day of week 01. See also %V and %W.
 
-=item B<%V>
-
-The ISO 8601:1988 week number of the current year as a decimal number, range 01 to  53,  where
+B<%V> - The ISO 8601:1988 week number of the current year as a decimal number, range 01 to  53,  where
 week  1 is the first week that has at least 4 days in the current year, and with Monday as the
 first day of the week. See also %U and %W.
 
-=item B<%w>
-
-The day of the week as a decimal, range 0 to 6, Sunday being 0.  See also %u.
+B<%w> - The day of the week as a decimal, range 0 to 6, Sunday being 0.  See also %u.
 
-=item B<%W>
-
-The week number of the current year as a decimal number, range 00 to  53,  starting  with  the
+B<%W> - The week number of the current year as a decimal number, range 00 to  53,  starting  with  the
 first Monday as the first day of week 01.
 
-=item B<%x>
-
-The preferred date representation for the current locale without the time.
+B<%x> - The preferred date representation for the current locale without the time.
 
-=item B<%X>
+B<%X> - The preferred time representation for the current locale without the date.
 
-The preferred time representation for the current locale without the date.
+B<%y> - The year as a decimal number without a century (range 00 to 99).
 
-=item B<%y>
+B<%Y> - The year as a decimal number including the century.
 
-The year as a decimal number without a century (range 00 to 99).
+B<%Z> - The time zone or name or abbreviation.
 
-=item B<%Y>
-
-The year as a decimal number including the century.
-
-=item B<%Z>
-
-The time zone or name or abbreviation.
-
-=item B<%%>
-
-A literal `%' character.
-
-=back
+B<%%> - A literal `%' character.
 
 =item B<PRINT:>I<vname>B<:>I<CF>B<:>I<format>
 
@@ -209,9 +135,9 @@ The first form of this command is to be used with B<CDEF> I<vname>s.
 
 =back
 
-=head1 GRAPH
+=head2 GRAPH
 
-=over 4
+=over
 
 =item B<GPRINT>B<:>I<vname>B<:>I<format>
 
@@ -279,28 +205,6 @@ week. Make sure to tell the viewer of your graph you did this ...
 As with the other graphing elements, you can specify a number or
 a variable here.
 
-=cut
-
-# This section describes the curruently defunct
-# PieChart code.
-#
-# =item B<PART>B<:>I<vname>B<#>I<rrggbb>[I<aa>][B<:>I<legend>]
-#
-# B<RRDtool> has now support for B<pie charts>. If you include the
-# B<PART> command, the canvas is extended to make room for a chart.
-# The size of the canvas is determined by the lesser of
-# L<width and height|rrdgraph/item_Size>.
-#
-# Pie parts will be concatenated, the first one will start at the
-# top and parts will be created clockwise.  The size of the part
-# is defined by the value part of the L<VDEF|rrdgraph_data/VDEF>
-# function.  It should return a number between 0 and 100, being a
-# percentage.  Providing wrong input will produce undefined results.
-#
-#
-
-=pod
-
 =item B<STACK>B<:>I<vname>B<#>I<color>[B<:>I<legend>]
 
 I<Deprecated.  Use the B<STACK> modifiers on the other commands.>
diff --git a/doc/rrdgraph_rpn.pod b/doc/rrdgraph_rpn.pod
index b2a84dd..454f736 100644
--- a/doc/rrdgraph_rpn.pod
+++ b/doc/rrdgraph_rpn.pod
@@ -66,8 +66,6 @@ mean that any value other than 0 is considered to be true.
 
 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
 
-Z<>
-
 =item Comparing values
 
 B<MIN, MAX>
@@ -91,8 +89,6 @@ will always return an I<unknown>
 Example: C<CDEF:a=alpha,0,100,LIMIT> will return I<unknown> if
 alpha is lower than 0 or if it is higher than 100.
 
-Z<>
-
 =item Arithmetics
 
 B<+, -, *, /, %>
@@ -234,8 +230,6 @@ B<DUP, POP, EXC>
 Duplicate the top element, remove the top element, exchange the two
 top elements.
 
-Z<>
-
 =back
 
 =head1 VARIABLES
diff --git a/doc/rrdtutorial.pod b/doc/rrdtutorial.pod
index 30a4868..1ccfa37 100644
--- a/doc/rrdtutorial.pod
+++ b/doc/rrdtutorial.pod
@@ -114,7 +114,7 @@ By following the examples you get some hands-on experience and, even
 more important, some background information of how it works.
 
 You will need to know something about hexadecimal numbers. If you don't
-then start with reading L<bin_dec_hex> before you continue here.
+then start with reading bin_dec_hex tutorial before you continue here.
 
 =head2 Your first Round Robin Database
 
-- 
2.30.2