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

     1  # `murex-docs`
     2  
     3  > Displays the man pages for Murex builtins
     4  
     5  ## Description
     6  
     7  Displays the man pages for Murex builtins.
     8  
     9  ## Usage
    10  
    11  ```
    12  murex-docs [ flag ] command -> <stdout>
    13  ```
    14  
    15  ## Examples
    16  
    17  ```
    18  # Output this man page
    19  murex-docs murex-docs
    20  ```
    21  
    22  ## Flags
    23  
    24  * `--docs`
    25      Returns a JSON object of every document available to read offline
    26  * `--summary`
    27      Returns an abridged description of the command rather than the entire help page
    28  
    29  ## Detail
    30  
    31  These man pages are compiled into the Murex executable.
    32  
    33  ## Synonyms
    34  
    35  * `murex-docs`
    36  * `help`
    37  
    38  
    39  ## See Also
    40  
    41  * [`(brace quote)`](../parser/brace-quote-func.md):
    42    Write a string to the STDOUT without new line (deprecated)
    43  * [`>>` Append File](../parser/greater-than-greater-than.md):
    44    Writes STDIN to disk - appending contents if file already exists
    45  * [`cast`](../commands/cast.md):
    46    Alters the data type of the previous function without altering it's output
    47  * [`err`](../commands/err.md):
    48    Print a line to the STDERR
    49  * [`man-get-flags` ](../commands/man-get-flags.md):
    50    Parses man page files for command line flags 
    51  * [`out`](../commands/out.md):
    52    Print a string to the STDOUT with a trailing new line character
    53  * [`tout`](../commands/tout.md):
    54    Print a string to the STDOUT and set it's data-type
    55  * [`tread`](../commands/tread.md):
    56    `read` a line of input from the user and store as a user defined *typed* variable (deprecated)
    57  * [`|>` Truncate File](../parser/greater-than.md):
    58    Writes STDIN to disk - overwriting contents if file already exists
    59  
    60  <hr/>
    61  
    62  This document was generated from [builtins/docs/docs_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/docs/docs_doc.yaml).