Set Command Summary Hint (summary)

Defines a summary help text for a command

Description

summary define help text for a command. This is effectively like a tooltip message that appears, by default, in blue in the interactive shell.

Normally this text is populated from the man pages or murex-docs, however if neither exist or if you wish to override their text, then you can use summary to define that text.

Usage

Define a commands summary

summary command description

Undefine a summary

!summary command

Examples

Define a commands summary

» summary foobar "Hello, world!"
» runtime --summaries -> [ foobar ]
Hello, world! 

Undefine a summary

» !summary foobar

Synonyms

See Also


This document was generated from builtins/core/management/shell_doc.yaml.

This site's content is rebuilt automatically from murex's source code after each merge to the master branch. Downloadable murex binaries are also built with the website.

Last built on Wed Jan 15 23:07:50 UTC 2025 against commit b4c4296b4c429617fd41527ea0efef33c52c15ef2b64972.

Current version is 6.4.2063 (develop) which has been verified against tests cases.