"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/vnstati.1" between
vnstat-2.8.tar.gz and vnstat-2.9.tar.gz

About: vnStat is a console-based network traffic monitor (using the /proc filesystem).

vnstati.1  (vnstat-2.8):vnstati.1  (vnstat-2.9)
VNSTATI(1) User Manuals VNSTATI(1) VNSTATI(1) User Manuals VNSTATI(1)
NAME NAME
vnstati - png image output support for vnStat vnstati - image output support for vnStat
SYNOPSIS SYNOPSIS
vnstati [-5bcdDehiLmosStvy?] [-5g [limit] [height]] [--altdate] [--begin date] [--cache time] [--config vnstati [-5bcdDehiLmosStvy?] [-5g [limit] [height]] [--altdate] [--begin date] [--cache time] [--config
file] [--days [limit]] [--dbdir directory] [--debug] [--end date] [ --fivegraph [limit] [height]] file] [--days [limit]] [--dbdir directory] [--debug] [--end date] [ --fivegraph [limit] [height]]
[--fiveminutes [limit]] [--headertext text] [--help] [-hg] [--hours [--fiveminutes [limit]] [--headertext text] [--help] [-hg [mode]]
[limit]] [--hoursgraph] [-hs [--hours [limit]] [--hoursgraph
[graph]] [--hsummary [graph]] [-i interface] [--iface interface] [--larg [mode]] [-hs [graph]] [--hsummary [graph]] [-i interface] [--iface interf
e] [--limit limit] [--locale ace] [--large] [--limit limit]
locale] [--months [limit]] [-ne] [-nh] [-nl] [--noedge] [--noheader] [- [--locale locale] [--months [limit]] [-ne] [-nh] [-nl] [--noedge] [--n
-nolegend] [--output file] [-ru oheader] [--nolegend] [--output
[mode]] [--rateunit [mode]] [--scale percent] [--small] [--style number] file] [-ru [mode]] [--rateunit [mode]] [--scale percent] [--small] [--sty
[--summary] [--top [limit]] le number] [--summary] [--top
[--transparent [enabled]] [--version] [-vs [graph]] [--vsummary [graph]] [limit]] [--transparent [enabled]] [--version] [-vs [graph]] [--vsumm
[--months [limit]] [interface] ary [graph]] [--months [limit]]
[interface]
DESCRIPTION DESCRIPTION
The purpose of vnstati is to provide image output support for statistics collected using vnstat(1). The The purpose of vnstati is to provide image output support for statistics collected using vnstat(1). The
image file format is limited to png. All basic outputs of vnStat are supp available image file formats depend on what is supported by the used G
orted excluding live traffic D library. All basic outputs of
features. The image can be outputted either to a file or to standard outp vnStat are supported excluding live traffic features. The image can be ou
ut. tputted either to a file or to
standard output, with the later being limited to png image format.
OPTIONS OPTIONS
--altdate --altdate
Use alternative date and time text location. The date and time te xt will be moved from the upper Use alternative date and time text location. The date and time te xt will be moved from the upper
right header section to the lower left corner. This option will ha ve no effect if -nh, --noheader right header section to the lower left corner. This option will ha ve no effect if -nh, --noheader
has been selected. has been selected.
-b, --begin date -b, --begin date
Begin the list output with a specific date / time defined by date instead of the begin being Begin the list output with a specific date / time defined by date instead of the begin being
selected based on the number of entries to be shown. If date isn' t available in the database selected based on the number of entries to be shown. If date isn' t available in the database
then the closest later date will be used. date supports the foll then the closest later date will be used. date supports the follo
owing formats: YYYY-MM-DD HH:MM wing formats: YYYY-MM-DD HH:MM,
and YYYY-MM-DD. This option can only be used with list outputs. YYYY-MM-DD and "today". This option can only be used with list ou
tputs.
-c, --cache time -c, --cache time
Update output file only if at least time minutes have passed since the previous file update. This Update output file only if at least time minutes have passed since the previous file update. This
option is ignored if stdout is used as output. option is ignored if stdout is used as output.
--config file --config file
Use file as configuration file instead of using automatic config uration file search functional- Use file as configuration file instead of using automatic config uration file search functional-
ity. ity.
-d, --days [limit] -d, --days [limit]
skipping to change at line 82 skipping to change at line 84
Show text in image header section instead of automatically gene rated interface identification. Show text in image header section instead of automatically gene rated interface identification.
text is limited to 64 characters and may not get completely shown if longer than the width of the text is limited to 64 characters and may not get completely shown if longer than the width of the
image. Use with --altdate if maximal space is needed. This opt ion will have no effect if -nh, image. Use with --altdate if maximal space is needed. This opt ion will have no effect if -nh,
--noheader has been selected. --noheader has been selected.
-h, --hours [limit] -h, --hours [limit]
Output traffic statistics on a hourly basis. The length of the lis t will be limited to 24 entries Output traffic statistics on a hourly basis. The length of the lis t will be limited to 24 entries
unless configured otherwise or unless the optional limit paramete r is used. All entries store in unless configured otherwise or unless the optional limit paramete r is used. All entries store in
the database will be shown if the limit is set to 0. the database will be shown if the limit is set to 0.
-hg, --hoursgraph -hg, --hoursgraph [mode]
Output traffic statistics on a hourly basis for the last 24 hours Output traffic statistics on a hourly basis for the last 24 hou
using a bar graph. rs using a bar graph. The
optional mode parameter can be used to override the configuration
file setting. Available modes:
0 = 24 hour sliding window, 1 = graph begins from midnight.
-hs, --hsummary [graph] -hs, --hsummary [graph]
Output traffic summary with the graph selected using the SummaryGr aph setting in the configura- Output traffic summary with the graph selected using the SummaryGr aph setting in the configura-
tion file next to it using a horizontal layout. The optional graph parameter can be used to over- tion file next to it using a horizontal layout. The optional graph parameter can be used to over-
ride the configuration file setting. Available graphs: 0 = hours, 1 = 5 minutes. ride the configuration file setting. Available graphs: 0 = hours, 1 = 5 minutes.
-i, --iface interface -i, --iface interface
Use interface instead of default or configured interface. It is al so possible to merge the infor- Use interface instead of default or configured interface. It is al so possible to merge the infor-
mation of two or more interfaces using the interface1+interf mation of two or more interfaces using the interface1+interface2+.
ace2+... syntax. All provided .. syntax. All provided inter-
interfaces must be unique and must exist in the database when the faces must be unique and must exist in the database when the merge
merge syntax is used. syntax is used. Optionally,
depending on the InterfaceMatchMethod configuration setting, inter
face can be replaced with alias
previously set using vnstat --setalias. Merge syntax isn't suppor
ted when alias is used. The -i,
--iface option is optional and interface can be used as parameter
on the command line for select-
ing the used interface even without the option being explicitly us
ed.
-L, --large -L, --large
Use large fonts in output. Use large fonts in output.
--limit limit --limit limit
Set the maximum number of shown entries in list outputs to limit. Usage of --limit overrides the Set the maximum number of shown entries in list outputs to limit. Usage of --limit overrides the
default list entry limit values and the optional limit parameter g iven directly for a list query. default list entry limit values and the optional limit parameter g iven directly for a list query.
All entries stored in the database will be shown if limit is set t o 0. All entries stored in the database will be shown if limit is set t o 0.
--locale locale --locale locale
skipping to change at line 123 skipping to change at line 131
Remove darker edges from around the image. Remove darker edges from around the image.
-nh, --noheader -nh, --noheader
Remove header containing title and update time. Time of the previo us update will still be visible Remove header containing title and update time. Time of the previo us update will still be visible
in the lower right corner using a less visible color. in the lower right corner using a less visible color.
-nl, --nolegend -nl, --nolegend
Remove legend containing rx and tx color mapping information from the image. Remove legend containing rx and tx color mapping information from the image.
-o, --output file -o, --output file
Write png image to file and exit. Output can be directed to stdout Write image to file and exit. The used image format is selected by
by giving "-" as filename. the given file extension of
file. For example, "image.png" results in the file getting wri
tten using the png image format
due to the ".png" extension having been used. Usage of png image f
ormat usually results in the
smallest file size without loss of detail or introduction of
compression artifacts. Alterna-
tively, output can be directed to stdout by giving "-" as file in
which case png image format is
used.
-ru, --rateunit [mode] -ru, --rateunit [mode]
Swap the configured rate unit. If rate has been configured to be s hown in bytes then rate will be Swap the configured rate unit. If rate has been configured to be s hown in bytes then rate will be
shown in bits if this option is present. In the same way, if rate has been configured to be shown shown in bits if this option is present. In the same way, if rate has been configured to be shown
in bits then rate will be shown in bytes when this option is prese in bits then rate will be shown in bytes when this option is pr
nt. Alternatively, mode with esent. Alternatively, mode with
either 0 or 1 can be used as parameter for this option in order either 0 or 1 can be used as parameter for this option in order to
to select between bytes (0) and select between bytes (0) and
bits (1) regardless of the configuration file setting. bits (1) regardless of the configuration file setting.
--scale percent --scale percent
Scale output to given percent resulting in the image being either smaller or larger than the Scale output to given percent resulting in the image being ei ther smaller or larger than the
default size. default size.
-S, --small -S, --small
Use small fonts in output. Use small fonts in output.
--style number --style number
Modify the content and style of outputs. Setting number to 3 wi ll show average traffic rate in Modify the content and style of outputs. Setting number to 3 will show average traffic rate in
all outputs where it is supported. Other values will show bar gra phics instead. all outputs where it is supported. Other values will show bar gra phics instead.
-s, --summary -s, --summary
Output traffic statistics summary. Output traffic statistics summary.
-t, --top [limit] -t, --top [limit]
Output all time top traffic days. The length of the list will be l Output all time top traffic days. The length of the list will
imited to 10 entries unless be limited to 10 entries unless
configured otherwise or unless the optional limit parameter is configured otherwise or unless the optional limit parameter is use
used. All entries stored in the d. All entries stored in the
database will be shown if limit is set to 0. When used with --begi database will be shown if limit is set to 0. When used with --b
n and optionally with --end, egin and optionally with --end,
the list will be generated using the daily data instead of separa the list will be generated using the daily data instead of separat
te top entries. The availabil- e top entries. The availabil-
ity of daily data defines the boundaries the date specific query c an access. ity of daily data defines the boundaries the date specific query c an access.
--transparent [enabled] --transparent [enabled]
Toggle background color transparency depending of the TransparentB Toggle background color transparency depending of the Transparent
g setting in the configuration Bg setting in the configuration
file. Alternatively, 0 or 1 can be given as parameter enabled for file. Alternatively, 0 or 1 can be given as parameter enabled for
this option in order to either this option in order to either
disable (0) or enable (1) transparency regardless of the configura tion file setting. disable (0) or enable (1) transparency regardless of the configura tion file setting.
-v, --version -v, --version
Show current version. Show current version.
-vs, --vsummary [graph] -vs, --vsummary [graph]
Output traffic summary with the graph selected using the SummaryGr Output traffic summary with the graph selected using the Summary
aph setting in the configura- Graph setting in the configura-
tion file below it using a vertical layout. The optional graph pa tion file below it using a vertical layout. The optional graph par
rameter can be used to override ameter can be used to override
the configuration file setting. Available graphs: 0 = hours, 1 = 5 minutes. the configuration file setting. Available graphs: 0 = hours, 1 = 5 minutes.
-y, --years [limit] -y, --years [limit]
Output traffic statistics on a yearly basis for the last years. Th e list will show all entries by Output traffic statistics on a yearly basis for the last years. Th e list will show all entries by
default unless configured otherwise or unless the optional limit parameter is used. All entries default unless configured otherwise or unless the optional limit p arameter is used. All entries
stored in the database will also be shown if limit is set to 0. stored in the database will also be shown if limit is set to 0.
-?, --help -?, --help
Show a command option summary. Show a command option summary.
FILES FILES
/var/lib/vnstat/ /var/lib/vnstat/
Default database directory. Default database directory.
/etc/vnstat.conf /etc/vnstat.conf
Config file that will be used unless $HOME/.vnstatrc exists. See v nstat.conf(5) for more informa- Config file that will be used unless $HOME/.vnstatrc exists. See v nstat.conf(5) for more informa-
tion. tion.
EXAMPLES EXAMPLES
vnstati -s -i eth0 -o /tmp/vnstat.png vnstati -s -i eth0 -o /tmp/vnstat.png
Output traffic summary for interface eth0 to file /tmp/vnstat.png. Output traffic summary for interface eth0 to file /tmp/vnstat.png.
vnstati -vs -i eth0+eth1+eth2 -o /tmp/vnstat.png vnstati -vs -i eth0+eth1+eth2 -o /tmp/vnstat.png
Output traffic summary with hourly data under the normal summary for a merge of interfaces eth0, Output traffic summary with hourly data under the normal summary f or a merge of interfaces eth0,
eth1 and eth2 to file /tmp/vnstat.png. eth1 and eth2 to file /tmp/vnstat.png.
vnstati -h -c 15 -o /tmp/vnstat_h.png vnstati -h -c 15 -o /tmp/vnstat_h.png
Output hourly traffic statistics for default interface to file /tm p/vnstat_h.png if the file has Output hourly traffic statistics for default interface to file /t mp/vnstat_h.png if the file has
not been updated within the last 15 minutes. not been updated within the last 15 minutes.
vnstati -d -ne -nh -o - vnstati -d -ne -nh -o -
Output daily traffic statistics without displaying the heade r section and edges for default Output daily traffic statistics without displaying the header se ction and edges for default
interface to standard output (stdout). interface to standard output (stdout).
vnstati -m --config /home/me/vnstat.cfg -i -o - vnstati -m --config /home/me/vnstat.cfg -i -o -
Output monthly traffic statistics for default interface spe cified in configuration file Output monthly traffic statistics for default interface spe cified in configuration file
/home/me/vnstat.cfg to standard output (stdout). /home/me/vnstat.cfg to standard output (stdout).
RESTRICTIONS RESTRICTIONS
Depending on the built-in fonts provided by the GD library, not all c haracters may end up shown cor- Depending on the built-in fonts provided by the GD library, not all chara cters may end up shown cor-
rectly when a UTF-8 locale is used. rectly when a UTF-8 locale is used.
Using long date output formats may cause misalignment in shown columns if the length of the date exceeds Using long date output formats may cause misalignment in shown columns if the length of the date exceeds
the fixed size allocation. the fixed size allocation.
Scaling an image when background transparency is enabled may not result i n transparency being retained. Scaling an image when background transparency is enabled may not result i n transparency being retained.
AUTHOR AUTHOR
Teemu Toivola <tst at iki dot fi> Teemu Toivola <tst at iki dot fi>
SEE ALSO SEE ALSO
vnstat(1), vnstatd(8), vnstat.conf(5), units(7) vnstat(1), vnstatd(8), vnstat.conf(5), units(7)
version 2.8 SEPTEMBER 2021 VNSTATI(1) version 2.9 JANUARY 2022 VNSTATI(1)
 End of changes. 19 change blocks. 
54 lines changed or deleted 77 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)