vnstati(1)

1VNSTATI(1)                       User Manuals                       VNSTATI(1)
2
3
4

NAME

6       vnStat image output - png image output support for vnStat
7
8

SYNOPSIS

10       vnstati  [ -cdhimostv?  ] [ --cache time ] [ --config file ] [ --days ]
11       [ --dbdir directory ] [ --help ] [ --hours ] [ -hs ] [ --hsummary  ]  [
12       -i interface ] [ --iface interface ] [ --locale locale ] [ --months ] [
13       -ne ] [ -nh ] [ --noedge ] [ --noheader ] [ --output file ] [ -ru  ]  [
14       --rateunit ] [ --style number ] [ --summary ] [ --top10 ] [ --transpar‐
15       ent ] [ --version ] [ -vs ] [ --vsummary ]
16
17

DESCRIPTION

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

OPTIONS

27       -c, --cache time
28              Update output file only if at least  time  minutes  have  passed
29              since the previous file update. This option is ignored if stdout
30              is used as output.
31
32
33       --config file
34              Use file as config file instead  of  using  normal  config  file
35              search function.
36
37
38       -d, --days
39              Output traffic for days.
40
41
42       --dbdir directory
43              Use  directory as database directory instead of using the direc‐
44              tory specified  in  the  configuration  file  or  the  hardcoded
45              default if no configuration file is available.
46
47
48       -h, --hours
49              Output traffic for the last 24 hours.
50
51
52       -hs, --hsummary
53              Output  traffic summary including hourly data using a horizontal
54              layout.
55
56
57       -i, --iface interface
58              Use interface instead of default or configured interface.
59
60
61       --locale locale
62              Use locale instead of using the locale setting specified in  the
63              configuration  file  or  the  system default if no configuration
64              file is available.
65
66
67       -m, --months
68              Output traffic for months.
69
70
71       -ne, --noedge
72              Remove darker edges from around the image.
73
74
75       -nh, --noheader
76              Remove header containing title and update time. Time of the pre‐
77              vious  update  will  still  be visible in the lower right corner
78              using a less visible color.
79
80
81       -o, --output file
82              Write png image to file and exit. Output can be directed to std‐
83              out by giving "-" as filename.
84
85
86       -ru, --rateunit
87              Swap the configured rate unit. If rate has been configured to be
88              shown in bytes then rate will be shown in bits if this option is
89              present.  In  the  same  way,  if rate has been configured to be
90              shown in bits then rate will be shown in bytes when this  option
91              is  present.  Alternatively 0 or 1 can be given as parameter for
92              this option in order to select between bytes (0)  and  bits  (1)
93              regardless of the configuration file setting.
94
95
96       --style number
97              Modify  the  content  and  style of outputs. Setting number to 3
98              will show average traffic rate in all outputs where it  is  sup‐
99              ported.  Other values will show bar graphics instead.
100
101
102       -s, --summary
103              Output traffic summary.
104
105
106       -t, --top10
107              Output all time top10 traffic days.
108
109
110       --transparent
111              Toggle  background color transparency depending of the Transpar‐
112              entBg setting in the configuration file. Alternatively  0  or  1
113              can  be  given  as  parameter for this option in order to either
114              disable (0) or enable (1) transparency regardless of the config‐
115              uration file setting.
116
117
118       -v, --version
119              Show current version.
120
121
122       -vs, --vsummary
123              Output  traffic  summary  including hourly data using a vertical
124              layout.
125
126
127       -?, --help
128              Show a command summary.
129
130

FILES

132       /var/lib/vnstat/
133              Default database directory. Files are  named  according  to  the
134              monitored interfaces.
135
136       /etc/vnstat.conf
137              Config file that will be used unless $HOME/.vnstatrc exists. See
138              vnstat.conf(5) for more information.
139

EXAMPLES

141       vnstati -s -i eth0 -o /tmp/vnstat.png
142              Output   traffic   summary   for   interface   eth0   to    file
143              /tmp/vnstat.png.
144
145
146       vnstati -vs -i eth0+eth1+eth2 -o /tmp/vnstat.png
147              Output traffic summary with hourly data under the normal summary
148              for  a  merge  of  interfaces  eth0,  eth1  and  eth2  to   file
149              /tmp/vnstat.png.
150
151
152       vnstati -h -c 15 -o /tmp/vnstat_h.png
153              Output  hourly  traffic statistics for default interface to file
154              /tmp/vnstat_h.png if the file has not been  updated  within  the
155              last 15 minutes.
156
157
158       vnstati -d -ne -nh -o -
159              Output  daily  traffic  statistics without displaying the header
160              section and edges for default interface to standard output (std‐
161              out).
162
163
164       vnstati -m --config /home/me/vnstat.cfg -i -o -
165              Output  monthly  traffic statistics for default interface speci‐
166              fied in configuration file /home/me/vnstat.cfg to standard  out‐
167              put (stdout).
168
169

AUTHOR

171       Teemu Toivola <tst at iki dot fi>
172
173