Skip to content

Commit

Permalink
clarify exportdb and importdb documentation, prepare man pages for ve…
Browse files Browse the repository at this point in the history
…rsion 1.14
  • Loading branch information
vergoh committed Apr 26, 2015
1 parent 602d989 commit 378f78c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
24 changes: 15 additions & 9 deletions man/vnstat.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/vnstat.conf.5
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/vnstatd.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/vnstati.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 378f78c

Please sign in to comment.