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 is rebuilt weekly, the content is automatically generated from murex's source code. Downloadable murex binaries are also built weekly.
  • Last built on Mon May 10 00:24:28 UTC 2021 against commit d988dd7d988dd786172aac33e9c7592e988c1c3c468deb6.
  • Current version is 2.1.4000 BETA which has been verified against 14514 tests.