vnStat - a network traffic monitor for Linux and BSD
C Makefile Shell Other
Permalink
Failed to load latest commit information.
cfg bump version to 1.17 beta Dec 24, 2016
examples add example perl and php scripts for json output Jan 13, 2015
man documentation update Feb 7, 2017
src import refactored bandwidth limit handling from sqldb branch Feb 7, 2017
tests import refactored bandwidth limit handling from sqldb branch Feb 7, 2017
.gitignore fix potentially unassigned variable use, add check test result files … Apr 12, 2016
.travis.yml fix Travis commands Oct 20, 2015
CHANGES final preparations for version 1.17 release Feb 16, 2017
COPYING update FSF address in license texts Feb 7, 2017
FAQ remove forum links, fix indentation, freshmeat -> freecode Feb 26, 2014
INSTALL final preparations for version 1.16 release Dec 24, 2016
INSTALL_BSD update documentation Dec 23, 2016
INSTALL_OSX update binary paths in BSD and OS X documentation, closes #37 Jan 12, 2016
Makefile.am remove unnecessary autoconf macros, add check for cross-compiling and… Dec 26, 2016
Makefile.in fix cross-compilation detection, resolves #53 Dec 27, 2016
README more documentation updates Apr 26, 2015
UNINSTALL update documentation Dec 23, 2016
UPGRADE documentation update Feb 7, 2017
aclocal.m4 refactor function file locations Dec 19, 2016
compile fix cross-compilation detection, resolves #53 Dec 27, 2016
config.guess fix cross-compilation detection, resolves #53 Dec 27, 2016
config.sub fix cross-compilation detection, resolves #53 Dec 27, 2016
configure final preparations for version 1.17 release Feb 16, 2017
configure.ac final preparations for version 1.17 release Feb 16, 2017
depcomp fix cross-compilation detection, resolves #53 Dec 27, 2016
install-sh fix cross-compilation detection, resolves #53 Dec 27, 2016
missing fix typo in version string, provide some setup information after runn… Dec 8, 2015
test-driver fix typo in version string, provide some setup information after runn… Dec 8, 2015

README

What is vnStat
::::::::::::::

 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.


Getting started
:::::::::::::::

 vnStat works best when installed. See the INSTALL or INSTALL_BSD file
 depending on used operating system. Experimental instructions for OS X
 are available in the INSTALL_OSX file. These files contain all needed
 information for the installing process. Instructions for upgrading from
 a previous version are included in the UPGRADE file.


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 of each option
 including some usage examples:

    vnstat          general documentation and console query parameters
    vnstatd         daemon documentation
    vnstati         image output documentation
    vnstat.conf     configuration file


Usage tips
::::::::::

 Most vnStat settings can be changed from the config file. The config
 file is either ~/.vnstatrc or /etc/vnstat.conf depending which one is
 found first. A new config file can be generated using current settings
 with the following command:

    vnstat --showconfig >newconfig

 The config file contains comments before any settings describing with
 the purpose and usage of each setting is. More detailed descriptions
 about each setting and suggested usage can be found from the vnstat.conf
 man page.


Contacting the author
:::::::::::::::::::::

 email:    Teemu Toivola <tst at iki dot fi>
 irc:      Vergo (IRCNet)

 git:      https://github.com/vergoh/vnstat

 The current version of vnStat is always available from
 http://humdi.net/vnstat/