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

     1  # Optional Builtins Reference
     2  
     3  This section is a glossary of Murex optional builtins.
     4  
     5  These builtins likely wont be compiled with Murex unless you specifically
     6  request them to be. This might be because they duplicate functionality
     7  already available on POSIX systems or introduce more complex dependencies.
     8  It might also be because that specific builtin is in an alpha stage and thus
     9  not ready to ship with Murex.
    10  
    11  ## Other Reference Material
    12  
    13  ### Language Guides
    14  
    15  1. [Core Builtins](/docs/commands/), for docs
    16      on the core builtins.
    17  
    18  2. [Language Tour](/docs/tour.md), which is an introduction into
    19      the Murex language.
    20  
    21  3. [Rosetta Stone](/docs/user-guide/rosetta-stone.md), which is a reference
    22      table comparing Bash syntax to Murex's.
    23  
    24  ### Murex's Source Code
    25  
    26  The source for each of these builtins can be found on [Github](https://github.com/lmorg/murex/tree/master/builtins/optional).
    27  
    28  ### Shell Commands For Querying Builtins
    29  
    30  From the shell itself: run `builtins` to list the builtin command.
    31  
    32  If you require a manual on any of those commands, you can run `murex-docs`
    33  to return the same markdown-formatted document as those listed below. eg
    34  
    35  ```
    36  murex-docs trypipe
    37  ```
    38  
    39  ## Pages
    40  
    41  * [`!bz2`](../optional/bz2.md):
    42    Decompress a bz2 file
    43  * [`base64` ](../optional/base64.md):
    44    Encode or decode a base64 string
    45  * [`gz`](../optional/gz.md):
    46    Compress or decompress a gzip file
    47  * [`qr`](../optional/qr.md):
    48    Creates a QR code from STDIN
    49  * [`select`](../optional/select.md):
    50    Inlining SQL into shell pipelines
    51  * [`sleep`](../optional/sleep.md):
    52    Suspends the shell for a number of seconds