murex Shell Docs

Command Reference: 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 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 Tue Jan 31 12:58:18 UTC 2023 against commit c6bc4d8c6bc4d8f96c958dcb16d78e66d89468aef288078.

Current version is which has been verified against 13941 tests cases.