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 Sep 20 07:48:14 UTC 2022 against commit 1769d5b1769d5bb0ba4eaf204a5e0f52053b8f877bb7466.

Current version is 2.11.2030 which has been verified against 16798 tests cases.