Missing docs enumerating options

[nikolaik]

Tell us more about this new feature.

Would love to see the output of mount-s3 --help in doc/CONFIGURATION.md. Keeping it up to date could also be automated

[arsh]

Thanks for reporting this @nikolaik. Do you mean a verbatim copy of the output from mount-s3 --help with no further explanation? If that is the case, I'm not sure if it'll add value. The CONFIGURATION.md goes into more details that can be explained via the --help option. It also has a narrative style tying everything together.

[nikolaik]

Thanks for reporting this @nikolaik. Do you mean a verbatim copy of the output from mount-s3 --help with no further explanation? If that is the case, I'm not sure if it'll add value. The CONFIGURATION.md goes into more details that can be explained via the --help option. It also has a narrative style tying everything together.

@arsh Thanks for the quick response. I meant a verbatim copy of the output from mount-s3 --help or a concise list of options, description/behaviour and defaults. I think this is recognisable for people consuming CLIs in general, as it gives a quick overview of the available options with default values. It could help save some time for those familiarising themselves with the options available, without having to read too much prose. The benefit lies in knowing exactly which options are available, not having to worry if missing an option hidden in the extensive prose form docs.

[jamesbornholt]

I like the idea of a short TL;DR at the top of that doc. Maybe beyond just showing the --help output, we could also briefly call out some of the most common options folks are likely to want (--allow-delete, --allow-overwrite, --cache, a couple others).