summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Drescher <adam.r.drescher@gmail.com>2016-10-07 11:37:13 -0500
committerAdam Drescher <adam.r.drescher@gmail.com>2016-10-07 11:37:13 -0500
commit5b938e05c74ef0f6c162b1899b517440297996d6 (patch)
tree45f57c5f3e75fc0cb174b20a941d2362c88bd242
parent5cd24ffd6a952d6fa7bf2281c343b218dc95a071 (diff)
Added a format string example to the man page. While the documentation is clear, it is nice to see an example to get started. Single quotes are used to prevent the shell from running our bmon patterns as commands, and to prevent it from doing wildcard expansion for the interface string.
-rw-r--r--man/bmon.88
1 files changed, 8 insertions, 0 deletions
diff --git a/man/bmon.8 b/man/bmon.8
index ec4431c..e371ad8 100644
--- a/man/bmon.8
+++ b/man/bmon.8
@@ -220,6 +220,14 @@ and eth1:
.RS 4
\fBbmon \-p eth0,eth1 \-o curses\fP
.RE
+.PP
+To run bmon in format mode, monitoring any eth* interfaces, with a specified
+format string:
+.PP
+.RS 4
+\fBbmon \-p \(aqeth*\(aq \-o format:fmt=\(aq$(element:name) $(attr:rxrate:packets)\en\(aq\fP
+.RE
+.PP
.SH "FILES"
/etc/bmon.conf