github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/commands/summary.md (about)

     1  # `summary` 
     2  
     3  > Defines a summary help text for a command
     4  
     5  ## Description
     6  
     7  `summary` define help text for a command. This is effectively like a tooltip
     8  message that appears, by default, in blue in the interactive shell.
     9  
    10  Normally this text is populated from the `man` pages or `murex-docs`, however
    11  if neither exist or if you wish to override their text, then you can use
    12  `summary` to define that text.
    13  
    14  ## Usage
    15  
    16  Define a commands summary
    17  
    18  ```
    19  summary command description
    20  ```
    21  
    22  Undefine a summary
    23  
    24  ```
    25  !summary command
    26  ```
    27  
    28  ## Examples
    29  
    30  Define a commands summary
    31  
    32  ```
    33  » summary foobar "Hello, world!"
    34  » runtime --summaries -> [ foobar ]
    35  Hello, world! 
    36  ```
    37  
    38  Undefine a summary
    39  
    40  ```
    41  » !summary foobar
    42  ```
    43  
    44  ## Synonyms
    45  
    46  * `summary`
    47  * `!summary`
    48  
    49  
    50  ## See Also
    51  
    52  * [`bexists`](../commands/bexists.md):
    53    Check which builtins exist
    54  * [`builtins`](../commands/runtime.md):
    55    Returns runtime information on the internal state of Murex
    56  * [`config`](../commands/config.md):
    57    Query or define Murex runtime settings
    58  * [`exec`](../commands/exec.md):
    59    Runs an executable
    60  * [`fid-list`](../commands/fid-list.md):
    61    Lists all running functions within the current Murex session
    62  * [`murex-docs`](../commands/murex-docs.md):
    63    Displays the man pages for Murex builtins
    64  * [`murex-update-exe-list`](../commands/murex-update-exe-list.md):
    65    Forces Murex to rescan $PATH looking for executables
    66  * [`runtime`](../commands/runtime.md):
    67    Returns runtime information on the internal state of Murex
    68  
    69  <hr/>
    70  
    71  This document was generated from [builtins/core/management/shell_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/management/shell_doc.yaml).