Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
VNSTATI(1)			 User Manuals			    VNSTATI(1)

NAME
       vnstati - png image output support for vnStat

SYNOPSIS
       vnstati [-5bcdDehiLmosStvy?]  [-5g [limit] [height]] [--altdate]	[--be-
       gin date] [--cache time]	[--config file]	[--days	[limit]] [--dbdir  di-
       rectory]	  [--debug]   [--end   date]  [--fivegraph  [limit]  [height]]
       [--fiveminutes [limit]] [--headertext  text]  [--help]  [-hg]  [--hours
       [limit]]	 [--hoursgraph]	 [-hs [graph]] [--hsummary [graph]] [-i	inter-
       face] [--iface interface] [--large] [--limit limit]  [--locale  locale]
       [--months  [limit]]  [-ne] [-nh]	[-nl] [--noedge] [--noheader] [--nole-
       gend] [--output file] [-ru [mode]] [--rateunit  [mode]]	[--scale  per-
       cent]  [--small]	[--style number] [--summary] [--top [limit]] [--trans-
       parent  [enabled]]  [--version]	[-vs  [graph]]	[--vsummary   [graph]]
       [--months [limit]]

DESCRIPTION
       The  purpose  of	vnstati	is to provide image output support for statis-
       tics collected using vnstat(1).	The image file format  is  limited  to
       png.  All  basic	outputs	of vnStat are supported	excluding live traffic
       features. The image can be outputted either to a	file  or  to  standard
       output.

OPTIONS
       --altdate
	      Use  alternative	date and time text location. The date and time
	      text will	be moved from the upper	right header  section  to  the
	      lower left corner. This option will have no effect if -nh, --no-
	      header has been selected.

       -b, --begin date
	      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
	      then  the	 closest  later	 date will be used.  date supports the
	      following	formats: YYYY-MM-DD HH:MM and YYYY-MM-DD.  This	option
	      can only be used with list outputs.

       -c, --cache time
	      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.

       --config	file
	      Use  file	 as configuration file instead of using	automatic con-
	      figuration file search functionality.

       -d, --days [limit]
	      Output traffic statistics	on a daily basis for  the  last	 days.
	      The length of the	list will be limited to	30 entries unless con-
	      figured otherwise	or unless  the	optional  limit	 parameter  is
	      used.  All entries stored	in the database	will be	shown if limit
	      is set to	0.

       --dbdir directory
	      Use directory as database	directory instead of using the	direc-
	      tory  specified  in  the configuration file or the hardcoded de-
	      fault if no configuration	file is	available.

       -D, --debug
	      Show additional debug output.

       -e, --end date
	      End the list output with a specific date / time defined by  date
	      instead of the latest date / time	in the database. If date isn't
	      available	in the database	then the closest earlier date will  be
	      used.  date supports the following formats: YYYY-MM-DD HH:MM and
	      YYYY-MM-DD.  This	option can only	be used	with list outputs. The
	      top  list	also requires --begin to be used at the	same time with
	      this option.

       -5g, --fivegraph	[limit]	[height]
	      Output traffic statistics	with a 5  minute  resolution  for  the
	      last  48	hours using a bar graph. The width of the graph	can be
	      modified using the optional limit	parameter which	represents the
	      number  of  5  minute entries with 12 entries for	each hour. The
	      smallest supported value is 288 (last 24	hours).	 Additionally,
	      the  height  of  the  graph  can	be modified using the optional
	      height parameter.	The smallest supported height is 150 pixels.

       -5, --fiveminutes [limit]
	      Output traffic statistics	with a 5  minute  resolution  for  the
	      last  hours.   The  length of the	list will be limited to	24 en-
	      tries unless configured otherwise	or unless the  optional	 limit
	      parameter	 is  used.  All	entries	stored in the database will be
	      shown if limit is	set to 0.

       --headertext text
	      Show text	in image header	section	instead	of automatically  gen-
	      erated  interface	identification.	 text is limited to 64 charac-
	      ters and may not get completely shown if longer than  the	 width
	      of  the  image.  Use  with --altdate if maximal space is needed.
	      This option will have no effect if -nh, --noheader has been  se-
	      lected.

       -h, --hours [limit]
	      Output  traffic  statistics on a hourly basis. The length	of the
	      list will	be limited to 24 entries unless	 configured  otherwise
	      or  unless  the  optional	 limit	parameter is used. All entries
	      store in the database will be shown if the limit is set to 0.

       -hg, --hoursgraph
	      Output traffic statistics	on a hourly  basis  for	 the  last  24
	      hours using a bar	graph.

       -hs, --hsummary [graph]
	      Output  traffic summary with the graph selected using the	Summa-
	      ryGraph setting in the configuration file	next  to  it  using  a
	      horizontal  layout.  The optional	graph parameter	can be used to
	      override the configuration file setting. Available graphs:  0  =
	      hours, 1 = 5 minutes.

       -i, --iface interface
	      Use  interface instead of	default	or configured interface. It is
	      also possible to merge the information of	two or more interfaces
	      using  the  interface1+interface2+...  syntax.  All provided in-
	      terfaces must be unique and must exist in	the database when  the
	      merge syntax is used.

       -L, --large
	      Use large	fonts in output.

       --limit limit
	      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 given	directly for a
	      list query. All entries stored in	the database will be shown  if
	      limit is set to 0.

       --locale	locale
	      Use  locale instead of using the locale setting specified	in the
	      configuration file or the	system	default	 if  no	 configuration
	      file is available.

       -m, --months [limit]
	      Output  traffic  statistics  on  a  monthly  basis  for the last
	      months. The length of the	list will be limited to	12 entries un-
	      less configured otherwise	or unless the optional limit parameter
	      is used. All entries stored in the database  will	 be  shown  if
	      limit is set to 0.

       -ne, --noedge
	      Remove darker edges from around the image.

       -nh, --noheader
	      Remove header containing title and update	time. Time of the pre-
	      vious update will	still be visible in the	lower right corner us-
	      ing a less visible color.

       -nl, --nolegend
	      Remove  legend  containing  rx  and tx color mapping information
	      from the image.

       -o, --output file
	      Write png	image to file and exit.	Output can be directed to std-
	      out by giving "-"	as filename.

       -ru, --rateunit [mode]
	      Swap the configured rate unit. If	rate has been configured to be
	      shown 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 in bits then rate will be shown in bytes when this	option
	      is  present.  Alternatively, mode	with either 0 or 1 can be used
	      as parameter for this option in order to	select	between	 bytes
	      (0) and bits (1) regardless of the configuration file setting.

       --scale percent
	      Scale  output  to	given percent resulting	in the image being ei-
	      ther smaller or larger than the default size.

       -S, --small
	      Use small	fonts in output.

       --style number
	      Modify the content and style of outputs.	Setting	 number	 to  3
	      will  show  average traffic rate in all outputs where it is sup-
	      ported.  Other values will show bar graphics instead.

       -s, --summary
	      Output traffic statistics	summary.

       -t, --top [limit]
	      Output all time top traffic days.	The length of the list will be
	      limited  to 10 entries unless configured otherwise or unless the
	      optional limit parameter is used.	 All  entries  stored  in  the
	      database	will  be  shown	 if  limit is set to 0.	When used with
	      --begin and optionally with --end, the list  will	 be  generated
	      using  the  daily	 data  instead	of  separate top entries.  The
	      availability of daily data defines the boundaries	the date  spe-
	      cific query can access.

       --transparent [enabled]
	      Toggle  background color transparency depending of the Transpar-
	      entBg setting in the configuration file. Alternatively, 0	 or  1
	      can  be  given  as parameter enabled for this option in order to
	      either disable (0) or enable (1) transparency regardless of  the
	      configuration file setting.

       -v, --version
	      Show current version.

       -vs, --vsummary [graph]
	      Output  traffic summary with the graph selected using the	Summa-
	      ryGraph setting in the configuration file	below it using a  ver-
	      tical  layout. The optional graph	parameter can be used to over-
	      ride the configuration  file  setting.  Available	 graphs:  0  =
	      hours, 1 = 5 minutes.

       -y, --years [limit]
	      Output  traffic statistics on a yearly basis for the last	years.
	      The list will show all entries by	default	unless configured oth-
	      erwise  or  unless the optional limit parameter is used. All en-
	      tries stored in the database will	also be	shown if limit is  set
	      to 0.

       -?, --help
	      Show a command option summary.

