"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/vnstat.conf.5" between
vnstat-2.7.tar.gz and vnstat-2.8.tar.gz

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

vnstat.conf.5  (vnstat-2.7):vnstat.conf.5  (vnstat-2.8)
skipping to change at line 112 skipping to change at line 112
data collection of this resolution. data collection of this resolution.
64bitInterfaceCounters 64bitInterfaceCounters
Select interface counter handling. Set to 1 for defining that all interfaces use 64-bit counters Select interface counter handling. Set to 1 for defining that all interfaces use 64-bit counters
on the kernel side and 0 for defining 32-bit counter. Set to -1 fo r using the old style logic used on the kernel side and 0 for defining 32-bit counter. Set to -1 fo r using the old style logic used
in earlier versions where counter values within 32-bits are assume d to be 32-bit and anything in earlier versions where counter values within 32-bits are assume d to be 32-bit and anything
larger is assumed to be a 64-bit counter. This may produce fals e results if a 64-bit counter is larger is assumed to be a 64-bit counter. This may produce fals e results if a 64-bit counter is
reset within the 32-bits. Set to -2 for using automatic detection based on available kernel datas- reset within the 32-bits. Set to -2 for using automatic detection based on available kernel datas-
tructures. tructures.
AlwaysAddNewInterfaces
Enable or disable automatic creation of new database entries for
interfaces not currently in the
database even if the database file already exists when the daemon
is started. New database entries
will also get created for new interfaces seen while the daemon i
s running. Pseudo interfaces lo,
lo0 and sit0 are always excluded from getting added. 1 = enabled,
0 = disabled.
BandwidthDetection BandwidthDetection
Try to automatically detect MaxBandwidth value for each monitored Try to automatically detect MaxBandwidth value for each monitored
interface. Mostly only ethernet interface. Mostly only ethernet
interfaces support this feature. MaxBandwidth or interface specif interfaces support this feature. MaxBandwidth will be used as fa
ic MaxBW will be used as fall- llback value if detection fails.
back value if detection fails. 1 = enabled, 0 = disabled. Any interface specific MaxBW configuration will disable the detect
ion for the specified interface.
In Linux, the detection is disabled for tun interfaces due to the
Linux kernel always reporting 10
Mbit regardless of the used real interface. 1 = enabled, 0 = disa
bled.
BandwidthDetectionInterval BandwidthDetectionInterval
How often in minutes interface specific detection of MaxBandwidt h is done for detecting possible How often in minutes interface specific detection of MaxBandwidth is done for detecting possible
changes when BandwidthDetection is enabled. Can be disabled by set ting to 0. Value range: 0..30 changes when BandwidthDetection is enabled. Can be disabled by set ting to 0. Value range: 0..30
BootVariation BootVariation
Time in seconds how much the boot time reported by system kernel can variate between updates. Time in seconds how much the boot time reported by system ker nel can variate between updates.
Value range: 0..300 Value range: 0..300
CheckDiskSpace CheckDiskSpace
Enable or disable the availability check of at least some free dis k space before a database write. Enable or disable the availability check of at least some free dis k space before a database write.
1 = enabled, 0 = disabled. 1 = enabled, 0 = disabled.
CreateDirs CreateDirs
Enable or disable the creation of directories when a configured pa Enable or disable the creation of directories when a configured p
th doesn't exist. This includes ath doesn't exist. This includes
DatabaseDir , LogFile and PidFile directories. The LogFile dir DatabaseDir , LogFile and PidFile directories. The LogFile directo
ectory will be created only when ry will be created only when
UseLogging has been set to 1. The PidFile directory will be create UseLogging has been set to 1. The PidFile directory will be creat
d only if the daemon is started ed only if the daemon is started
as a background process. The daemon process will try to create th e directory using permissions of as a background process. The daemon process will try to create th e directory using permissions of
the user used to start the process. the user used to start the process.
DaemonGroup DaemonGroup
Specify the group to which the daemon process should switch during Specify the group to which the daemon process should switch durin
startup. The group can either g startup. The group can either
be the name of the group or a numerical group id. Leave empty be the name of the group or a numerical group id. Leave empty to
to disable group switching. This disable group switching. This
option can only be used when the process is started as root. option can only be used when the process is started as root.
DaemonUser DaemonUser
Specify the user to which the daemon process should switch during startup. The user can either be Specify the user to which the daemon process should switch during startup. The user can either be
the login of the user or a numerical user id. Leave empty to dis able user switching. This option the login of the user or a numerical user id. Leave empty to disa ble user switching. This option
can only be used when the process is started as root. can only be used when the process is started as root.
DailyDays DailyDays
Data retention duration for the one day resolution entries. The co nfiguration defines for how many Data retention duration for the one day resolution entries. The co nfiguration defines for how many
past days entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data col- past days entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data col-
lection of this resolution. lection of this resolution.
DatabaseSynchronous DatabaseSynchronous
Change the setting of the SQLite "synchronous" flag which controls Change the setting of the SQLite "synchronous" flag which co
how much care is taken to ntrols how much care is taken to
ensure disk writes have fully completed when writing data to the ensure disk writes have fully completed when writing data to the d
database before continuing other atabase before continuing other
actions. Higher values take extra steps to ensure data safety at t he cost of slower performance. A actions. Higher values take extra steps to ensure data safety at t he cost of slower performance. A
value of 0 will result in all handling being left to the filesy value of 0 will result in all handling being left to the filesyste
stem itself. Set to -1 to select m itself. Set to -1 to select
the default value according to database mode controlled by Databas the default value according to database mode controlled by Databa
eWriteAheadLogging setting. See seWriteAheadLogging setting. See
SQLite documentation for more details regarding values from 1 to 3 . Value range: -1..3 SQLite documentation for more details regarding values from 1 to 3 . Value range: -1..3
DatabaseWriteAheadLogging DatabaseWriteAheadLogging
Enable or disable SQLite Write-Ahead Logging mode for the databa Enable or disable SQLite Write-Ahead Logging mode for the database
se. See SQLite documentation for . See SQLite documentation for
more details and note that support for read-only operations isn't more details and note that support for read-only operations isn'
available in older SQLite ver- t available in older SQLite ver-
sions. 1 = enabled, 0 = disabled. sions. 1 = enabled, 0 = disabled.
HourlyDays HourlyDays
Data retention duration for the one hour resolution entries. T he configuration defines for how Data retention duration for the one hour resolution entries. The configuration defines for how
many past days entries will be stored. Set to -1 for unlimited ent ries or to 0 to disable the data many past days entries will be stored. Set to -1 for unlimited ent ries or to 0 to disable the data
collection of this resolution. collection of this resolution.
LogFile LogFile
Specify log file path and name to be used if UseLogging is set to 1. Specify log file path and name to be used if UseLogging is set to 1.
MaxBandwidth MaxBandwidth
Maximum bandwidth for all interfaces. If the interface specific Maximum bandwidth for all interfaces. If the interface specific tr
traffic exceeds the given value affic exceeds the given value
then the data is assumed to be invalid and rejected. Set to 0 in then the data is assumed to be invalid and rejected. Set to 0
order to disable the feature. in order to disable the feature.
Value range: 0..50000 Value range: 0..50000
MaxBW Same as MaxBandwidth but can be used for setting individual lim MaxBW Same as MaxBandwidth but can be used for setting individual limits
its for selected interfaces. The for selected interfaces. The
name of the interface is specified directly after the MaxBW keywor name of the interface is specified directly after the MaxBW key
d without spaces. For example word without spaces. For example
MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. Value range: 0..50000 MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. BandwidthDetection is
disabled on an interface spe-
cific level for each MaxBW configuration. Value range: 0..50000
MonthlyMonths MonthlyMonths
Data retention duration for the one month resolution entries. T he configuration defines for how Data retention duration for the one month resolution entries. T he configuration defines for how
many past months entries will be stored. Set to -1 for unlimited e ntries or to 0 to disable the many past months entries will be stored. Set to -1 for unlimited e ntries or to 0 to disable the
data collection of this resolution. data collection of this resolution.
MonthRotate MonthRotate
Day of month that months are expected to change. Usually set to 1 but can be set to alternative Day of month that months are expected to change. Usually set to 1 but can be set to alternative
values for example for tracking monthly billed traffic where the b illing period doesn't start on values for example for tracking monthly billed traffic where the b illing period doesn't start on
the first day. For example, if set to 7, days of February up to and including the 6th will count the first day. For example, if set to 7, days of February up to and including the 6th will count
skipping to change at line 208 skipping to change at line 217
How often in minutes cached interface data is saved to file when a ll monitored interfaces are off- How often in minutes cached interface data is saved to file when a ll monitored interfaces are off-
line. Value range: SaveInterval..60 line. Value range: SaveInterval..60
PidFile PidFile
Specify pid file path and name to be used. The file is created on ly if the daemon is started as a Specify pid file path and name to be used. The file is created on ly if the daemon is started as a
background process. background process.
PollInterval PollInterval
How often in seconds interfaces are checked for status changes. V alue range: 2..60 How often in seconds interfaces are checked for status changes. V alue range: 2..60
RescanDatabaseOnSave
Automatically discover added interfaces from the database and star
t monitoring. The rescan is
done every SaveInterval or OfflineSaveInterval minutes depending o
n the current activity state. 1
= enabled, 0 = disabled.
SaveInterval SaveInterval
How often in minutes cached interface data is saved to file. Valu e range: ( UpdateInterval / 60 How often in minutes cached interface data is saved to file. Valu e range: ( UpdateInterval / 60
)..60 )..60
SaveOnStatusChange SaveOnStatusChange
Enable or disable the additional saving to file of cached interfa ce data when the availability of Enable or disable the additional saving to file of cached interfa ce data when the availability of
an interface changes, i.e., when an interface goes offline or come s online. 1 = enabled, 0 = dis- an interface changes, i.e., when an interface goes offline or come s online. 1 = enabled, 0 = dis-
abled. abled.
TimeSyncWait TimeSyncWait
skipping to change at line 246 skipping to change at line 260
ing manual database creation, this option will cause file ownershi p to be inherited from the data- ing manual database creation, this option will cause file ownershi p to be inherited from the data-
base directory if the directory already exists. This option onl y has effect when the process is base directory if the directory already exists. This option onl y has effect when the process is
started as root or via sudo. started as root or via sudo.
UpdateInterval UpdateInterval
How often in seconds the interface data is updated. Value range: P ollInterval..300 How often in seconds the interface data is updated. Value range: P ollInterval..300
UseLogging UseLogging
Enable or disable logging. 0 = disabled, 1 = logfile and 2 = syslo g. Enable or disable logging. 0 = disabled, 1 = logfile and 2 = syslo g.
UseUTC Enable or disable using UTC as timezone in the database for all en
tries. When enabled, all entries
added to the database will use UTC regardless of the configured
system timezone. When disabled,
the configured system timezone will be used. Changing this setting
will not result in already
existing data to be modified. 1 = enabled, 0 = disabled.
YearlyYears YearlyYears
Data retention duration for the one year resolution entries. The Data retention duration for the one year resolution entries. T
configuration defines for how he configuration defines for how
many past years entries will be stored. Set to -1 for unlimite many past years entries will be stored. Set to -1 for unlimited en
d entries or to 0 to disable the tries or to 0 to disable the
data collection of this resolution. data collection of this resolution.
IMAGE OUTPUT RELATED KEYWORDS IMAGE OUTPUT RELATED KEYWORDS
5MinuteGraphResultCount 5MinuteGraphResultCount
Number of 5 minute periods to be included in the 5 minute resoluti on graph. The value affects the Number of 5 minute periods to be included in the 5 minute resoluti on graph. The value affects the
width of the graph. Value range: 288..5MinuteHours*12 width of the graph. Value range: 288..5MinuteHours*12
5MinuteGraphHeight 5MinuteGraphHeight
Height of 5 minute resolution graph in pixels. Value range: 150..2 000 Height of 5 minute resolution graph in pixels. Value range: 150..2 000
BarColumnShowsRate BarColumnShowsRate
The bar column represents traffic rate in list outputs when ena The bar column represents traffic rate in list outputs when enable
bled. Requires also that Output- d. Requires also that Output-
Style has been configured to show the traffic rate column by using Style has been configured to show the traffic rate column by u
the value 3. Enabling this sing the value 3. Enabling this
option will automatically cause EstimateStyle to have the value option will automatically cause EstimateStyle to have the value 0.
0. Visually this option affects Visually this option affects
only the color legend text and the last line on the list if that only the color legend text and the last line on the list if th
line represents the currently at line represents the currently
ongoing time period. 1 = enabled, 0 = disabled. ongoing time period. 1 = enabled, 0 = disabled.
CBackground CBackground
Background color. Background color.
CEdge Edge color, if visible. CEdge Edge color, if visible.
CHeader CHeader
Header background color. Header background color.
skipping to change at line 292 skipping to change at line 311
CLineL Lighter version of line color. Set to '-' in order to use a calcul ated value based on CLine. CLineL Lighter version of line color. Set to '-' in order to use a calcul ated value based on CLine.
CRx Color for received data. CRx Color for received data.
CRxD Darker version of received data color. Set to '-' in order to use a calculated value based on CRx. CRxD Darker version of received data color. Set to '-' in order to use a calculated value based on CRx.
CText Common text color. CText Common text color.
CTx Color for transmitted data. CTx Color for transmitted data.
CTxD Darker version of transmitted data color. Set to '-' in order to use a calculated value based on CTxD Darker version of transmitted data color. Set to '-' in order to u se a calculated value based on
CTx. CTx.
EstimateStyle EstimateStyle
Show a visual representation of the traffic estimation. 0 = not s hown, 1 = continuation of exist- Show a visual representation of the traffic estimation. 0 = not s hown, 1 = continuation of exist-
ing bar, 2 = separate bar. ing bar, 2 = separate bar.
HeaderFormat HeaderFormat
Formatting of date in header. Uses the same format as date(1). Formatting of date in header. Uses the same format as date(1).
HourlyRate HourlyRate
skipping to change at line 316 skipping to change at line 335
Scale output to given percent. Value range: 50..500 Scale output to given percent. Value range: 50..500
LargeFonts LargeFonts
Increase the size of used fonts. 1 = enabled, 0 = disabled. Increase the size of used fonts. 1 = enabled, 0 = disabled.
LineSpacingAdjustment LineSpacingAdjustment
Adjust line spacing in list format outputs. Positive values increa se the space between lines while Adjust line spacing in list format outputs. Positive values increa se the space between lines while
negative values reduce it. Value range: -5..10 negative values reduce it. Value range: -5..10
SummaryGraph SummaryGraph
Select which graph style output is shown next to the summary data in the horizontal and vertical Select which graph style output is shown next to the summary dat a in the horizontal and vertical
summary outputs. 0 = hours, 1 = 5 minutes. summary outputs. 0 = hours, 1 = 5 minutes.
SummaryRate SummaryRate
Show rate in summary output if available. 1 = enabled, 0 = disable d. Show rate in summary output if available. 1 = enabled, 0 = disable d.
TransparentBg TransparentBg
Set background color as transparent. 1 = enabled, 0 = disabled. Set background color as transparent. 1 = enabled, 0 = disabled.
FILES FILES
/etc/vnstat.conf /etc/vnstat.conf
Config file that will be used unless $HOME/.vnstatrc exists or al ternative value is given as com- Config file that will be used unless $HOME/.vnstatrc exists or alt ernative value is given as com-
mand line parameter. mand line parameter.
RESTRICTIONS RESTRICTIONS
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 i f the length of the date exceeds
the fixed size allocation. the fixed size allocation.
AUTHOR AUTHOR
Teemu Toivola <tst at iki dot fi> Teemu Toivola <tst at iki dot fi>
SEE ALSO SEE ALSO
vnstat(1), vnstati(1), vnstatd(8), units(7) vnstat(1), vnstati(1), vnstatd(8), units(7)
version 2.7 MAY 2021 VNSTAT.CONF(5) version 2.8 SEPTEMBER 2021 VNSTAT.CONF(5)
 End of changes. 22 change blocks. 
56 lines changed or deleted 88 lines changed or added

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