murex rocks

Welcome

About

Install

Blog

Technical Docs

User Guide

Quick Start

Syntax

Commands

Types

Open Source

Go APIs

GitHub repo

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

• summary
• !summary

See Also

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