Feature request: document config file

[grodin]

This is a pretty minor thing really, but it would definitely by a "nice-to-have". I haven't found any documentation of the config file entries, so either they could be easier to find, or they could be better documented.

Additionally, I think it's nice when a CLI tool can tell you where it's config file is (maybe in --help?).

I'm happy to help with either or both of these requests when I have a chance (moving house in a few weeks).

[Anomalocaridid]

This is a pretty minor thing really, but it would definitely by a "nice-to-have". I haven't found any documentation of the config file entries, so either they could be easier to find, or they could be better documented.

README.md should have all the config file options documented in various spots, although now that you mention it, the config file should probably also have dedicated documentation to make things clearer.

Ideally there would also be some way to generate a manpage from the config file struct, like what is currently done with the command-line options, but I cannot find anything to do that.

Next best thing might be just writing documentation as markdown and using something like the mandown crate to generate it at build time.

Additionally, I think it's nice when a CLI tool can tell you where it's config file is (maybe in --help?).

That can probably just be trivially done by adding the config file path to the documentation comments for the command-line arguments struct.

I'm happy to help with either or both of these requests when I have a change (moving house in a few weeks).

By all means. No pressure, though.

[leiserfg]

Another option is to use https://crates.io/crates/clap_mangen

[Anomalocaridid]

That's just for generating man pages for cli arguments. In fact, handlr-regex already uses it for that.

Using that for the config file might be possible, but it would require significantly manually tweaking the man page to format it for a config file rather than for a program with command line arguments.