Package: vnstat
Version: 1.6-1
Severity: wishlist
Tags: patch
It is easier to read manual pages and configuration file options in
alphabetical order.
The patches adjust the following pages accordingly:
vnstat.1
vnstat.conf.5
vnstatd.1
vnstati.1
Similar to GNU cp(1), mv(1), OpenSSH ssh(1) etc.
-- System Information:
Debian Release: squeeze/sid
APT prefers testing
APT policy: (990, 'testing'), (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Kernel: Linux 2.6.30-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_DK.UTF-8, LC_CTYPE=en_DK.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages vnstat depends on:
ii libc6 2.10.2-2 GNU C Library: Shared libraries
vnstat recommends no packages.
vnstat suggests no packages.
-- no debconf information
>From 328c384a864366c0c137c977de36a1caf089e50f Mon Sep 17 00:00:00 2001
From: Jari Aalto <[email protected]>
Date: Wed, 16 Dec 2009 02:19:49 +0200
Subject: [PATCH] man/vnstat.1: order options alphabetically
Signed-off-by: Jari Aalto <[email protected]>
---
man/vnstat.1 | 321 ++++++++++++++++++++++++++++++++--------------------------
1 files changed, 177 insertions(+), 144 deletions(-)
diff --git a/man/vnstat.1 b/man/vnstat.1
index 340cf31..31e7c7a 100644
--- a/man/vnstat.1
+++ b/man/vnstat.1
@@ -99,82 +99,82 @@ and
.BR sys
filesystems depending on availability. That way vnStat can be used even
without root permissions on most systems.
+
.SH OPTIONS
+
.TP
-.BI "-d, --days"
-Show traffic for days.
-.TP
-.BI "-h, --hours"
-Show traffic for the last 24 hours.
-.TP
-.BI "-m, --months"
-Show traffic for months.
-.TP
-.BI "-s, --short"
-Use short output mode. This mode is also used if more than one
-database is available.
-.TP
-.BI "-t, --top10"
-Show all time top10 traffic days.
-.TP
-.BI "-w, --weeks"
-Show traffic for 7 days, current and previous week.
-.TP
-.BI "--style " number
-Modify the content and style of outputs. Set
-.I number
-to 0 for a more narrow output, 1 for enabling bar column, 2
-for same as previous but with average traffic rate visible in summary
-and weekly outputs and 3 for enabling average traffic rate in all
-outputs where it is supported.
-.TP
-.BI "-tr " time
-Calculate how much traffic goes through the selected interface during
-the given
-.I time
-seconds. The
-.I time
-will be 5 seconds if a number parameter isn't included.
-.TP
-.BI "-l, --live"
-Display current transfer rate for the selected interface in real time
-until interrupted. Statistics will be shown after interruption if runtime
-was more than 10 seconds.
+.BI "-?, --help"
+Show a command summary.
+
.TP
-.BI "-ru, --rateunit"
-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 0 or 1 can be given as
-parameter for this option in order to select between bytes (0) and bits
-(1) regardless of the configuration file setting.
+.BI "--cleartop"
+Remove all top10 entries.
+
.TP
-.BI "-i, --iface " interface
-Select one specific
-.I interface
-and apply actions to only it.
+.BI "--config " file
+Use
+.I file
+as config file instead of using normal config file search function.
+
.TP
-.BI "--iflist"
-Show list of currently available interfaces.
+.BI "-d, --days"
+Show traffic for days.
+
.TP
-.BI "-q, --query"
-Force database query mode.
+.BI "-D, --debug"
+Show additional debug output.
+
.TP
-.BI "-u, --update"
-Update all enabled databases or only the one specified with
-.B -i
-parameter.
+.BI "--dbdir " directory
+Use
+.I directory
+as database directory instead of using the directory specified in the configuration
+file or the hardcoded default if no configuration file is available.
+
.TP
-.BI "-r, --reset"
-Reset the internal counters in the database for the selected
-interface. Use this if the interface goes down and back up,
-otherwise that interface will get some extra traffic to its database.
+.BI "--delete"
+Delete the database for the selected interface and stop monitoring it.
+
.TP
-.BI "--sync"
-Synchronize internal counters in the database with interface
-counters for the selected interface. Use this if the system is
-rebooted but interface counters aren't reseted. Such can occur
-when suspend to ram/disk is used.
+.BI "--dumpdb"
+Instead of showing the database with a formated output, this output will
+dump the whole database in a format that should be easy to parse with most
+script languages. Use this for example with PHP, Perl or Python to make a
+custom webpage. The dump uses ; as field delimeter.
+.TS
+l l.
+ active;1 activity status
+ interface;eth0 name for the interface
+ nick;inet nick (if given)
+ created;1023895272 creation date in Unix time
+ updated;1065467100 when the database was updated
+ totalrx;569605 all time total received MiB
+ totaltx;2023708 all time total transmitted MiB
+ currx;621673719 latest rx value in /proc
+ curtx;981730184 latest tx value in /proc
+ totalrxk;644 total rx KiB counter
+ totaltxk;494 total tx KiB counter
+ btime;1059414541 system boot time in Unix time
+.TE
+
+Then follows 30 lines like the following
+
+ d;0;1078696800;559;7433;68;557;1
+
+where d = days, 0 = day number in database (0 is today), 1077314401 date in
+Unix time, 559 = rx MiB, 7433 = tx MiB, 68 = rx KiB, 557 = tx KiB and 1 tells that
+vnStat has filled this value and it is in use.
+.TS
+l l.
+ m;0;1078092000;48649;139704;527;252;1 (x12)
+ t;0;1078351200;5979;47155;362;525;1 (x10)
+ h;0;1078699800;118265;516545 (x24)
+.TE
+
+m = months, t = top10 and h = hours, all other fields are in the same order as in days
+except hours that doesn't have a separate KiB value. For hours the forth and fifth fields
+have values in KiB.
+
.TP
.BI "--enable, --disable"
Enable or disable updates for selected interface. Useful for
@@ -186,21 +186,42 @@ to the script that's executed when
the interface goes down and
.B "vnstat --enable -i ppp0"
to the up script. These two options aren't needed when the daemon is used.
+
.TP
-.BI "--delete"
-Delete the database for the selected interface and stop monitoring it.
+.BI "-h, --hours"
+Show traffic for the last 24 hours.
+
.TP
-.BI "-v, --version"
-Show current version.
+.BI "-i, --iface " interface
+Select one specific
+.I interface
+and apply actions to only it.
+
.TP
-.BI "--cleartop"
-Remove all top10 entries.
+.BI "--iflist"
+Show list of currently available interfaces.
+
.TP
-.BI "-?, --help"
-Show a command summary.
+.BI "-l, --live"
+Display current transfer rate for the selected interface in real time
+until interrupted. Statistics will be shown after interruption if runtime
+was more than 10 seconds.
+
+.TP
+.BI "--locale " locale
+Use
+.I locale
+instead of using the locale setting specified in the configuration file or the system
+default if no configuration file is available.
+
.TP
.BI "--longhelp"
Show complete options list.
+
+.TP
+.BI "-m, --months"
+Show traffic for months.
+
.TP
.BI "--nick " nickname
Set the selected interfaces
@@ -208,37 +229,7 @@ Set the selected interfaces
as an alias the will be displayed in queries. Usage of
.B -u
is required to save the change.
-.TP
-.BI "--config " file
-Use
-.I file
-as config file instead of using normal config file search function.
-.TP
-.BI "--dbdir " directory
-Use
-.I directory
-as database directory instead of using the directory specified in the configuration
-file or the hardcoded default if no configuration file is available.
-.TP
-.BI "--locale " locale
-Use
-.I locale
-instead of using the locale setting specified in the configuration file or the system
-default if no configuration file is available.
-.TP
-.BI "--rebuildtotal"
-Reset the total traffic counters and recount those using recorded months.
-.TP
-.BI "--testkernel"
-Test if the kernel boot time information always stays the same like it should or
-if it's shifting.
-.TP
-.BI "-D, --debug"
-Show additional debug output.
-.TP
-.BI "--xml"
-Show database content for selected interface or all interfaces in xml format. All
-traffic values in the output are in KiB.
+
.TP
.BI "--oneline"
Show traffic summary for selected interface using one line with a parseable
@@ -250,45 +241,87 @@ fields in order 2) interface name, 3) timestamp for today, 4) rx for today,
8) timestamp for current month, 9) rx for current month, 10) tx for current
month, 11) total for current month, 12) average traffic rate for today,
13) all time total rx, 14) all time total tx, 15) all time total traffic.
+
.TP
-.BI "--dumpdb"
-Instead of showing the database with a formated output, this output will
-dump the whole database in a format that should be easy to parse with most
-script languages. Use this for example with PHP, Perl or Python to make a
-custom webpage. The dump uses ; as field delimeter.
-.TS
-l l.
- active;1 activity status
- interface;eth0 name for the interface
- nick;inet nick (if given)
- created;1023895272 creation date in Unix time
- updated;1065467100 when the database was updated
- totalrx;569605 all time total received MiB
- totaltx;2023708 all time total transmitted MiB
- currx;621673719 latest rx value in /proc
- curtx;981730184 latest tx value in /proc
- totalrxk;644 total rx KiB counter
- totaltxk;494 total tx KiB counter
- btime;1059414541 system boot time in Unix time
-.TE
+.BI "-q, --query"
+Force database query mode.
-Then follows 30 lines like the following
+.TP
+.BI "-r, --reset"
+Reset the internal counters in the database for the selected
+interface. Use this if the interface goes down and back up,
+otherwise that interface will get some extra traffic to its database.
- d;0;1078696800;559;7433;68;557;1
+.TP
+.BI "--rebuildtotal"
+Reset the total traffic counters and recount those using recorded months.
-where d = days, 0 = day number in database (0 is today), 1077314401 date in
-Unix time, 559 = rx MiB, 7433 = tx MiB, 68 = rx KiB, 557 = tx KiB and 1 tells that
-vnStat has filled this value and it is in use.
-.TS
-l l.
- m;0;1078092000;48649;139704;527;252;1 (x12)
- t;0;1078351200;5979;47155;362;525;1 (x10)
- h;0;1078699800;118265;516545 (x24)
-.TE
+.TP
+.BI "-ru, --rateunit"
+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 0 or 1 can be given as
+parameter for this option in order to select between bytes (0) and bits
+(1) regardless of the configuration file setting.
-m = months, t = top10 and h = hours, all other fields are in the same order as in days
-except hours that doesn't have a separate KiB value. For hours the forth and fifth fields
-have values in KiB.
+.TP
+.BI "-s, --short"
+Use short output mode. This mode is also used if more than one
+database is available.
+
+.TP
+.BI "--style " number
+Modify the content and style of outputs. Set
+.I number
+to 0 for a more narrow output, 1 for enabling bar column, 2
+for same as previous but with average traffic rate visible in summary
+and weekly outputs and 3 for enabling average traffic rate in all
+outputs where it is supported.
+
+.TP
+.BI "--sync"
+Synchronize internal counters in the database with interface
+counters for the selected interface. Use this if the system is
+rebooted but interface counters aren't reseted. Such can occur
+when suspend to ram/disk is used.
+
+.TP
+.BI "-t, --top10"
+Show all time top10 traffic days.
+
+.TP
+.BI "--testkernel"
+Test if the kernel boot time information always stays the same like it should or
+if it's shifting.
+
+.TP
+.BI "-tr " time
+Calculate how much traffic goes through the selected interface during
+the given
+.I time
+seconds. The
+.I time
+will be 5 seconds if a number parameter isn't included.
+
+.TP
+.BI "-u, --update"
+Update all enabled databases or only the one specified with
+.B -i
+parameter.
+
+.TP
+.BI "-v, --version"
+Show current version.
+
+.TP
+.BI "-w, --weeks"
+Show traffic for 7 days, current and previous week.
+
+.TP
+.BI "--xml"
+Show database content for selected interface or all interfaces in xml format. All
+traffic values in the output are in KiB.
.SH FILES
.TP
.I /var/lib/vnstat/
@@ -312,7 +345,7 @@ Display traffic summary for a merge of interfaces eth0, eth1 and eth3.
.BI "vnstat -i eth2 --xml"
Output all information about interface eth2 in xml format.
.TP
-.BI "vnstat -u -i eth0"
+.BI "vnstat -u -i eth0"
Force a database update for interface eth0 or create the database if it doesn't
exist. This is usually the first command used after a fresh install.
.TP
@@ -333,9 +366,9 @@ interface can transfer 4 GiB. Calculated theoretical times are:
.RS
.TS
l l.
-10 Mbit: 54 minutes
-100 Mbit: 5 minutes
-1000 Mbit: 30 seconds
+10 Mbit: 54 minutes
+100 Mbit: 5 minutes
+1000 Mbit: 30 seconds
.TE
.RE
--
1.6.5
>From 1628524e28fdb35bbd62b5f161c588f15e972007 Mon Sep 17 00:00:00 2001
From: Jari Aalto <[email protected]>
Date: Wed, 16 Dec 2009 02:28:46 +0200
Subject: [PATCH] man/vnstat.conf.5: order values alphabetically
Signed-off-by: Jari Aalto <[email protected]>
---
man/vnstat.conf.5 | 217 ++++++++++++++++++++++++++++++++--------------------
1 files changed, 133 insertions(+), 84 deletions(-)
diff --git a/man/vnstat.conf.5 b/man/vnstat.conf.5
index 6e9b5d7..f2811cb 100644
--- a/man/vnstat.conf.5
+++ b/man/vnstat.conf.5
@@ -1,4 +1,5 @@
.TH VNSTAT.CONF 5 "SEPTEMBER 2009" "version 1.9" "User Manuals"
+
.SH NAME
vnstat.conf \- vnStat configuration file
.SH SYNOPSIS
@@ -16,40 +17,61 @@ Arguments may optionally be enclosed in double quotes (") in order
to represent arguments containing spaces. Arguments can be padded
with spaces or tabulator characters. A hardcoded default value
will be used if a keyword can't be found from the configuration file.
+
.SH COMMON KEYWORDS
+
+.TP
+.BI BootVariation
+Time in seconds how much the boot time reported by system kernel can variate
+between updates.
+
+.TP
+.BI CheckDiskSpace
+Enable or disable the checking of at least some free disk space before
+a database write. 1 = enabled, 0 = disabled.
+
.TP
.BI DatabaseDir
Specifies the directory where interface databases are to be stored.
A full path must be given and a leading '/' isn't required.
+
+.TP
+.BI "DayFormat, MonthFormat, TopFormat"
+Formatting of date in available outputs. Uses the same format as
+.BR date (1).
+(vnstat and vnstati only)
+
+.TP
+.BI Interface
+Default interface used when no other interface is specified on
+the command line. (vnstat and vnstati only)
+
.TP
.BI Locale
Locale setting to be used for prints. This replaces the LC_ALL
environment variable. Set to "-" in order to use the system default
value. (vnstat and vnstati only)
+
+.TP
+.BI 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)
+
+.TP
+.BI 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)
+
.TP
.BI 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)
-.TP
-.BI "DayFormat, MonthFormat, TopFormat"
-Formatting of date in available outputs. Uses the same format as
-.BR date (1).
-(vnstat and vnstati only)
-.TP
-.BI "RXCharacter, TXCharacter"
-Character used for representing the percentual share of received
-and transmitted traffic in daily output. (vnstat only)
-.TP
-.BI "RXHourCharacter, TXHourCharacter"
-Character used for representing the percentual share of received
-and transmitted traffic in hourly output. (vnstat only)
-.TP
-.BI UnitMode
-Select how units are prefixed. 0 = IEC standard prefixes
-(KiB/MiB/GiB/TiB), 1 = old style binary prefixes (KB/MB/GB/TB).
-(vnstat and vnstati only)
+
.TP
.BI OutputStyle
Modify the content and style of text outputs. 0 = minimal and
@@ -57,143 +79,170 @@ narrow output for terminal with limited width, 1 = normal output with
bar column visible, 2 = same as 1 except rate is visible in summary
and weekly outputs, 3 = rate column is visible in all outputs where it
is supported. (vnstat and vnstati only)
+
+.TP
+.BI QueryMode
+Default query mode when no parameters are given. 0 = normal, 1 = days,
+2 = months, 3 = top10, 4 = dumpdb, 5 = short, 6 = weeks, 7 = hours and
+8 = xml.
+(vnstat only)
+
.TP
.BI RateUnit
Select which unit is used when traffic rate is visible. 0 = bytes, 1 = bits.
(vnstat and vnstati only)
+
.TP
-.BI Interface
-Default interface used when no other interface is specified on
-the command line. (vnstat and vnstati only)
-.TP
-.BI 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)
+.BI "RXCharacter, TXCharacter"
+Character used for representing the percentual share of received
+and transmitted traffic in daily output. (vnstat only)
+
.TP
-.BI 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)
+.BI "RXHourCharacter, TXHourCharacter"
+Character used for representing the percentual share of received
+and transmitted traffic in hourly output. (vnstat only)
+
.TP
.BI Sampletime
Defines how many seconds the -tr option will sample traffic. (vnstat only)
+
.TP
-.BI QueryMode
-Default query mode when no parameters are given. 0 = normal, 1 = days,
-2 = months, 3 = top10, 4 = dumpdb, 5 = short, 6 = weeks, 7 = hours and
-8 = xml.
-(vnstat only)
+.BI TrafficlessDays
+Log days without any traffic to daily list. 1 = enabled, 0 = disabled.
+(vnstat and vnstatd only)
+
.TP
-.BI CheckDiskSpace
-Enable or disable the checking of at least some free disk space before
-a database write. 1 = enabled, 0 = disabled.
+.BI UnitMode
+Select how units are prefixed. 0 = IEC standard prefixes
+(KiB/MiB/GiB/TiB), 1 = old style binary prefixes (KB/MB/GB/TB).
+(vnstat and vnstati only)
+
.TP
.BI UseFileLocking
Enable or disable the use of file locking during database access. Disabling
file locking may cause database corruption if several processes are trying
to write to the file at the same time.
+
+.SH DAEMON RELATED KEYWORDS
+
.TP
-.BI BootVariation
-Time in seconds how much the boot time reported by system kernel can variate
-between updates.
+.BI LogFile
+Specify log file path and name to be used if UseLogging is set to 1.
+
.TP
-.BI TrafficlessDays
-Log days without any traffic to daily list. 1 = enabled, 0 = disabled.
-(vnstat and vnstatd only)
-.SH DAEMON RELATED KEYWORDS
+.BI OfflineSaveInterval
+How often in minutes cached interface data is saved to file when all monitored
+interfaces are offline.
+
.TP
-.BI UpdateInterval
-How often in seconds the interface data is updated.
+.BI PidFile
+Specify pid file path and name to be used.
+
.TP
.BI PollInterval
How often in seconds interfaces are checked for status changes.
+
.TP
.BI SaveInterval
How often in minutes cached interface data is saved to file.
-.TP
-.BI OfflineSaveInterval
-How often in minutes cached interface data is saved to file when all monitored
-interfaces are offline.
+
.TP
.BI SaveOnStatusChange
Enable or disable the additional saving to file of cached interface data
when the availability of an interface changes, i.e., when an interface goes
offline or comes online. 1 = enabled, 0 = disabled.
+
+.TP
+.BI UpdateInterval
+How often in seconds the interface data is updated.
+
.TP
.BI UseLogging
Enable or disable logging. 0 = disabled, 1 = logfile and 2 = syslog.
-.TP
-.BI LogFile
-Specify log file path and name to be used if UseLogging is set to 1.
-.TP
-.BI PidFile
-Specify pid file path and name to be used.
+
.SH IMAGE OUTPUT RELATED KEYWORDS
-.TP
-.BI HeaderFormat
-Formatting of date in header. Uses the same format as
-.BR date (1).
-.TP
-.BI HourlyRate
-Show hours with rate instead of transfered amount. 1 = enabled, 0 = disabled.
-.TP
-.BI SummaryRate
-Show rate in summary output if available. 1 = enabled, 0 = disabled.
-.TP
-.BI SummaryLayout
-Select the used layout of the summary output. 1 = layout introduced in version
-1.8 with monthly traffic included, 0 = layout used before version 1.8, doesn't
-contain monthly traffic and doesn't support average rate.
-.TP
-.BI TransparentBg
-Set background color as transparent. 1 = enabled, 0 = disabled.
+
.TP
.BI CBackground
Background color.
+
.TP
.BI CEdge
Edge color if visible.
+
.TP
.BI CHeader
Header background color.
-.TP
-.BI CHeaderTitle
-Header title text color.
+
.TP
.BI CHeaderDate
Header date text color.
+
.TP
-.BI CText
-Common text color.
+.BI CHeaderTitle
+Header title text color.
+
.TP
.BI CLine
Line color.
+
.TP
.BI CLineL
Lighter version of line color. Set to '-' in order to use a calculated
value based on CLine.
+
.TP
.BI CRx
Color for received data.
-.TP
-.BI CTx
-Color for transmitted data.
+
.TP
.BI CRxD
Darker version of received data color. Set to '-' in order to use
a calculated value based on CRx.
+
+.TP
+.BI CTx
+Color for transmitted data.
+
.TP
.BI CTxD
Darker version of transmitted data color. Set to '-' in order to use
a calculated value based on CTx.
+
+.TP
+.BI CText
+Common text color.
+
+.TP
+.BI HeaderFormat
+Formatting of date in header. Uses the same format as
+.BR date (1).
+
+.TP
+.BI HourlyRate
+Show hours with rate instead of transfered amount. 1 = enabled, 0 = disabled.
+
+.TP
+.BI SummaryLayout
+Select the used layout of the summary output. 1 = layout introduced in version
+1.8 with monthly traffic included, 0 = layout used before version 1.8, doesn't
+contain monthly traffic and doesn't support average rate.
+
+.TP
+.BI SummaryRate
+Show rate in summary output if available. 1 = enabled, 0 = disabled.
+
+.TP
+.BI TransparentBg
+Set background color as transparent. 1 = enabled, 0 = disabled.
.SH FILES
+
.TP
.I /etc/vnstat.conf
Config file that will be used unless
.I $HOME/.vnstatrc
exists or alternative value is given as command line parameter.
+
.SH AUTHOR
Teemu Toivola <tst at iki dot fi>
.SH "SEE ALSO"
--
1.6.5
>From eecec68e13b9d25b494927928c3d467348fc46a0 Mon Sep 17 00:00:00 2001
From: Jari Aalto <[email protected]>
Date: Wed, 16 Dec 2009 02:30:52 +0200
Subject: [PATCH] man/vnstatd.1: order options alphabetically
Signed-off-by: Jari Aalto <[email protected]>
---
man/vnstatd.1 | 51 +++++++++++++++++++++++++++++++--------------------
1 files changed, 31 insertions(+), 20 deletions(-)
diff --git a/man/vnstatd.1 b/man/vnstatd.1
index 6f1687d..58e6103 100644
--- a/man/vnstatd.1
+++ b/man/vnstatd.1
@@ -46,14 +46,42 @@ in the database directory that has been specified in the
configuration
file and exit if no databases can be found. The reason for this behaviour
is to avoid starting the daemon when it's clear that it wouldn't have
anything to do.
+
.SH OPTIONS
+
+.TP
+.BI "-?, --help"
+Show a command summary.
+
+.TP
+.BI "--config " file
+Use
+.I file
+as config file instead of using normal config file search function.
+
.TP
.BI "-d, --daemon"
Fork process to background and run as a daemon.
+
+.TP
+.BI "-D, --debug"
+Provide additional output for debug purposes. The process will stay
+attached to the terminal for output.
+
.TP
.BI "-n, --nodaemon"
Stay in foreground attached to the current terminal and start update
process.
+
+.TP
+.BI "-p, --pidfile " file
+Write the process id to
+.I file
+and use it for locking so that another instance of the daemon cannot
+be started if the same
+.I file
+is specified.
+
.TP
.BI "-s, --sync"
Synchronize internal counters in the database with interface
@@ -64,29 +92,12 @@ isn't required in normal use because the daemon will
automatically synchronize
the internal counters after a system reboot, if enought time has passed
since the daemon was previously running or if the internal counters are
clearly out of sync.
-.TP
-.BI "-D, --debug"
-Provide additional output for debug purposes. The process will stay
-attached to the terminal for output.
-.TP
-.BI "-?, --help"
-Show a command summary.
+
.TP
.BI "-v, --version"
Show current version.
-.TP
-.BI "-p, --pidfile " file
-Write the process id to
-.I file
-and use it for locking so that another instance of the daemon cannot
-be started if the same
-.I file
-is specified.
-.TP
-.BI "--config " file
-Use
-.I file
-as config file instead of using normal config file search function.
+
+
.SH CONFIGURATION
The behaviour of the daemon is configured mainly using the configuration
keywords
--
1.6.5
>From f85cc85a04275108b4e91a2c1d9abbe5bb07f15f Mon Sep 17 00:00:00 2001
From: Jari Aalto <[email protected]>
Date: Wed, 16 Dec 2009 02:34:27 +0200
Subject: [PATCH] man/vnstati.1: order options alphabetically
Signed-off-by: Jari Aalto <[email protected]>
---
man/vnstati.1 | 113 ++++++++++++++++++++++++++++++++++-----------------------
1 files changed, 68 insertions(+), 45 deletions(-)
diff --git a/man/vnstati.1 b/man/vnstati.1
index 240f8b1..0a22ab4 100644
--- a/man/vnstati.1
+++ b/man/vnstati.1
@@ -74,35 +74,77 @@ is to provide image output support for statistics collected
using
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.
+
.SH OPTIONS
+
.TP
-.BI "-s, --summary"
-Output traffic summary.
+.BI "-?, --help"
+Show a command summary.
+
.TP
-.BI "-hs, --hsummary"
-Output traffic summary including hourly data using a horizontal layout.
+.BI "-c, --cache " time
+Update output file only if at least
+.I time
+minutes have passed since the previous file update. This option is ignored if
+stdout is used as output.
+
.TP
-.BI "-vs, --vsummary"
-Output traffic summary including hourly data using a vertical layout.
+.BI "--config " file
+Use
+.I file
+as config file instead of using normal config file search function.
+
.TP
.BI "-d, --days"
Output traffic for days.
+
+.TP
+.BI "--dbdir " directory
+Use
+.I directory
+as database directory instead of using the directory specified in the
configuration
+file or the hardcoded default if no configuration file is available.
+
.TP
.BI "-h, --hours"
Output traffic for the last 24 hours.
+
+.TP
+.BI "-hs, --hsummary"
+Output traffic summary including hourly data using a horizontal layout.
+
+.TP
+.BI "-i, --iface " interface
+Use
+.I interface
+instead of default or configured interface.
+
+.TP
+.BI "--locale " locale
+Use
+.I locale
+instead of using the locale setting specified in the configuration file or the
system
+default if no configuration file is available.
+
.TP
.BI "-m, --months"
Output traffic for months.
-.TP
-.BI "-t, --top10"
-Output all time top10 traffic days.
+
.TP
.BI "-ne, --noedge"
Remove darker edges from around the image.
+
.TP
.BI "-nh, --noheader"
Remove header containing title and update time. Time of the previous update
will still be visible in the lower right corner using a less visible color.
+
+.TP
+.BI "-o, --output " file
+Write png image to
+.I file
+and exit. Output can be directed to stdout by giving "-" as filename.
+
.TP
.BI "-ru, --rateunit"
Swap the configured rate unit. If rate has been configured to be shown in
@@ -111,57 +153,38 @@ way, if rate has been configured to be shown in bits then
rate will be shown
in bytes when this option is present. Alternatively 0 or 1 can be given as
parameter for this option in order to select between bytes (0) and bits
(1) regardless of the configuration file setting.
+
+.TP
+.BI "-s, --summary"
+Output traffic summary.
+
.TP
.BI "--style " number
Modify the content and style of outputs. Setting
.I number
to 3 will show average traffic rate in all outputs where it is supported.
Other values will show bar graphics instead.
+
+.TP
+.BI "-t, --top10"
+Output all time top10 traffic days.
+
.TP
.BI "--transparent"
Toggle background color transparency depending of the TransparentBg setting
in the configuration file. Alternatively 0 or 1 can be given as parameter
for this option in order to either disable (0) or enable (1) transparency
regardless of the configuration file setting.
-.TP
-.BI "-o, --output " file
-Write png image to
-.I file
-and exit. Output can be directed to stdout by giving "-" as filename.
-.TP
-.BI "-c, --cache " time
-Update output file only if at least
-.I time
-minutes have passed since the previous file update. This option is ignored if
-stdout is used as output.
-.TP
-.BI "-i, --iface " interface
-Use
-.I interface
-instead of default or configured interface.
-.TP
-.BI "--config " file
-Use
-.I file
-as config file instead of using normal config file search function.
-.TP
-.BI "--dbdir " directory
-Use
-.I directory
-as database directory instead of using the directory specified in the
configuration
-file or the hardcoded default if no configuration file is available.
-.TP
-.BI "--locale " locale
-Use
-.I locale
-instead of using the locale setting specified in the configuration file or the
system
-default if no configuration file is available.
-.TP
-.BI "-?, --help"
-Show a command summary.
+
.TP
.BI "-v, --version"
Show current version.
+
+.TP
+.BI "-vs, --vsummary"
+Output traffic summary including hourly data using a vertical layout.
+
+
.SH FILES
.TP
.I /var/lib/vnstat/
--
1.6.5
