[#HelpMessageOpt]
= HelpMessageOpt
:mrdocs:

Format a string to be used as option description in help messages

== Synopsis

Declared in `<common/args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
HelpMessageOpt(
    std::string_view option,
    std::string_view help_param,
    std::string_view message,
    bool subopt = false);
----

== Return Value

the formatted string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *option*
| Option name (e.g. "‐rpcuser")
| *help_param*
| Help parameter (e.g. "=<user>" or "")
| *message*
| Option description (e.g. "Username for JSON‐RPC connections")
| *subopt*
| True if this is a suboption, instead of a top‐level option.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#