From 378f78ca44eab8983ab2f57a8f6d71b6a42e4846 Mon Sep 17 00:00:00 2001 From: Teemu Toivola Date: Sun, 26 Apr 2015 17:44:08 +0300 Subject: [PATCH] clarify exportdb and importdb documentation, prepare man pages for version 1.14 --- man/vnstat.1 | 24 +++++++++++++++--------- man/vnstat.conf.5 | 2 +- man/vnstatd.1 | 2 +- man/vnstati.1 | 2 +- 4 files changed, 18 insertions(+), 12 deletions(-) diff --git a/man/vnstat.1 b/man/vnstat.1 index ef5c5f3..29c4c77 100644 --- a/man/vnstat.1 +++ b/man/vnstat.1 @@ -1,4 +1,4 @@ -.TH VNSTAT 1 "JANUARY 2015" "version 1.13" "User Manuals" +.TH VNSTAT 1 "APRIL 2015" "version 1.14" "User Manuals" .SH NAME vnstat \- a console-based network traffic monitor @@ -184,12 +184,18 @@ to the up script. These two options aren't needed when the daemon is used. .TP .B "--exportdb" -Instead of showing the database with a formated output, this output will -dump the whole database in a format that should be easy to parse with most -script languages or imported back using the +Instead of showing the database with a formatted output, this output will +dump the whole database in a plain text based architeture independent format. +The output can be imported back using the .B "--importdb" -option. Use this for example with PHP, Perl or Python to make a -custom webpage. The dump uses ; as field delimeter. +option and can be used for moving a database from one host to another. See the +.B "--importdb" +documentation below for an example. Using the output for scripting is possible but +the outputs of +.B "--xml" +and +.B "--json" +are likely to be more suitable. The dump uses ; as field delimeter. .TS l l. active;1 activity status @@ -235,10 +241,10 @@ Import a database from which was previously exported using the .B "--exportdb" option. This can be used to transfer a database between different architectures and -machines, as the database is architecture dependant and not compatible between -different architectures. First dump the database on one machine, e.g. with +hosts, as the database is architecture dependant and not compatible between +different architectures. First dump the database on one host, e.g. with .B "vnstat -i ppp0 --exportdb >ppp0db.txt" -and then import the text file on a different machine using +and then import the text file on a different host using .B "vnstat -i ppp0 --importdb ppp0db.txt" .TP diff --git a/man/vnstat.conf.5 b/man/vnstat.conf.5 index 105f609..d168b9a 100644 --- a/man/vnstat.conf.5 +++ b/man/vnstat.conf.5 @@ -1,4 +1,4 @@ -.TH VNSTAT.CONF 5 "JANUARY 2015" "version 1.13" "User Manuals" +.TH VNSTAT.CONF 5 "APRIL 2015" "version 1.14" "User Manuals" .SH NAME vnstat.conf \- vnStat configuration file diff --git a/man/vnstatd.1 b/man/vnstatd.1 index 58e15e7..1ca7294 100644 --- a/man/vnstatd.1 +++ b/man/vnstatd.1 @@ -1,4 +1,4 @@ -.TH VNSTATD 1 "JANUARY 2015" "version 1.13" "User Manuals" +.TH VNSTATD 1 "APRIL 2015" "version 1.14" "User Manuals" .SH NAME vnstatd \- daemon based database updating for vnStat diff --git a/man/vnstati.1 b/man/vnstati.1 index 0715d23..36c4d74 100644 --- a/man/vnstati.1 +++ b/man/vnstati.1 @@ -1,4 +1,4 @@ -.TH VNSTATI 1 "JANUARY 2015" "version 1.13" "User Manuals" +.TH VNSTATI 1 "APRIL 2015" "version 1.14" "User Manuals" .SH NAME vnstati \- png image output support for vnStat -- 2.40.0