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

     1  # `murex-parser` 
     2  
     3  > Runs the Murex parser against a block of code 
     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  ```
    17  <stdin> -> murex-parser -> <stdout>
    18  
    19  murex-parser { code-block } -> <stdout>
    20  ```
    21  
    22  ## Detail
    23  
    24  Please note this command is still very much in beta and is likely to change in incompatible ways in the future. If you do happen to like this command and/or have any suggestions on how to improve it, then please leave your feedback on the GitHub repository, https://github.com/lmorg/murex
    25  
    26  ## See Also
    27  
    28  * [`config`](../commands/config.md):
    29    Query or define Murex runtime settings
    30  * [`murex-docs`](../commands/murex-docs.md):
    31    Displays the man pages for Murex builtins
    32  * [`runtime`](../commands/runtime.md):
    33    Returns runtime information on the internal state of Murex
    34  
    35  <hr/>
    36  
    37  This document was generated from [builtins/core/management/shell_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/management/shell_doc.yaml).