update install documentation

diff --git a/INSTALL b/INSTALL
index 45ff7810a723c80470f09ea1260a490ca71c35a0..ee15155b444e2386a882564ea0a205cf672d5e9a 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,7 @@
 
+tl;dr: ./configure --prefix=/usr --sysconfdir=/etc && make && make install
+
+
 Prerequisites
 :::::::::::::
 
@@ -7,9 +10,11 @@ Prerequisites
  - user with access to kernel interface statistics
    - usually available by default but can be restricted for example
      by grsecurity and similar security enhancement suites or settings
- - libgd (optional, image output)
- - check (optional, test suite)
- - autotools (optional, for recreating configure and makefiles)
+ - sqlite3     (library and development files)
+ - libgd       (optional, image output)
+ - check       (optional, test suite)
+ - pkg-config  (optional, for check detection)
+ - autotools   (optional, for recreating configure and makefiles)
 
 
 Compiling the binaries
@@ -20,21 +25,9 @@ Compiling the binaries
 
      ./configure --prefix=/usr --sysconfdir=/etc && make
 
- will compile 'vnstat' and 'vnstatd' without requiring additional libraries.
- The optional image output capable binary 'vnstati' will also be compiled if
- the required additional libgd2 library is found to be available. The name
- of the libgd2 package depends on the used distribution and its release. The
- development package for the library is also needed. Some common package
- names are
-
-     gd
-     gd-devel
-     libgd3
-     libgd-dev
-     libgd2
-     libgd2-dev
-     libgd2-noxpm
-     libgd2-noxpm-dev
+ will compile 'vnstat' and 'vnstatd'. The optional image output capable binary
+ 'vnstati' will also be compiled if the required additional libgd library is
+ found to be available.
 
  An example cgi ('vnstat.cgi') to be used with a http server with the image
  output support has been provided in the 'examples' directory. Configuration
@@ -98,7 +91,7 @@ Installing as root
  take some minutes for the 'vnstat' command to begin showing results.
  Monitoring of unwanted interfaces can be stopped with:
 
-     vnstat --delete -i ethunwanted
+     vnstat --remove -i ethunwanted
 
 
 Installing without root access

diff --git a/INSTALL_BSD b/INSTALL_BSD
index 0a1833a73b8de52be7e420b38510315e35cbbc9c..e63017620af5842d558f92770f158b57b0ff65a1 100644 (file)
--- a/INSTALL_BSD
+++ b/INSTALL_BSD
@@ -1,4 +1,7 @@
 
+tl;dr: ./configure && make && make install
+
+
 Prerequisites
 :::::::::::::
 
@@ -6,9 +9,11 @@ Prerequisites
  - C compiler
  - user with access to kernel interface statistics
    - usually available by default but may be restricted by security settings
- - graphics/gd (optional, image output)
- - devel/check (optional, test suite)
- - autotools (optional, for recreating configure and makefiles)
+ - databases/sqlite3
+ - graphics/gd       (optional, image output)
+ - devel/check       (optional, test suite)
+ - devel/pkg-config  (optional, for check detection)
+ - devel/autotools   (optional, for recreating configure and makefiles)
 
 
 Compiling the binaries
@@ -21,8 +26,7 @@ Compiling the binaries
 
  will compile 'vnstat' and 'vnstatd' without requiring additional libraries.
  The optional image output capable binary 'vnstati' will also be compiled if
- the required additional libgd2 library is found to be available. In
- BSD ports libgd2 is usually 'graphics/gd'.
+ the required additional libgd2 library is found to be available.
 
  An example cgi ('vnstat.cgi') to be used with a http server with the image
  output support has been provided in the 'examples' directory. Configuration
@@ -63,7 +67,7 @@ Installing as root
  command to begin showing results. Monitoring of unwanted interfaces
  can be stopped with:
 
-     vnstat --delete -i ethunwanted
+     vnstat --remove -i ethunwanted
 
 
 Installing without root access

diff --git a/README.md b/README.md
index f0a08a7618d62153f7a984413501d11e2588c3d7..fa99c173176c7a202f4545200e53409d6aa08de1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,18 +20,18 @@ vnStat works best when installed. It's possible to either use the latest
 stable release or get the current development version from git.
 
 Stable version
-  1. ``wget http://humdi.net/vnstat/vnstat-latest.tar.gz``
+  1. `wget http://humdi.net/vnstat/vnstat-latest.tar.gz`
   2. optional steps for verifying the file signature
-     1. ``wget http://humdi.net/vnstat/vnstat-latest.tar.gz.asc``
-     2. ``gpg --keyserver pgp.mit.edu --recv-key 0xDAFE84E63D140114``
-     3. ``gpg --verify vnstat-latest.tar.gz.asc vnstat-latest.tar.gz``
+     1. `wget http://humdi.net/vnstat/vnstat-latest.tar.gz.asc`
+     2. `gpg --keyserver pgp.mit.edu --recv-key 0xDAFE84E63D140114`
+     3. `gpg --verify vnstat-latest.tar.gz.asc vnstat-latest.tar.gz`
      4. the signature is correct if the output shows "Good signature from Teemu Toivola"
-  3. ``tar zxvf vnstat-latest.tar.gz``
-  4. ``cd vnstat-*``
+  3. `tar zxvf vnstat-latest.tar.gz`
+  4. `cd vnstat-*`
 
-Development version (not recommended currently, documentation not up to date)
-  1. ``git clone https://github.com/vergoh/vnstat``
-  2. ``cd vnstat``
+Development version
+  1. `git clone https://github.com/vergoh/vnstat`
+  2. `cd vnstat`
 
 In both cases, continue with instructions from the INSTALL or INSTALL_BSD file
 depending on used operating system. Instructions for upgrading from a previous
@@ -108,7 +108,6 @@ durations. Yearly and five-minute resolution statistics are now included.
   * decide if some outputs should be removed
     * `--exportdb` has now a different format which already breaks compatibility, `--json` and `--xml` still available
   * documentation
-    * needs to be updated to match 2.0 feature set and dependency requirements
     * especially feature comparison with 1.x versions is needed as some features have been left out
   * remember what else has been forgotten from this list
 

diff --git a/src/vnstat.c b/src/vnstat.c
index aff14d8eac8baa77dfaae60312e23efdf64f6e3f..9e3bc78a43d052e24aa00ea1d6de5b4938e50a56 100644 (file)
--- a/src/vnstat.c
+++ b/src/vnstat.c
@@ -492,15 +492,15 @@ void showlonghelp(PARAMS *p)
        printf(" vnStat %s by Teemu Toivola <tst at iki dot fi>\n\n", getversion());
 
        printf("   Query:\n");
-       printf("         -q, --query           query database\n");
+       printf("         -q,  --query           query database\n");
        printf("         -5,  --fiveminutes    show 5 minutes\n");
        printf("         -h,  --hours          show hours\n");
        printf("         -hl, --hourslist      show hours list\n");
-       printf("         -d, --days            show days\n");
-       printf("         -m, --months          show months\n");
-       printf("         -y, --years           show years\n");
-       printf("         -t, --top             show top days\n");
-       printf("         -s, --short           use short output\n");
+       printf("         -d,  --days            show days\n");
+       printf("         -m,  --months          show months\n");
+       printf("         -y,  --years           show years\n");
+       printf("         -t,  --top             show top days\n");
+       printf("         -s,  --short           use short output\n");
        printf("         -ru, --rateunit       swap configured rate unit\n");
        printf("         --oneline             show simple parseable format\n");
        printf("         --exportdb            dump database in text format\n");