HelpMessageOpt

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

Synopsis

Declared in <common/args.h>

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

NameDescription
optionOption name (e.g. "-rpcuser")
help_paramHelp parameter (e.g. "=<user>" or "")
messageOption description (e.g. "Username for JSON-RPC connections")
suboptTrue if this is a suboption, instead of a top-level option.