]> granicus.if.org Git - vnstat/commitdiff
document value ranges in configuration file man page and other minor man page corretions
authorTeemu Toivola <git@humdi.net>
Mon, 5 Jan 2015 22:06:24 +0000 (00:06 +0200)
committerTeemu Toivola <git@humdi.net>
Mon, 5 Jan 2015 22:06:24 +0000 (00:06 +0200)
man/vnstat.1
man/vnstat.conf.5
man/vnstatd.1
src/cfg.c

index 03e2944d400a5a922d79d726853acb5c28f12529..cb9814ef733c134bec7fa98cab2f253590122513 100644 (file)
@@ -448,9 +448,9 @@ Delete database of interface eth2 and stop monitoring it.
 
 Updates needs to be executed at least as often as it is possible for the interface
 to generate enough traffic to overflow the kernel interface traffic counter. Otherwise,
-it is possible that some traffic won't be seen. This isn't an issue for 64 bit kernels
+it is possible that some traffic won't be seen. This isn't an issue for 64-bit kernels
 but at least one update every hour is always required in order to provide proper input.
-With 32 bit kernels, the maximum time between two updates depends on how fast the
+With 32-bit kernels, the maximum time between two updates depends on how fast the
 interface can transfer 4 GiB. Calculated theoretical times are:
 .RS
 .TS
@@ -462,7 +462,7 @@ l l.
 .RE
 
 However, for 1000 Mbit interfaces updating once every minute is usually a
-useable solution if faster updates can't be used.
+usable solution if faster updates can't be used.
 .PP
 Estimated traffic values are likely to be somewhat inaccurate if daily
 traffic is low because only the MiB counter is used to calculate the
index babddf9ad572bd95680d8d0e92c829073b02ef5b..d3ddf820f6a3c530daca83a52ef30ff117e839f7 100644 (file)
@@ -32,7 +32,7 @@ the daemon related keywords and the last section for the image output.
 .TP
 .B BootVariation
 Time in seconds how much the boot time reported by system kernel can variate
-between updates.
+between updates. Value range: 0..300
 
 .TP
 .B CheckDiskSpace
@@ -65,21 +65,22 @@ system default value. (vnstat and vnstati only)
 .B MaxBandwidth
 Maximum bandwidth for all interfaces. If the counted traffic exceeds
 the given value then the data is assumed to be invalid and rejected.
-Set to 0 in order to disable the feature. (vnstat and vnstatd only)
+Set to 0 in order to disable the feature. Value range: 0..10000
+(vnstat and vnstatd only)
 
 .TP
 .B MaxBW
 Same as MaxBandwidth but can be used for setting individual limits
 for selected interfaces. The name of the interface is specified directly
 after the MaxBW keyword without spaces. For example MaxBWeth0 for eth0
-and MaxBWppp0 for ppp0. (vnstat and vnstatd only)
+and MaxBWppp0 for ppp0. Value range: 0..10000 (vnstat and vnstatd only)
 
 .TP
 .B MonthRotate
 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 billing period doesn't start on
-the first day. (vnstat and vnstatd only)
+the first day. Value range: 1..28 (vnstat and vnstatd only)
 
 .TP
 .B OutputStyle
@@ -93,8 +94,7 @@ is supported. (vnstat and vnstati only)
 .B QueryMode
 Default query mode when no parameters are given. 0 = normal, 1 = days,
 2 = months, 3 = top10, 4 = exportdb, 5 = short, 6 = weeks, 7 = hours and
-8 = xml.
-(vnstat only)
+8 = xml. (vnstat only)
 
 .TP
 .B RateUnit
@@ -113,7 +113,8 @@ and transmitted traffic in hourly output. (vnstat only)
 
 .TP
 .B Sampletime
-Defines how many seconds the \-tr option will sample traffic. (vnstat only)
+Defines how many seconds the \-tr option will sample traffic.
+Value range: 2..600 (vnstat only)
 
 .TP
 .B TrafficlessDays
@@ -174,7 +175,8 @@ Specify log file path and name to be used if UseLogging is set to 1.
 .TP
 .B OfflineSaveInterval
 How often in minutes cached interface data is saved to file when all monitored
-interfaces are offline.
+interfaces are offline. Value range:
+.BR SaveInterval "..60"
 
 .TP
 .B PidFile
@@ -183,10 +185,13 @@ Specify pid file path and name to be used.
 .TP
 .B PollInterval
 How often in seconds interfaces are checked for status changes.
+Value range: 2..300
 
 .TP
 .B SaveInterval
 How often in minutes cached interface data is saved to file.
+Value range: (
+.BR UpdateInterval " / 60 )..60"
 
 .TP
 .B SaveOnStatusChange
@@ -203,7 +208,8 @@ This option can only be used when the process is started as root.
 
 .TP
 .B UpdateInterval
-How often in seconds the interface data is updated.
+How often in seconds the interface data is updated. Value range:
+.BR PollInterval "..300"
 
 .TP
 .B UseLogging
index 711e60b836432b95fa8afde17766d68e03c67bf5..34499a05e066f804fcc36e01ed0f91045e9040bf 100644 (file)
@@ -248,9 +248,9 @@ configuration file or using the command line parameter.
 
 Updates needs to be executed at least as often as it is possible for the interface
 to generate enough traffic to overflow the kernel interface traffic counter. Otherwise,
-it is possible that some traffic won't be seen. This isn't an issue for 64 bit kernels
+it is possible that some traffic won't be seen. This isn't an issue for 64-bit kernels
 but at least one update every hour is always required in order to provide proper input.
-With 32 bit kernels, the maximum time between two updates depends on how fast the
+With 32-bit kernels, the maximum time between two updates depends on how fast the
 interface can transfer 4 GiB. Calculated theoretical times are:
 .RS
 .TS
@@ -262,7 +262,7 @@ l l.
 .RE
 
 However, for 1000 Mbit interfaces updating once every minute is usually a
-useable solution if faster updates can't be used.
+usable solution if faster updates can't be used.
 .PP
 Virtual and aliased interfaces cannot be monitored because the kernel doesn't
 provide traffic information for that type of interfaces. Such interfaces are
index 1c2967273257b396f4f13c152ba4d0d0797e835b..f91ba3402b6e95f4009743e5bd1116adf92ea893 100644 (file)
--- a/src/cfg.c
+++ b/src/cfg.c
@@ -387,7 +387,7 @@ void validatecfg(void)
                printe(PT_Config);
        }
 
-       if (cfg.sampletime<0 || cfg.sampletime>600) {
+       if (cfg.sampletime<2 || cfg.sampletime>600) {
                cfg.sampletime = DEFSAMPTIME;
                snprintf(errorstring, 512, "Invalid value for Sampletime, resetting to \"%d\".", cfg.sampletime);
                printe(PT_Config);