bmon
bmon copied to clipboard
missing documentation for some configuration options (bmonrc)
Hello,
bmon is really great and I've been using it to periodically check out the status of a couple of production linux routers for my previous job. so thanks for this tool :)
However, I've been having issues finding out how to configure certain options in the bmonrc file.
The project comes with an example configuration file which has a handful of lines at the top in a comment which show some of the options that can be set, and then the rest of the file seems to define some detailed configuration for the output formatting but the syntax and and the semantics of the values are not explained.
in the example lines at the top of the example config file, there are a couple of options that are missing. those options are also not named in the man page. for example I just found out by reading the code that use_bit
can be set in bmonrc in order to make -b
the default (which makes more sense to me).
I can help out with a pull request but I was wondering what approach(es) would be more acceptable to you:
- creating a man page for bmonrc, detailing the options and their meaning
- adding mentions of configuration option names in the current bmon(8) man page
- adding a line for all possible options in the example configuration filea
I personally think that a mixture of the first and last options would be best.
Cheers!