FILES
       /var/lib/vnstat/
	      Default database directory.

       /etc/vnstat.conf
	      Config file that will be used unless $HOME/.vnstatrc exists. See
	      vnstat.conf(5) for more information.

EXAMPLES
       vnstati -s -i eth0 -o /tmp/vnstat.png
	      Output traffic summary  for  interface  eth0  to	file  /tmp/vn-
	      stat.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, eth1 and eth2 to	file  /tmp/vn-
	      stat.png.

       vnstati -h -c 15	-o /tmp/vnstat_h.png
	      Output  hourly  traffic statistics for default interface to file
	      /tmp/vnstat_h.png	if the file has	not been  updated  within  the
	      last 15 minutes.

       vnstati -d -ne -nh -o -
	      Output  daily  traffic  statistics without displaying the	header
	      section and edges	for default interface to standard output (std-
	      out).

       vnstati -m --config /home/me/vnstat.cfg -i -o -
	      Output  monthly  traffic statistics for default interface	speci-
	      fied in configuration file /home/me/vnstat.cfg to	standard  out-
	      put (stdout).

RESTRICTIONS
       Depending  on  the  built-in  fonts provided by the GD library, not all
       characters may end up shown correctly 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 the fixed size	allocation.

       Scaling an image	when background	transparency is	enabled	may not	result
       in transparency being retained.

AUTHOR
       Teemu Toivola <tst at iki dot fi>

SEE ALSO
       vnstat(1), vnstatd(8), vnstat.conf(5), units(7)

version	2.7			   MAY 2021			    VNSTATI(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FILES | EXAMPLES | RESTRICTIONS | AUTHOR | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=vnstati&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help