From 65111a2a9b06f133fa104fe1d81d96b090bc4a68 Mon Sep 17 00:00:00 2001
From: Teemu Toivola <git@humdi.net>
Date: Tue, 13 Jan 2015 18:08:19 +0200
Subject: [PATCH] update documentation

---
 CHANGES           |  1 +
 README            | 24 ++++++++++++++++--------
 UPGRADE           |  2 ++
 man/vnstat.1      | 13 ++++++++++++-
 man/vnstat.conf.5 |  2 +-
 man/vnstatd.1     |  2 +-
 man/vnstati.1     |  2 +-
 7 files changed, 34 insertions(+), 12 deletions(-)

diff --git a/CHANGES b/CHANGES
index 8033595..5c8ad4d 100644
--- a/CHANGES
+++ b/CHANGES
@@ -12,6 +12,7 @@
  - Import Makefile improvements from OpenBSD
    (pull requests by Jasper Lievisse Adriaanse)
  - Automatic interface bandwidth detection, BandwidthDetection in config
+ - JSON output (--json)
 
 
 1.12 / 30-Aug-14
diff --git a/README b/README
index 8042e05..d012ef7 100644
--- a/README
+++ b/README
@@ -2,11 +2,18 @@
 What is vnStat
 ::::::::::::::
 
- In short, vnStat is a console-based network traffic monitor that uses the
- network interface statistics provided by the kernel as information source.
- This means that vnStat won't actually be sniffing any traffic and also
- ensures light use of system resources. Optional image output is available
- starting from version 1.7.
+ vnStat is a console-based network traffic monitor that uses the network
+ interface statistics provided by the kernel as information source. This
+ means that vnStat won't actually be sniffing any traffic and also ensures
+ light use of system resources.
+
+ Traffic statistics are stored on a hourly level for the last 24 hours,
+ on a daily level for the last 30 days and on a monthly level for the
+ last 12 months. Total seen traffic and a top 10 days listing is also
+ provided.
+
+ Optional png image output is available in systems with the gd library
+ installed.
 
  See the webpage http://humdi.net/vnstat/ for output examples.
 
@@ -14,8 +21,8 @@ What is vnStat
 Getting started
 :::::::::::::::
 
- First you should install vnStat. See the INSTALL or INSTALL_BSD file
- depending on used operating system, it contains all needed information
+ vnStat works best when installed. See the INSTALL or INSTALL_BSD file
+ depending on used operating system. It contains all needed information
  for the installing process. Instructions for upgrading from a previous
  version are included in the UPGRADE file.
 
@@ -25,7 +32,8 @@ Available options and documentation
 
  A list of commonly used options is available with 'vnstat --help'. The
  complete list can be accessed with 'vnstat --longhelp'. The following
- man pages are available with more detailed descriptions:
+ man pages are available with more detailed descriptions of each option
+ including some usage examples:
  
     vnstat          general documentation and console query parameters
     vnstatd         daemon documentation
diff --git a/UPGRADE b/UPGRADE
index c9c9344..757a2ef 100644
--- a/UPGRADE
+++ b/UPGRADE
@@ -2,6 +2,8 @@
 New configuration settings
 ::::::::::::::::::::::::::
 
+1.13: BandwidthDetection, BandwidthDetectionInterval
+
 1.12: DaemonUser, DaemonGroup, CreateDirs, UpdateFileOwner
 
 1.10 - 1.11: (none)
diff --git a/man/vnstat.1 b/man/vnstat.1
index cb9814e..ae5d5b0 100644
--- a/man/vnstat.1
+++ b/man/vnstat.1
@@ -1,4 +1,4 @@
-.TH VNSTAT 1 "AUGUST 2014" "version 1.12" "User Manuals"
+.TH VNSTAT 1 "JANUARY 2015" "version 1.13" "User Manuals"
 .SH NAME
 
 vnstat \- a console-based network traffic monitor
@@ -46,6 +46,8 @@ vnstat \- a console-based network traffic monitor
 ] [
 .B \-\-iflist
 ] [
+.B \-\-json
+] [
 .B \-\-live
 .I mode
 ] [
@@ -250,6 +252,11 @@ syntax.
 .B "--iflist"
 Show list of currently available interfaces.
 
+.TP
+.B "--json"
+Show database content for selected interface or all interfaces in json format. All
+traffic values in the output are in KiB.
+
 .TP
 .BI "-l, --live " mode
 Display current transfer rate for the selected interface in real time
@@ -428,6 +435,10 @@ Display traffic summary for a merge of interfaces eth0, eth1 and eth3.
 .B "vnstat -i eth2 --xml"
 Output all information about interface eth2 in xml format.
 
+.TP
+.B "vnstat --json"
+Output all information of all monitored interfaces in json format.
+
 .TP
 .B "vnstat -u -i eth0"
 Force a database update for interface eth0 or create the database if it doesn't
diff --git a/man/vnstat.conf.5 b/man/vnstat.conf.5
index 3f1dd42..105f609 100644
--- a/man/vnstat.conf.5
+++ b/man/vnstat.conf.5
@@ -1,4 +1,4 @@
-.TH VNSTAT.CONF 5 "AUGUST 2014" "version 1.12" "User Manuals"
+.TH VNSTAT.CONF 5 "JANUARY 2015" "version 1.13" "User Manuals"
 .SH NAME
 
 vnstat.conf \- vnStat configuration file
diff --git a/man/vnstatd.1 b/man/vnstatd.1
index 34499a0..58e15e7 100644
--- a/man/vnstatd.1
+++ b/man/vnstatd.1
@@ -1,4 +1,4 @@
-.TH VNSTATD 1 "AUGUST 2014" "version 1.12" "User Manuals"
+.TH VNSTATD 1 "JANUARY 2015" "version 1.13" "User Manuals"
 .SH NAME
 
 vnstatd \- daemon based database updating for vnStat
diff --git a/man/vnstati.1 b/man/vnstati.1
index 54295b0..b275db1 100644
--- a/man/vnstati.1
+++ b/man/vnstati.1
@@ -1,4 +1,4 @@
-.TH VNSTATI 1 "AUGUST 2014" "version 1.12" "User Manuals"
+.TH VNSTATI 1 "JANUARY 2015" "version 1.13" "User Manuals"
 .SH NAME
 
 vnstati \- png image output support for vnStat
-- 
2.40.0