From: Teemu Toivola Date: Sat, 22 Sep 2018 12:13:13 +0000 (+0300) Subject: update documentation, add missing parameters X-Git-Tag: v2.0~9 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a0407ae8c01862174132c58d2614459efbf4afaa;p=vnstat update documentation, add missing parameters --- diff --git a/README.md b/README.md index 32d0f29..90b0ef6 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,6 @@ durations. Yearly and five-minute resolution statistics are now included. ##### TODO - * `grep TODO src/* tests/*` * feature configurability * is something still missing? * documentation diff --git a/man/vnstat.1 b/man/vnstat.1 index 7242e3f..02bfa55 100644 --- a/man/vnstat.1 +++ b/man/vnstat.1 @@ -5,7 +5,7 @@ vnstat \- a console-based network traffic monitor .SH SYNOPSIS .B vnstat -.RB [ \-5bDedhlmqrstvw? ] +.RB [ \-5bDedhlmqrstvwy? ] .RB [ \-\-add ] .RB [ \-\-begin .IR date ] @@ -66,6 +66,8 @@ vnstat \- a console-based network traffic monitor .RB [ \-\-xml .RI [ mode ] .RI [ limit ]] +.RB [ \-\-years +.RI [ count ]] .SH DESCRIPTION @@ -299,6 +301,11 @@ as an alias that will be displayed in queries. Use short output mode. This mode is also used if more than one database is available. +.TP +.B "--showconfig" +Show current configuration using the same format as the configuration file +itself uses. + .TP .BI "--style " number Modify the content and style of outputs. Set @@ -326,7 +333,7 @@ The availability of daily data defines the boundaries the date specific query can access. .TP -.BI "-tr " [time] +.BI "-tr, --traffic " [time] Calculate how much traffic goes through the selected interface during the given .I time @@ -355,6 +362,15 @@ years and 't' the top days. An optional parameter can be used to limit the number results to a given number of most recent entries. +.TP +.BI "-y, --years " [count] +Show traffic statistics on a yearly basis for the last years. The list will show all +entries by default unless configured otherwise or unless the optional +.I count +parameter is used. All entries stored in the database will also be shown if +.I count +is set to 0. + .TP .B "-?, --help" Show a command option summary. diff --git a/man/vnstati.1 b/man/vnstati.1 index a5e3b19..dc12e29 100644 --- a/man/vnstati.1 +++ b/man/vnstati.1 @@ -5,7 +5,7 @@ vnstati \- png image output support for vnStat .SH SYNOPSIS .B vnstati -.RB [ \-5bcdehimostv? ] +.RB [ \-5bcdDehimostvy? ] .RB [ \-\-altdate ] .RB [ \-\-begin .IR date ] @@ -17,6 +17,7 @@ vnstati \- png image output support for vnStat .RI [ count ]] .RB [ \-\-dbdir .IR directory ] +.RB [ \-\-debug ] .RB [ \-\-end .IR date ] .RB [ \-\-fiveminutes @@ -59,6 +60,8 @@ vnstati \- png image output support for vnStat .RB [ \-\-version ] .RB [ \-vs ] .RB [ \-\-vsummary ] +.RB [ \-\-months +.RI [ count ]] .SH DESCRIPTION @@ -122,6 +125,10 @@ Use as database directory instead of using the directory specified in the configuration file or the hardcoded default if no configuration file is available. +.TP +.B "-D, --debug" +Show additional debug output. + .TP .BI "-e, --end " date End the list output with a specific date / time defined by @@ -267,6 +274,15 @@ Show current version. .B "-vs, --vsummary" Output traffic summary including hourly data bar graph using a vertical layout. +.TP +.BI "-y, --years " [count] +Output traffic statistics on a yearly basis for the last years. The list will show all +entries by default unless configured otherwise or unless the optional +.I count +parameter is used. All entries stored in the database will also be shown if +.I count +is set to 0. + .TP .B "-?, --help" Show a command option summary.