vnstat.conf.5 (vnstat-2.8) | : | vnstat.conf.5 (vnstat-2.9) | ||
---|---|---|---|---|
skipping to change at line 12 | skipping to change at line 12 | |||
NAME | NAME | |||
vnstat.conf - vnStat configuration file | vnstat.conf - vnStat configuration file | |||
SYNOPSIS | SYNOPSIS | |||
/etc/vnstat.conf | /etc/vnstat.conf | |||
DESCRIPTION | DESCRIPTION | |||
vnstat(1), vnstati(1) and vnstatd(8) all use the same configuration file for configuration related set- | vnstat(1), vnstati(1) and vnstatd(8) all use the same configuration file for configuration related set- | |||
tings. Some of the settings are common for all three programs. The file consists of keyword-argument | tings. Some of the settings are common for all three programs. The file consists of keyword-argument | |||
pairs, one per line. Empty lines and lines starting with '#' are inter | pairs, one per line. Empty lines and lines starting with '#' or ';' are | |||
preted as comments and not pro- | interpreted as comments and not | |||
cessed. Arguments may optionally be enclosed in double quotes (") in ord | processed. Arguments may optionally be enclosed in double quotes (") in | |||
er to represent arguments con- | order to represent arguments | |||
taining spaces. Arguments can be padded with spaces or tabulator charac | containing spaces. Arguments can be padded with spaces or tabulator | |||
ters. A hardcoded default value | characters. A hardcoded default | |||
will be used if a keyword can't be found from the configuration file or i | value will be used if a keyword can't be found from the configuration fil | |||
f the configured value cannot | e or if the configured value | |||
be parsed or is outside supported value range. | cannot be parsed or is outside supported value range. | |||
The configuration file is divided into three sections based on the usage of each keyword. The first sec- | The configuration file is divided into three sections based on the usage of each keyword. The first sec- | |||
tion contains keywords that are considered common for all commands, the s econd section is for daemon | tion contains keywords that are considered common for all commands, the s econd section is for daemon | |||
related keywords and the last section is for image output. | related keywords and the last section is for image output. | |||
COMMON KEYWORDS | COMMON KEYWORDS | |||
DatabaseDir | DatabaseDir | |||
Specifies the directory where the database is to be stored. A full path must be given and a | Specifies the directory where the database is to be stored. A full path must be given and a | |||
leading '/' isn't required. | leading '/' isn't required. | |||
skipping to change at line 54 | skipping to change at line 54 | |||
put. 0 = none, 1 = '|', 2 = '][', 3 = '[ ]'. (vnstat only) | put. 0 = none, 1 = '|', 2 = '][', 3 = '[ ]'. (vnstat only) | |||
Interface | Interface | |||
Default interface used when no other interface is specified on the command line. Leave empty for | Default interface used when no other interface is specified on the command line. Leave empty for | |||
automatic selection. The automatic selection will prioritize the interface with most traffic for | automatic selection. The automatic selection will prioritize the interface with most traffic for | |||
outputs doing database queries. Queries not using the database wi ll first check if the database | outputs doing database queries. Queries not using the database wi ll first check if the database | |||
is available and select the interface with most traffic out thos e that are currently visible in | is available and select the interface with most traffic out thos e that are currently visible in | |||
the system. If no database can be read then the first available in terface will be used. (vnstat | the system. If no database can be read then the first available in terface will be used. (vnstat | |||
and vnstati only) | and vnstati only) | |||
InterfaceMatchMethod | ||||
Method for matching interface given for a query to an inte | ||||
rface in the database. Method 0 | ||||
requires the interface name to be an case sensitive exact match. M | ||||
ethod 1 extends the previous | ||||
method by allowing a case sensitive exact match of the interface a | ||||
lias. Method 2 extends the pre- | ||||
vious method by allowing a case insensitive exact match of the int | ||||
erface alias. Method 3 extends | ||||
the previous method by allowing a case insensitive match of the be | ||||
ginning of the interface alias. | ||||
Methods will be evaluated in the order described above resulting | ||||
in exact interface matches | ||||
always taking precedence. If any interface alias matching met | ||||
hod results in multiple matches | ||||
then the interface with the highest total traffic will be used. ( | ||||
vnstat and vnstati only) | ||||
List5Mins, ListHours, ListDays, ListMonths, ListYears, ListTop | List5Mins, ListHours, ListDays, ListMonths, ListYears, ListTop | |||
Number of entries to show in list outputs unless overridden from the command line. Set to 0 to | Number of entries to show in list outputs unless overridden from t he command line. Set to 0 to | |||
show all entries available in the database. (vnstat and vnstati) | show all entries available in the database. (vnstat and vnstati) | |||
Locale Locale setting to be used for prints. This replaces the LC_ALL env ironment variable. Set to "-" | Locale Locale setting to be used for prints. This replaces the LC_ALL e nvironment variable. Set to "-" | |||
or leave empty in order to use the system default value. (vnstat a nd vnstati only) | or leave empty in order to use the system default value. (vnstat a nd vnstati only) | |||
OutputStyle | OutputStyle | |||
Modify the content and style of text outputs. 0 = minimal and narrow output for terminal with | Modify the content and style of text outputs. 0 = minimal and narr ow output for terminal with | |||
limited width, 1 = normal output with bar column visible, 2 = same as 1 except rate is visible in | limited width, 1 = normal output with bar column visible, 2 = same as 1 except rate is visible in | |||
summary output, 3 = rate column is visible in all outputs wher e it is supported. (vnstat and | summary output, 3 = rate column is visible in all outputs where it is supported. (vnstat and | |||
vnstati only) | vnstati only) | |||
QueryMode | QueryMode | |||
Default query mode when no parameters are given. 0 = normal, 1 = d | Default query mode when no parameters are given. 0 = normal, 1 = | |||
ays, 2 = months, 3 = top, 5 = | days, 2 = months, 3 = top, 5 = | |||
short, 6 = years, 7 = hours graph, 8 = xml, 9 = one line, 1 | short, 6 = years, 7 = hours graph, 8 = xml, 9 = one line, 10 = jso | |||
0 = json, 11 = hours and 12 = 5 | n, 11 = hours and 12 = 5 | |||
minute. (vnstat only) | minute. (vnstat only) | |||
RateUnit | RateUnit | |||
Select which unit is used when traffic rate is visible. 0 = bytes, 1 = bits. (vnstat and vnstati | Select which unit is used when traffic rate is visible. 0 = bytes, 1 = bits. (vnstat and vnstati | |||
only) | only) | |||
RateUnitMode | RateUnitMode | |||
Select used prefix when traffic rate is shown in bits per second. IEC binary prefixes are calcu- | Select used prefix when traffic rate is shown in bits per second. IEC binary prefixes are calcu- | |||
lated with powers of 1024. SI decimal prefixes are calculated with powers of 1000. 0 = IEC | lated with powers of 1024. SI decimal prefixes are calculate d with powers of 1000. 0 = IEC | |||
binary prefixes (Kibit/s...), 1 = SI decimal prefixes (kbit/s...). (vnstat and vnstati only) | binary prefixes (Kibit/s...), 1 = SI decimal prefixes (kbit/s...). (vnstat and vnstati only) | |||
RXCharacter, TXCharacter | RXCharacter, TXCharacter | |||
Character used for representing the percentual share of received and transmitted traffic in list | Character used for representing the percentual share of received a nd transmitted traffic in list | |||
mode outputs. (vnstat only) | mode outputs. (vnstat only) | |||
RXHourCharacter, TXHourCharacter | RXHourCharacter, TXHourCharacter | |||
Character used for representing the percentual share of received and transmitted traffic in | Character used for representing the percentual share of rece ived and transmitted traffic in | |||
hourly graph output. (vnstat only) | hourly graph output. (vnstat only) | |||
Sampletime | Sampletime | |||
Defines how many seconds the -tr option will sample traffic. Valu e range: 2..600 (vnstat only) | Defines how many seconds the -tr option will sample traffic. Valu e range: 2..600 (vnstat only) | |||
UnitMode | UnitMode | |||
Select how units are prefixed. IEC and JEDEC binary prefixes are | Select how units are prefixed. IEC and JEDEC binary prefixes are c | |||
calculated with powers of 1024. | alculated with powers of 1024. | |||
SI decimal prefixes are calculated with powers of 1000. | SI decimal prefixes are calculated with powers of 1000. | |||
0 = IEC standard prefixes | 0 = IEC standard prefixes | |||
(B/KiB/MiB/GiB...), 1 = old style (JEDEC) binary prefixes (B/KB/ | (B/KiB/MiB/GiB...), 1 = old style (JEDEC) binary prefixes (B/KB/MB | |||
MB/GB...), 2 = SI decimals pre- | /GB...), 2 = SI decimals pre- | |||
fixes (B/kB/MB/GB...) (vnstat and vnstati only) | fixes (B/kB/MB/GB...) (vnstat and vnstati only) | |||
DAEMON RELATED KEYWORDS | DAEMON RELATED KEYWORDS | |||
5MinuteHours | 5MinuteHours | |||
Data retention duration for the 5 minute resolution entries. The c | Data retention duration for the 5 minute resolution entries. Th | |||
onfiguration defines for how | e configuration defines for how | |||
many past hours entries will be stored. Set to -1 for unlimited | many past hours entries will be stored. Set to -1 for unlimited en | |||
entries or to 0 to disable the | tries or to 0 to disable the | |||
data collection of this resolution. | data collection of this resolution. | |||
64bitInterfaceCounters | 64bitInterfaceCounters | |||
Select interface counter handling. Set to 1 for defining that all | Select interface counter handling. Set to 1 for defining that all | |||
interfaces use 64-bit counters | interfaces use 64-bit counters | |||
on the kernel side and 0 for defining 32-bit counter. Set to - | on the kernel side and 0 for defining 32-bit counter. Set to -1 fo | |||
1 for using the old style logic | r using the old style logic | |||
used in earlier versions where counter values within 32-bits are a | used in earlier versions where counter values within 32-bits ar | |||
ssumed to be 32-bit and any- | e assumed to be 32-bit and any- | |||
thing larger is assumed to be a 64-bit counter. This may pr | thing larger is assumed to be a 64-bit counter. This may produce | |||
oduce false results if a 64-bit | false results if a 64-bit | |||
counter is reset within the 32-bits. Set to -2 for using automatic | counter is reset within the 32-bits. Set to -2 for using automat | |||
detection based on available | ic detection based on available | |||
kernel datastructures. | kernel datastructures. | |||
AlwaysAddNewInterfaces | AlwaysAddNewInterfaces | |||
Enable or disable automatic creation of new database entries for | Enable or disable automatic creation of new database entries for i | |||
interfaces not currently in the | nterfaces not currently in the | |||
database even if the database file already exists when the daem | database even if the database file already exists when the | |||
on is started. New database | daemon is started. New database | |||
entries will also get created for new interfaces seen while the d | entries will also get created for new interfaces seen while the da | |||
aemon is running. Pseudo inter- | emon is running. Pseudo inter- | |||
faces lo, lo0 and sit0 are always excluded from getting added. 1 = enabled, 0 = disabled. | faces 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 interface. Mostly only ethernet | Try to automatically detect MaxBandwidth value for each monitored interface. Mostly only ethernet | |||
interfaces support this feature. MaxBandwidth will be used as fal lback value if detection fails. | interfaces support this feature. MaxBandwidth will be used as fal lback value if detection fails. | |||
Any interface specific MaxBW configuration will disable the detect | Any interface specific MaxBW configuration will disable the det | |||
ion for the specified inter- | ection for the specified inter- | |||
face. In Linux, the detection is disabled for tun interfaces | face. In Linux, the detection is disabled for tun interfaces due | |||
due to the Linux kernel always | to the Linux kernel always | |||
reporting 10 Mbit regardless of the used real interface. 1 = enab led, 0 = disabled. | reporting 10 Mbit regardless of the used real interface. 1 = enab led, 0 = disabled. | |||
BandwidthDetectionInterval | BandwidthDetectionInterval | |||
How often in minutes interface specific detection of MaxBandwidth 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 kern el can variate between updates. | Time in seconds how much the boot time reported by system kernel 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 d isk space before a database | Enable or disable the availability check of at least some fr ee disk space before a database | |||
write. 1 = enabled, 0 = disabled. | write. 1 = enabled, 0 = disabled. | |||
CreateDirs | CreateDirs | |||
Enable or disable the creation of directories when a configured pa th doesn't exist. This includes | Enable or disable the creation of directories when a configured pa th doesn't exist. This includes | |||
DatabaseDir , LogFile and PidFile directories. The LogFile directo ry will be created only when | DatabaseDir , LogFile and PidFile directories. The LogFile dire ctory will be created only when | |||
UseLogging has been set to 1. The PidFile directory will be create d only if the daemon is started | UseLogging has been set to 1. The PidFile directory will be create d only if the daemon is started | |||
as a background process. The daemon process will try to create th e directory using permissions | as a background process. The daemon process will try to create the directory using permissions | |||
of the user used to start the process. | of the user used to start the process. | |||
DaemonGroup | DaemonGroup | |||
Specify the group to which the daemon process should switch during startup. The group can either | Specify the group to which the daemon process should switch during startup. The group can either | |||
be the name of the group or a numerical group id. Leave empty to disable group switching. This | be the name of the group or a numerical group id. Leave empty t o 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 durin | Specify the user to which the daemon process should switch during | |||
g startup. The user can either | startup. The user can either | |||
be the login of the user or a numerical user id. Leave empty to | be the login of the user or a numerical user id. Leave empty | |||
disable user switching. This | to disable user 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. | |||
DailyDays | DailyDays | |||
Data retention duration for the one day resolution entries. Th | Data retention duration for the one day resolution entries. The c | |||
e configuration defines for how | onfiguration defines for how | |||
many past days entries will be stored. Set to -1 for unlimited ent | many past days entries will be stored. Set to -1 for unlimited | |||
ries or to 0 to disable the | entries or to 0 to disable the | |||
data collection of this resolution. | data collection of this resolution. | |||
DatabaseSynchronous | DatabaseSynchronous | |||
Change the setting of the SQLite "synchronous" flag which con trols how much care is taken to | Change the setting of the SQLite "synchronous" flag which controls how much care is taken to | |||
ensure disk writes have fully completed when writing data to the d atabase before continuing other | ensure disk writes have fully completed when writing data to the d atabase before continuing other | |||
actions. Higher values take extra steps to ensure data safety at the cost of slower performance. | 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 filesys tem itself. Set to -1 to select | A value of 0 will result in all handling being left to the filesys tem itself. Set to -1 to select | |||
the default value according to database mode controlled by Databas eWriteAheadLogging setting. See | the default value according to database mode controlled by Databas eWriteAheadLogging 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 database | Enable or disable SQLite Write-Ahead Logging mode for the databas | |||
. See SQLite documentation for | e. 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't | |||
available in older SQLite ver- | 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. The c | Data retention duration for the one hour resolution entries. Th | |||
onfiguration defines for how | e configuration defines for how | |||
many past days entries will be stored. Set to -1 for unlimited | many past days entries will be stored. Set to -1 for unlimited ent | |||
entries or to 0 to disable the | ries or to 0 to disable the | |||
data collection of this resolution. | data 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 tr | Maximum bandwidth for all interfaces. If the interface specific | |||
affic exceeds the given value | traffic exceeds the given value | |||
then the data is assumed to be invalid and rejected. Set to 0 i | then the data is assumed to be invalid and rejected. Set to 0 in | |||
n order to disable the feature. | order to disable the feature. | |||
Value range: 0..50000 | Value range: 0..50000 | |||
MaxBW Same as MaxBandwidth but can be used for setting individual limits | MaxBW Same as MaxBandwidth but can be used for setting individual limi | |||
for selected interfaces. The | ts for selected interfaces. The | |||
name of the interface is specified directly after the MaxBW keyw | name of the interface is specified directly after the MaxBW keywor | |||
ord without spaces. For example | d without spaces. For example | |||
MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. BandwidthDetection is | MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. BandwidthDetection i | |||
disabled on an interface spe- | s disabled on an interface spe- | |||
cific level for each MaxBW configuration. Value range: 0..50000 | cific level for each MaxBW configuration. Value range: 0..50000 | |||
MonthlyMonths | MonthlyMonths | |||
Data retention duration for the one month resolution entries. Th | Data retention duration for the one month resolution entries. The | |||
e configuration defines for how | configuration defines for how | |||
many past months entries will be stored. Set to -1 for unlimited e | many past months entries will be stored. Set to -1 for unlimited | |||
ntries or to 0 to disable the | entries 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 | Day of month that months are expected to change. Usually set to 1 | |||
1 but can be set to alternative | but can be set to alternative | |||
values for example for tracking monthly billed traffic where the b | values for example for tracking monthly billed traffic where the | |||
illing period doesn't start on | billing period doesn't start on | |||
the first day. For example, if set to 7, days of February up to a | the first day. For example, if set to 7, days of February up to an | |||
nd including the 6th will count | d including the 6th will count | |||
for January. Changing this option will not cause existing data to | for January. Changing this option will not cause existing data t | |||
be recalculated. Value range: | o be recalculated. Value range: | |||
1..28 | 1..28 | |||
MonthRotateAffectsYears | MonthRotateAffectsYears | |||
Enable or disable MonthRotate also affecting yearly data. Applica ble only when MonthRotate has a | Enable or disable MonthRotate also affecting yearly data. Applicab le only when MonthRotate has a | |||
value greater than one. 1 = enabled, 0 = disabled. | value greater than one. 1 = enabled, 0 = disabled. | |||
OfflineSaveInterval | OfflineSaveInterval | |||
How often in minutes cached interface data is saved to file when all monitored interfaces are | How often in minutes cached interface data is saved to file wh en all monitored interfaces are | |||
offline. Value range: SaveInterval..60 | offline. Value range: SaveInterval..60 | |||
PidFile | PidFile | |||
Specify pid file path and name to be used. The file is created onl y if the daemon is started as a | Specify pid file path and name to be used. The file is created onl y 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 | RescanDatabaseOnSave | |||
Automatically discover added interfaces from the database and star | Automatically discover added interfaces from the database and s | |||
t monitoring. The rescan is | tart monitoring. The rescan is | |||
done every SaveInterval or OfflineSaveInterval minutes depending | done every SaveInterval or OfflineSaveInterval minutes depending o | |||
on the current activity state. | n the current activity state. | |||
1 = enabled, 0 = disabled. | 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. Val ue range: ( UpdateInterval / 60 | |||
)..60 | )..60 | |||
SaveOnStatusChange | SaveOnStatusChange | |||
Enable or disable the additional saving to file of cached interfac e data when the availability of | Enable or disable the additional saving to file of cached interfac e 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 | |||
How many minutes to wait during daemon startup for system clock to sync if most recent database | How many minutes to wait during daemon startup for system clock to sync if most recent database | |||
update appears to be in the future. This may be needed in systems without a real-time clock (RTC) | update appears to be in the future. This may be needed in systems without a real-time clock (RTC) | |||
which require some time after boot to query and set the correct time. 0 = wait disabled. Value | which require some time after boot to query and set the correct ti me. 0 = wait disabled. Value | |||
range: 0..60 | range: 0..60 | |||
TopDayEntries | TopDayEntries | |||
Data retention duration for the top day entries. The configuration | Data retention duration for the top day entries. The configurati | |||
defines how many of the past | on defines how many of the past | |||
top day entries will be stored. Set to -1 for unlimited entries o | top day entries will be stored. Set to -1 for unlimited entries or | |||
r to 0 to disable the data col- | to 0 to disable the data col- | |||
lection of this resolution. | lection of this resolution. | |||
TrafficlessEntries | TrafficlessEntries | |||
Create database entries even when there is no traffic during th e entry's time period. 1 = | Create database entries even when there is no traffic duri ng the entry's time period. 1 = | |||
enabled, 0 = disabled. | enabled, 0 = disabled. | |||
UpdateFileOwner | UpdateFileOwner | |||
Enable or disable the update of file ownership during daemon | Enable or disable the update of file ownership during daemon pro | |||
process startup. During daemon | cess startup. During daemon | |||
startup, only database, log and pid files will be modified if the | startup, only database, log and pid files will be modified if the | |||
user or group change feature ( | user or group change feature ( | |||
DaemonUser or DaemonGroup ) is enabled and the files don't mat | DaemonUser or DaemonGroup ) is enabled and the files don't match t | |||
ch the requested user or group. | he requested user or group. | |||
During manual database creation, this option will cause file owner | During manual database creation, this option will cause file own | |||
ship to be inherited from the | ership to be inherited from the | |||
database directory if the directory already exists. This option o | database directory if the directory already exists. This option on | |||
nly has effect when the process | ly has effect when the process | |||
is started as root or via sudo. | is 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 | UseUTC Enable or disable using UTC as timezone in the database for | |||
entries. When enabled, all | all entries. When enabled, all | |||
entries added to the database will use UTC regardless of the c | entries added to the database will use UTC regardless of the conf | |||
onfigured system timezone. When | igured system timezone. When | |||
disabled, the configured system timezone will be used. Changing th | disabled, the configured system timezone will be used. Changing | |||
is setting will not result in | this setting will not result in | |||
already existing data to be modified. 1 = enabled, 0 = disabled. | already existing data to be modified. 1 = enabled, 0 = disabled. | |||
YearlyYears | YearlyYears | |||
Data retention duration for the one year resolution entries. Th | Data retention duration for the one year resolution entries. The c | |||
e configuration defines for how | onfiguration defines for how | |||
many past years entries will be stored. Set to -1 for unlimited en | many past years entries will be stored. Set to -1 for unlimited | |||
tries or to 0 to disable the | entries 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 resol ution graph. The value affects | 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 | the 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 enable | The bar column represents traffic rate in list outputs when enab | |||
d. Requires also that Output- | led. Requires also that Output- | |||
Style has been configured to show the traffic rate column by us | Style has been configured to show the traffic rate column by using | |||
ing the value 3. Enabling this | the value 3. Enabling this | |||
option will automatically cause EstimateStyle to have the value 0. | option will automatically cause EstimateStyle to have the value | |||
Visually this option affects | 0. Visually this option affects | |||
only the color legend text and the last line on the list if tha | only the color legend text and the last line on the list if that l | |||
t line represents the currently | ine 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 305 | skipping to change at line 315 | |||
CHeaderDate | CHeaderDate | |||
Header date text color. | Header date text color. | |||
CLine Line color. | CLine Line color. | |||
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 | CRxD Darker version of received data color. Set to '-' in order to use a calculated value based on | |||
CRx. | 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 shown, 1 = continuation of | Show a visual representation of the traffic estimation. 0 = not shown, 1 = continuation of | |||
existing bar, 2 = separate bar. | existing 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). | |||
HourlyGraphMode | ||||
Select the output mode of the hourly graph. 0 = 24 hour sliding wi | ||||
ndow, 1 = graph begins from | ||||
midnight. | ||||
HourlyRate | HourlyRate | |||
Show hours with rate instead of transferred amount. 1 = enabled, 0 = disabled. | Show hours with rate instead of transferred amount. 1 = enabled, 0 = disabled. | |||
ImageScale | ImageScale | |||
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 | |||
skipping to change at line 360 | skipping to change at line 374 | |||
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 if 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.8 SEPTEMBER 2021 VNSTAT.CONF(5) | version 2.9 JANUARY 2022 VNSTAT.CONF(5) | |||
End of changes. 49 change blocks. | ||||
142 lines changed or deleted | 165 lines changed or added |