From 5b938e05c74ef0f6c162b1899b517440297996d6 Mon Sep 17 00:00:00 2001 From: Adam Drescher Date: Fri, 7 Oct 2016 11:37:13 -0500 Subject: [PATCH] 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. --- man/bmon.8 | 8 ++++++++ 1 file changed, 8 insertions(+) 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