collectdctl: Make output format of 'show' configurable.

[collectd.git] / src / collectdctl.pod

diff --git a/src/collectdctl.pod b/src/collectdctl.pod
index 4c5c357ca5a3df1501679527bec528b1f3ee7f86..58e1f7dc65590e9aac362d0dab1e89fc2e168de5 100644 (file)
--- a/src/collectdctl.pod
+++ b/src/collectdctl.pod
@@ -96,6 +96,7 @@ data-set definition specified by the type as given in the identifier (see
 L<types.db(5)> for details).
 
 =item B<show> [I<E<lt>SelectionE<gt>>] [I<E<lt>AggregationE<gt>> I<E<lt>GroupingE<gt>>]
+[I<E<lt>FormatE<gt>>]
 
 Show values or an aggregation of values. The I<Selection> selects which values
 to show. The selection consists of the five options B<host>, B<plugin>,
@@ -159,6 +160,23 @@ or by adding B<type> to the B<group> option (e.g. C<group=type>).
 
 =back
 
+The output formatting may be specified using the B<format=>I<format> option.
+The following formats are available:
+
+=over 4
+
+=item B<table> (default)
+
+Output an aligned table formatted using ASCII characters.
+
+=item B<latex>
+
+Output a table intended to be included in a LaTeX document. This is not a
+complete document. In order to compile the document, you have to have a
+complete document wrapper.
+
+=back
+
 Example: Print the minimum, average and maximum time spent in each CPU state
 for all your web servers: