From 61212b28021720f21a0b1fe885804adf4f1251e1 Mon Sep 17 00:00:00 2001 From: Teemu Toivola Date: Thu, 18 Sep 2014 22:03:46 +0300 Subject: [PATCH] man page syntax cleanup --- man/vnstat.1 | 82 +++++++++++++++++------------------ man/vnstat.conf.5 | 108 +++++++++++++++++++++++----------------------- man/vnstatd.1 | 50 ++++++++++----------- man/vnstati.1 | 38 ++++++++-------- 4 files changed, 139 insertions(+), 139 deletions(-) diff --git a/man/vnstat.1 b/man/vnstat.1 index 5d62dac..03e2944 100644 --- a/man/vnstat.1 +++ b/man/vnstat.1 @@ -109,7 +109,7 @@ daily and monthly network traffic for the selected interface(s). However, it isn't a packet sniffer. The traffic information is read from the .BR proc (5) or -.BR sys +.B sys filesystems depending on availability. That way vnStat can be used even without root permissions on most systems. .PP @@ -125,7 +125,7 @@ time sleeping between data updates. .SH OPTIONS .TP -.BI "--cleartop" +.B "--cleartop" Remove all top 10 entries. .TP @@ -136,15 +136,15 @@ as configuration file instead of using normal configuration file search functionality. .TP -.BI "--create" +.B "--create" Create database for interface specified with -.B -i +.B \-i or -.B --iface +.B \-\-iface option. .TP -.BI "-d, --days" +.B "-d, --days" Show traffic statistics on a daily basis for the last 30 days. .TP @@ -155,19 +155,19 @@ as database directory instead of using the directory specified in the configurat file or the hardcoded default if no configuration file is available. .TP -.BI "-D, --debug" +.B "-D, --debug" Show additional debug output. .TP -.BI "--delete" +.B "--delete" Delete the database for the interface specified with -.B -i +.B \-i or -.B --iface +.B \-\-iface and stop monitoring it. .TP -.BI "--enable, --disable" +.B "--enable, --disable" Enable or disable updates for selected interface. Useful for interfaces that aren't always available, like ppp0. If the interface goes down it should be disabled in order to avoid errors. Add something @@ -179,11 +179,11 @@ the interface goes down and to the up script. These two options aren't needed when the daemon is used. .TP -.BI "--exportdb" +.B "--exportdb" 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 or imported back using the -.B --importdb +.B "--importdb" option. Use this for example with PHP, Perl or Python to make a custom webpage. The dump uses ; as field delimeter. .TS @@ -221,7 +221,7 @@ except hours that doesn't have a separate KiB value. For hours the forth and fif have values in KiB. .TP -.BI "-h, --hours" +.B "-h, --hours" Show traffic statistics on a hourly basis for the last 24 hours. .TP @@ -229,7 +229,7 @@ Show traffic statistics on a hourly basis for the last 24 hours. Import a database from .I file which was previously exported using the -.BI "--exportdb" +.B "--exportdb" option. This can be used to transfer a database between different architectures and machines, as the database is architecture dependant and not compatible between different architectures. First dump the database on one machine, e.g. with @@ -247,7 +247,7 @@ information of two or more interfaces using the syntax. .TP -.BI "--iflist" +.B "--iflist" Show list of currently available interfaces. .TP @@ -269,11 +269,11 @@ instead of using the locale setting specified in the configuration file or the s default if no configuration file is available. .TP -.BI "--longhelp" +.B "--longhelp" Show complete options list. .TP -.BI "-m, --months" +.B "-m, --months" Show traffic statistics on a monthly basis for the last 12 months. .TP @@ -281,12 +281,12 @@ Show traffic statistics on a monthly basis for the last 12 months. Set the selected interfaces .I nickname as an alias the will be displayed in queries. Usage of -.B -u +.B \-u is required to save the change and the daemon may not be running during the set operation. .TP -.BI "--oneline" +.B "--oneline" Show traffic summary for selected interface using one line with a parseable format. The output contains 15 fields with ; used as field delimeter. The 1st field contains the version information of the output that will be changed @@ -298,22 +298,22 @@ 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 "-q, --query" +.B "-q, --query" Force database query mode. .TP -.BI "-r, --reset" +.B "-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. Not needed when the daemon is used. .TP -.BI "--rebuildtotal" +.B "--rebuildtotal" Reset the total traffic counters and recount those using recorded months. .TP -.BI "-ru, --rateunit" +.B "-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 @@ -322,7 +322,7 @@ parameter for this option in order to select between bytes (0) and bits (1) regardless of the configuration file setting. .TP -.BI "--savemerged" +.B "--savemerged" Write the end result of a database merge to the file .I mergeddb that can then be used as a new database if renamed. Top 10 traffic days @@ -332,7 +332,7 @@ The merge interface syntax is documented in option. .TP -.BI "-s, --short" +.B "-s, --short" Use short output mode. This mode is also used if more than one database is available. @@ -349,19 +349,19 @@ characters in mode. .TP -.BI "--sync" +.B "--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. Not needed when the daemon is used. .TP -.BI "--testkernel" +.B "--testkernel" Test if the kernel boot time information always stays the same like it should or if it's shifting. .TP -.BI "-t, --top10" +.B "-t, --top10" Show all time top 10 traffic days. .TP @@ -374,26 +374,26 @@ seconds. The will be 5 seconds if a number parameter isn't specified. .TP -.BI "-u, --update" +.B "-u, --update" Update all enabled databases or only the one specified with -.B -i +.B \-i parameter. Not supported when the daemon is running. .TP -.BI "-v, --version" +.B "-v, --version" Show current version. .TP -.BI "-w, --weeks" +.B "-w, --weeks" Show traffic for 7 days, current and previous week. .TP -.BI "--xml" +.B "--xml" Show database content for selected interface or all interfaces in xml format. All traffic values in the output are in KiB. .TP -.BI "-?, --help" +.B "-?, --help" Show a command option summary. .SH FILES @@ -416,32 +416,32 @@ for more information. .SH EXAMPLES .TP -.BI "vnstat" +.B "vnstat" Display traffic summary for the default interface or multiple interfaces when more than one is monitored. .TP -.BI "vnstat -i eth0+eth1+eth3" +.B "vnstat -i eth0+eth1+eth3" Display traffic summary for a merge of interfaces eth0, eth1 and eth3. .TP -.BI "vnstat -i eth2 --xml" +.B "vnstat -i eth2 --xml" Output all information about interface eth2 in xml format. .TP -.BI "vnstat -u -i eth0" +.B "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 if the daemon isn't used. .TP -.BI "vnstat -u -i eth0 --nick local" +.B "vnstat -u -i eth0 --nick local" Give interface eth0 the nickname "local". That information will be later later visible as a label when eth0 is queried. The database will also be updated when this command is executed or created if the database doesn't exist. .TP -.BI "vnstat -i eth2 --delete" +.B "vnstat -i eth2 --delete" Delete database of interface eth2 and stop monitoring it. .SH RESTRICTIONS diff --git a/man/vnstat.conf.5 b/man/vnstat.conf.5 index f8cd686..babddf9 100644 --- a/man/vnstat.conf.5 +++ b/man/vnstat.conf.5 @@ -30,59 +30,59 @@ the daemon related keywords and the last section for the image output. .SH COMMON KEYWORDS .TP -.BI BootVariation +.B BootVariation Time in seconds how much the boot time reported by system kernel can variate between updates. .TP -.BI CheckDiskSpace +.B CheckDiskSpace Enable or disable the checking of at least some free disk space before a database write. 1 = enabled, 0 = disabled. .TP -.BI DatabaseDir +.B 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" +.B "DayFormat, MonthFormat, TopFormat" Formatting of date in available outputs. Uses the same format as .BR date (1). (vnstat and vnstati only) .TP -.BI Interface +.B Interface Default interface used when no other interface is specified on the command line. (vnstat and vnstati only) .TP -.BI Locale +.B Locale Locale setting to be used for prints. This replaces the LC_ALL environment variable. Set to "-" or leave empty in order to use the system default value. (vnstat and vnstati only) .TP -.BI MaxBandwidth +.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) .TP -.BI MaxBW +.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) .TP -.BI MonthRotate +.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) .TP -.BI OutputStyle +.B OutputStyle Modify the content and style of text outputs. 0 = minimal and narrow output for terminal with limited width, 1 = normal output with bar column visible, 2 = same as 1 except rate is visible in summary @@ -90,44 +90,44 @@ and weekly outputs, 3 = rate column is visible in all outputs where it is supported. (vnstat and vnstati only) .TP -.BI QueryMode +.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) .TP -.BI RateUnit +.B RateUnit Select which unit is used when traffic rate is visible. 0 = bytes, 1 = bits. (vnstat and vnstati only) .TP -.BI "RXCharacter, TXCharacter" +.B "RXCharacter, TXCharacter" Character used for representing the percentual share of received and transmitted traffic in daily output. (vnstat only) .TP -.BI "RXHourCharacter, TXHourCharacter" +.B "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) +.B Sampletime +Defines how many seconds the \-tr option will sample traffic. (vnstat only) .TP -.BI TrafficlessDays +.B TrafficlessDays Log days without any traffic to daily list. 1 = enabled, 0 = disabled. (vnstat and vnstatd only) .TP -.BI UnitMode +.B 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 +.B 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. @@ -135,154 +135,154 @@ to write to the file at the same time. .SH DAEMON RELATED KEYWORDS .TP -.BI CreateDirs +.B CreateDirs Enable or disable the creation of directories when a configured path doesn't exist. This includes -.BI DatabaseDir +.B DatabaseDir , -.BI LogFile +.B LogFile and -.BI PidFile +.B PidFile directories. The -.BI LogFile +.B LogFile directory will be created only when -.BI UseLogging +.B UseLogging has been set to 1. The -.BI PidFile +.B PidFile directory will be created only if the daemon is started as a background process. The daemon process will try to create the directory using permissions of the user used to start the process. .TP -.BI DaemonGroup +.B DaemonGroup Specify the user to which the daemon process will switch during startup. The user can either be the name of the group or a numerical group id. Leave empty to disable the group switch. This option can only be used when the process is started as root. .TP -.BI DaemonUser +.B DaemonUser Specify the user to which the daemon process will switch during startup. The user can either be the login of the user or a numerical user id. Leave empty to disable the user switch. This option can only be used when the process is started as root. .TP -.BI LogFile +.B LogFile Specify log file path and name to be used if UseLogging is set to 1. .TP -.BI OfflineSaveInterval +.B OfflineSaveInterval How often in minutes cached interface data is saved to file when all monitored interfaces are offline. .TP -.BI PidFile +.B PidFile Specify pid file path and name to be used. .TP -.BI PollInterval +.B PollInterval How often in seconds interfaces are checked for status changes. .TP -.BI SaveInterval +.B SaveInterval How often in minutes cached interface data is saved to file. .TP -.BI SaveOnStatusChange +.B 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 UpdateFileOwner +.B UpdateFileOwner Enable or disable the update of file ownership during daemon process startup. Only database, log and pid files will be modified if the user or group change feature is enabled and the files don't match the requested user or group. This option can only be used when the process is started as root. .TP -.BI UpdateInterval +.B UpdateInterval How often in seconds the interface data is updated. .TP -.BI UseLogging +.B UseLogging Enable or disable logging. 0 = disabled, 1 = logfile and 2 = syslog. .SH IMAGE OUTPUT RELATED KEYWORDS .TP -.BI CBackground +.B CBackground Background color. .TP -.BI CEdge +.B CEdge Edge color if visible. .TP -.BI CHeader +.B CHeader Header background color. .TP -.BI CHeaderTitle +.B CHeaderTitle Header title text color. .TP -.BI CHeaderDate +.B CHeaderDate Header date text color. .TP -.BI CLine +.B CLine Line color. .TP -.BI CLineL +.B CLineL Lighter version of line color. Set to '-' in order to use a calculated value based on CLine. .TP -.BI CRx +.B CRx Color for received data. .TP -.BI CRxD +.B CRxD Darker version of received data color. Set to '-' in order to use a calculated value based on CRx. .TP -.BI CText +.B CText Common text color. .TP -.BI CTx +.B CTx Color for transmitted data. .TP -.BI CTxD +.B CTxD Darker version of transmitted data color. Set to '-' in order to use a calculated value based on CTx. .TP -.BI HeaderFormat +.B HeaderFormat Formatting of date in header. Uses the same format as .BR date (1). .TP -.BI HourlyRate +.B HourlyRate Show hours with rate instead of transfered amount. 1 = enabled, 0 = disabled. .TP -.BI SummaryLayout +.B 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 +.B SummaryRate Show rate in summary output if available. 1 = enabled, 0 = disabled. .TP -.BI TransparentBg +.B TransparentBg Set background color as transparent. 1 = enabled, 0 = disabled. .SH FILES diff --git a/man/vnstatd.1 b/man/vnstatd.1 index 6857abd..711e60b 100644 --- a/man/vnstatd.1 +++ b/man/vnstatd.1 @@ -82,11 +82,11 @@ as configuration file instead of using normal configuration file search functionality. .TP -.BI "-d, --daemon" +.B "-d, --daemon" Fork process to background and run as a daemon. .TP -.BI "-D, --debug" +.B "-D, --debug" Provide additional output for debug purposes. The process will stay attached to the terminal for output. @@ -100,13 +100,13 @@ can be either the name of the group or a numerical group id. This option can only be used when the process is started as root. .TP -.BI "--noadd" +.B "--noadd" Disable automatic creation of new databases for all available interfaces if the daemon is started with zero database found. Pseudo interfaces lo, lo0 and sit0 are excluded from getting added. .TP -.BI "-n, --nodaemon" +.B "-n, --nodaemon" Stay in foreground attached to the current terminal and start the update process. @@ -120,7 +120,7 @@ be started if the same is specified. .TP -.BI "-s, --sync" +.B "-s, --sync" Synchronize internal counters in the database with interface counters for all available interfaces before starting traffic monitoring. Use this option if the traffic between the previous shutdown @@ -140,52 +140,52 @@ can be either the login of the user or a numerical user id. This option can only be used when the process is started as root. .TP -.BI "-v, --version" +.B "-v, --version" Show current version of the daemon executable. .TP -.BI "-?, --help" +.B "-?, --help" Show a command option summary. .SH CONFIGURATION The behaviour of the daemon is configured mainly using the configuration keywords -.BR "UpdateInterval, PollInterval" +.B "UpdateInterval, PollInterval" and -.BR SaveInterval +.B SaveInterval in the configuration file. .PP -.BR UpdateInterval +.B UpdateInterval defines in seconds how often the interface data is fetched and updated. This is similar to the run interval for alternative cron based updating. However, the difference is that the data doesn't directly get written to disk during updates. .PP -.BR PollInterval +.B PollInterval defines in seconds how often the list of available interfaces is checked for possible changes. The minimum value is 2 seconds and the maximum 60 seconds. -.BR PollInterval +.B PollInterval also defines the resolution for other intervals. .PP -.BR SaveInterval +.B SaveInterval defines in minutes how often cached interface data is written to disk. A write can only occur during the updating of interface data. Therefore, the value should be a multiple of -.BR UpdateInterval +.B UpdateInterval with a maximum value of 60 minutes. .PP The default values of -.BR UpdateInterval +.B UpdateInterval 30, -.BR SaveInterval +.B SaveInterval 5 and -.BR PollInterval +.B PollInterval 5 are usually suitable for most systems and provide a similar behaviour as cron based updating does but with a better resolution for interface changes and fast interfaces. @@ -193,32 +193,32 @@ changes and fast interfaces. .PP For embedded and/or low power systems more tuned configurations are possible. In such cases if the interfaces are mostly static the -.BR PollInterval +.B PollInterval can be increased to around 10-30 seconds and -.BR UpdateInterval +.B UpdateInterval set to 60 seconds. Higher values up to 300 seconds are possible if the interface speed is 10 Mbit or less. -.BR SaveInterval +.B SaveInterval can be increased for example to 15, 30 or even 60 minutes depending on how often the data needs to be viewed. .SH SIGNALS The daemon is listening to signals -.BR "SIGHUP, SIGINT" +.B "SIGHUP, SIGINT" and -.BR SIGTERM. +.B SIGTERM. Sending the -.BR SIGHUP +.B SIGHUP signal to the daemon will cause cached data to be written to disk, a rescan of the database directory and a reload of settings from the configuration file. However, the pid file location will not be changed even if it's configuration setting has been modified. .PP -.BR SIGTERM +.B SIGTERM and -.BR SIGINT +.B SIGINT signals will cause the daemon to write all cached data to disk and then exit. diff --git a/man/vnstati.1 b/man/vnstati.1 index 04c50f8..10586a2 100644 --- a/man/vnstati.1 +++ b/man/vnstati.1 @@ -101,7 +101,7 @@ as configuration file instead of using normal configuration file search functionality. .TP -.BI "-d, --days" +.B "-d, --days" Output traffic statistics on a daily basis for the last 30 days. .TP @@ -112,11 +112,11 @@ as database directory instead of using the directory specified in the configurat file or the hardcoded default if no configuration file is available. .TP -.BI "-h, --hours" +.B "-h, --hours" Output traffic statistics on a hourly basis for the last 24 hours. .TP -.BI "-hs, --hsummary" +.B "-hs, --hsummary" Output traffic summary including hourly data using a horizontal layout. .TP @@ -133,20 +133,20 @@ instead of using the locale setting specified in the configuration file or the s default if no configuration file is available. .TP -.BI "-m, --months" +.B "-m, --months" Output traffic statistics on a monthly basis for the last 12 months. .TP -.BI "-ne, --noedge" +.B "-ne, --noedge" Remove darker edges from around the image. .TP -.BI "-nh, --noheader" +.B "-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 "-nl, --nolegend" +.B "-nl, --nolegend" Remove legend containing rx and tx color mapping information from the image. .TP @@ -156,7 +156,7 @@ Write png image to and exit. Output can be directed to stdout by giving "-" as filename. .TP -.BI "-ru, --rateunit" +.B "-ru, --rateunit" Change 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 @@ -172,30 +172,30 @@ to 3 will show average traffic rate in all outputs where it is supported. Other values will show bar graphics instead. .TP -.BI "-s, --summary" +.B "-s, --summary" Output traffic statistics summary. .TP -.BI "-t, --top10" +.B "-t, --top10" Output all time top 10 traffic days. .TP -.BI "--transparent" +.B "--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 "-v, --version" +.B "-v, --version" Show current version. .TP -.BI "-vs, --vsummary" +.B "-vs, --vsummary" Output traffic summary including hourly data using a vertical layout. .TP -.BI "-?, --help" +.B "-?, --help" Show a command option summary. .SH FILES @@ -213,26 +213,26 @@ for more information. .SH EXAMPLES .TP -.BI "vnstati -s -i eth0 -o /tmp/vnstat.png" +.B "vnstati -s -i eth0 -o /tmp/vnstat.png" Output traffic summary for interface eth0 to file /tmp/vnstat.png. .TP -.BI "vnstati -vs -i eth0+eth1+eth2 -o /tmp/vnstat.png" +.B "vnstati -vs -i eth0+eth1+eth2 -o /tmp/vnstat.png" Output traffic summary with hourly data under the normal summary for a merge of interfaces eth0, eth1 and eth2 to file /tmp/vnstat.png. .TP -.BI "vnstati -h -c 15 -o /tmp/vnstat_h.png" +.B "vnstati -h -c 15 -o /tmp/vnstat_h.png" Output hourly traffic statistics for default interface to file /tmp/vnstat_h.png if the file has not been updated within the last 15 minutes. .TP -.BI "vnstati -d -ne -nh -o -" +.B "vnstati -d -ne -nh -o -" Output daily traffic statistics without displaying the header section and edges for default interface to standard output (stdout). .TP -.BI "vnstati -m --config /home/me/vnstat.cfg -i -o -" +.B "vnstati -m --config /home/me/vnstat.cfg -i -o -" Output monthly traffic statistics for default interface specified in configuration file /home/me/vnstat.cfg to standard output (stdout). -- 2.40.0