Skip to main content


Laurence MorganLess than 1 minute


Defines a summary help text for a command


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.


Define a commands summary

summary command description

Undefine a summary

!summary command


Define a commands summary

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

Undefine a summary

» !summary foobar


  • summary
  • !summary

See Also

  • bexists: Check which builtins exist
  • builtins: Returns runtime information on the internal state of Murex
  • config: Query or define Murex runtime settings
  • exec: Runs an executable
  • fid-list: Lists all running functions within the current Murex session
  • murex-docs: Displays the man pages for Murex builtins
  • murex-update-exe-list: Forces Murex to rescan $PATH looking for executables
  • runtime: Returns runtime information on the internal state of Murex

This document was generated from builtins/core/management/shell_doc.yamlopen in new window.

Last update:
Contributors: Laurence Morgan,Laurence Morgan