- New
- Detection of 32-bit / 64-bit kernel interface counters for improving
traffic calculations in rollover situations, cfg: 64bitInterfaceCounters
- - Possibility for queries to merge data from multiple interfaces to one
+ - Possibility in queries to merge data from multiple interfaces to one
output with interface1+interface2 syntax
- Highlight current day in top list when visible
# Compiling the binaries
This source package contains the required source files for vnStat including
-the daemon (vnstatd) and image output (vnstati). Executing
+the daemon (`vnstatd`) and image output (`vnstati`). Executing
./configure --prefix=/usr --sysconfdir=/etc && make
If there were no errors, vnStat binaries, man pages and a configuration
file should now be installed. The configuration file will be upgraded using
previously configured values if it is found already to exist. A backup
-of the previous configuration file will be named as `vnstat.conf.old`.
+of the previous configuration file will be named as `vnstat.conf.old` in the
+current directory.
The configuration file `/etc/vnstat.conf` should be checked at this point.
See the `vnstat.conf` man page for documentation about available options.
This step isn't mandatory for using vnStat.
The source package includes a test suite for validating many of the
-functionalities provided by the executables. The test suite requires the
-Check unit testing framework ( https://libcheck.github.io/check/ ) to be
+functionalities provided and used by the executables. The test suite requires
+the Check unit testing framework ( https://libcheck.github.io/check/ ) to be
installed and available. Depending on the used distribution, the necessary
package to be installed is usually called `check` and may also require
-`check-devel` to be installed if available. After the configure script has
+`check-devel` to be installed if available. After the `./configure` script has
been executed the test suite can be executed with:
make check
# Compiling the binaries
This source package contains the required source files for vnStat including
-the daemon (`vnstatd`) and image output (vnstati). Executing
+the daemon (`vnstatd`) and image output (`vnstati`). Executing
./configure && make
If there were no errors, vnStat binaries, man pages and a configuration
file should now be installed. The configuration file will be upgraded using
previously configured values if it is found already to exist. A backup
-of the previous configuration file will be named as `vnstat.conf.old`.
+of the previous configuration file will be named as `vnstat.conf.old` in the
+current directory.
The configuration file `/usr/local/etc/vnstat.conf` should be checked at
this point. See the `vnstat.conf` man page for documentation about available
# Installing without root access
Copy all needed binaries to some directory included in your PATH
-(`~/bin/` is an example) and create the database directory.
+(`~/bin/` is used here as an example) and create the database directory.
cp -v vnstat vnstatd vnstati ~/bin/
cp -v cfg/vnstat.conf ~/.vnstatrc
This step isn't mandatory for using vnStat.
The source package includes a test suite for validating many of the
-functionalities provided by the executables. The test suite requires the
-Check unit testing framework ( https://libcheck.github.io/check/ ) to
+functionalities provided and used by the executables. The test suite requires
+the Check unit testing framework ( https://libcheck.github.io/check/ ) to
be installed and available (usually `devel/check` in ports). The configure
script also assumes that the `pkg-config` command is installed. That command
-is usually part of the `devel/pkgconf` package. After the configure script has
-been executed the test suite can be executed with:
+is usually part of the `devel/pkgconf` package. After the `./configure` script
+has been executed the test suite can be executed with:
make check
-# Uninstall
+# Uninstall
- 1. Stop the daemon (`vnstatd`) if still running
+ 1. Stop the daemon (`vnstatd`) if it is still running
2. Remove any manually installed service files or file entries
used to start the daemon
3. Run `make uninstall` and follow the instructions
- 4. Remove possible database directory if no longer needed
+ 4. Remove the database directory if no longer needed, the
+ command of the previous step will not touch any collected data
# Upgrading from versions 1.3 and later
+All past versions starting from 1.3 can be upgraded directly to the current
+version without having to use any intermediate versions.
+
1. Follow the normal install procedure, `make install` step will upgrade the
configuration file if it exists in the usual location. All user settings
- will be kept. However, unidentified content will get cleaned away.
+ will be kept. However, unidentified content, such as unknown keywords
+ and additional comments, will get cleaned away.
- 2. Review the updated configuration file. Refer to the `vnstat.conf` man page
- for more detailed documentation regarding each setting.
+ 2. Review the updated configuration file. Refer to comments in the file and
+ the `vnstat.conf` man page for documentation regarding each setting.
3. After the configuration file has been updated, restart the daemon
(`vnstatd`) or configure it to use if not previously done already. Note
- that using cron based updates are no longer supported and such commands
- should be removed if still existing.
+ that using a cron entry for updates (something like `vnstat -u`) is no
+ longer supported and such commands should be removed if still existing.
4. Upgrades from 1.x to 2.x will result in data being imported from the
legacy databases of each interface during the first start of the new
-# vnStat 2.1 config file
+# vnStat 2.2 config file
##
# default interface
-.TH VNSTAT 1 "DECEMBER 2018" "version 2.1" "User Manuals"
+.TH VNSTAT 1 "APRIL 2019" "version 2.2" "User Manuals"
.SH NAME
vnstat \- a console-based network traffic monitor
-.TH VNSTAT.CONF 5 "DECEMBER 2018" "version 2.1" "User Manuals"
+.TH VNSTAT.CONF 5 "APRIL 2019" "version 2.2" "User Manuals"
.SH NAME
vnstat.conf \- vnStat configuration file
-.TH VNSTATD 1 "DECEMBER 2018" "version 2.1" "User Manuals"
+.TH VNSTATD 1 "APRIL 2019" "version 2.2" "User Manuals"
.SH NAME
vnstatd \- daemon based database updating for vnStat
-.TH VNSTATI 1 "DECEMBER 2018" "version 2.1" "User Manuals"
+.TH VNSTATI 1 "APRIL 2019" "version 2.2" "User Manuals"
.SH NAME
vnstati \- png image output support for vnStat
projects / vnstat / commitdiff