Skip to main content

Module help

Module help 

Source

Constants§

CACHES_CLEAR_EXAMPLES
CACHES_CLEAR_LONG
CACHES_CONTAINERS_EXAMPLES
CACHES_CONTAINERS_LONG
CACHES_DOCKER_LONG
CACHES_EXAMPLES
CACHES_LONG
COMMAND_GROUPS
How the commands are grouped, and the one line each gets — on the manual’s contents page (devp man) and in the categorised devp --help alike.
COMPLETIONS_EXAMPLES
COMPLETIONS_LONG
CONFIG_DAEMON_EXAMPLES
CONFIG_DAEMON_LONG
CONFIG_EXAMPLES
CONFIG_GET_EXAMPLES
CONFIG_GET_LONG
CONFIG_HOOK_EXAMPLES
CONFIG_HOOK_LONG
CONFIG_ICON_EXAMPLES
CONFIG_ICON_LONG
CONFIG_LONG
CONFIG_PROJECT_EXAMPLES
CONFIG_PROJECT_LONG
CONFIG_RECOMMENDED_EXAMPLES
CONFIG_RECOMMENDED_LONG
CONFIG_SET_EXAMPLES
CONFIG_SET_LONG
CONFIG_SHOW_EXAMPLES
CONFIG_SHOW_LONG
CONFIG_WIZARD_EXAMPLES
CONFIG_WIZARD_LONG
DOCTOR_EXAMPLES
DOCTOR_LONG
HELP_STYLES
The palette the help is rendered in. Set once on the top-level command and propagated by clap to every subcommand, so devp run --help matches the front page. clap drops the colour when stdout is not a terminal, the same way colored does for the hand-built block below.
HIDDEN_FROM_HELP
Commands that still run but no longer appear in devp --help.
HISTORY_EXAMPLES
HISTORY_LONG
INIT_EXAMPLES
INIT_LONG
INSTALL_EXAMPLES
INSTALL_LONG
LINK_EXAMPLES
LINK_LONG
MAN_EXAMPLES
MAN_LONG
RESTORE_EXAMPLES
RESTORE_LONG
RUN_EXAMPLES
RUN_LONG
SETUP_EXAMPLES
SETUP_LONG
SKILL_EXAMPLES
SKILL_LONG
STATS_EXAMPLES
STATS_LONG
STATUS_EXAMPLES
STATUS_LONG
TRUST_EXAMPLES
TRUST_LONG
UNDO_EXAMPLES
UNDO_LONG
UNINSTALL_EXAMPLES
UNINSTALL_LONG
UNLINK_EXAMPLES
UNLINK_LONG
UPDATE_EXAMPLES
UPDATE_LONG

Statics§

ROOT_AFTER_HELP
The examples block under the help. Built at runtime for the same reason the template is: the headings carry colour.
ROOT_HELP_TEMPLATE
The top-level help template: clap’s default, with the flat twenty-command list swapped for the grouped block above. Only the top level gets it — a subcommand’s own list is short enough not to need grouping. The section headings are literal text here, coloured to match HELP_STYLES, because clap’s {options} tag renders the entries without one.