rz_cmd_desc_help_t Struct Reference

#include <rz_cmd.h>

Public Attributes
const char *	summary
const char *	description
const char *	args_str
const char *	usage
const char *	options
bool	sort_subcommands
const RzCmdDescDetail *	details
RzCmdDescDetailCb	details_cb
const RzCmdDescArg *	args

Detailed Description

Define how the command looks like in the help.

Definition at line 282 of file rz_cmd.h.

Member Data Documentation

args

const RzCmdDescArg* rz_cmd_desc_help_t::args

Description of the arguments accepted by this command.

Definition at line 347 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__(), and cmd_descs_generate.CmdDesc::_validate().

args_str

const char* rz_cmd_desc_help_t::args_str

String used to identify the arguments. This usually comes together with the summary. TODO: explain how to differentiate between required and optional arguments

Definition at line 304 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__().

description

const char* rz_cmd_desc_help_t::description

Long description of what the command does. It can be as long as you want and it should explain well how the command behaves. This is shown, for example, when ?? is appended on a command. In that case, the short summary is extended with this longer description.

Optional.

Definition at line 298 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__(), and cmd_descs_generate.CmdDesc::str_tab().

details

const RzCmdDescDetail* rz_cmd_desc_help_t::details

NULL-terminated array of details sections used to better explain how to use the command. This is shown together with the long description.

Optional.

Definition at line 334 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__().

details_cb

RzCmdDescDetailCb rz_cmd_desc_help_t::details_cb

Function that returns an array of details sections used to better explain how to use the command. This is shown together with the long description and can be used in addition or in alternative of details , when the output needs to be generated dynamically.

Optional.

Definition at line 343 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__().

options

const char* rz_cmd_desc_help_t::options

String to use as sub-commands suggestions instead of the auto-generated one (e.g. [abcd] or [?] that you can see near command names when doing w?). If not provided, the options will be auto-generated.

Optional.

Definition at line 320 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__().

sort_subcommands

bool rz_cmd_desc_help_t::sort_subcommands

When true, the subcommands are automatically sorted alphabetically. By default subcommands are shown in the order provided by the developer.

Optional.

Definition at line 327 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__(), cmd_desc_set_parent(), and sort_groups().

summary

const char* rz_cmd_desc_help_t::summary

Short-sentence explaining what the command does. This is shown, for example, when the list of sub-commands is printed and each sub-command has a very short description on the right, explaining what it does.

Definition at line 289 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__(), cmd_foreach_cmdname_modes(), and cmd_descs_generate.CmdDesc::str_tab().

usage

const char* rz_cmd_desc_help_t::usage

String that overrides the name+args_str usually used to describe the command.

Optional.

Definition at line 311 of file rz_cmd.h.

Referenced by cmd_descs_generate.CmdDesc::__str__().

---

The documentation for this struct was generated from the following file:

• librz/include/rz_cmd.h