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

     1  # `escape`
     2  
     3  > Escape or unescape input
     4  
     5  ## Description
     6  
     7  `escape` takes input from either STDIN or the parameters and returns the same
     8  data, escaped.
     9  
    10  `!escape` does the same process in reverse, where it takes escaped data and
    11  returns its unescaped counterpart.
    12  
    13  ## Usage
    14  
    15  Escape
    16  
    17  ```
    18  <stdin> -> escape -> <stdout>
    19  
    20  escape string to escape -> <stdout>
    21  ```
    22  
    23  Unescape
    24  
    25  ```
    26  <stdin> -> !escape -> <stdout>
    27  
    28  !escape string to unescape -> <stdout>
    29  ```
    30  
    31  ## Examples
    32  
    33  Escape
    34  
    35  ```
    36  » out (multi
    37  » line
    38  » string) -> escape
    39  "multi\nline\nstring\n" 
    40  ```
    41  
    42  ## Synonyms
    43  
    44  * `escape`
    45  * `!escape`
    46  
    47  
    48  ## See Also
    49  
    50  * [`esccli`](../commands/esccli.md):
    51    Escapes an array so output is valid shell code
    52  * [`eschtml`](../commands/eschtml.md):
    53    Encode or decodes text for HTML
    54  * [`escurl`](../commands/escurl.md):
    55    Encode or decodes text for the URL
    56  
    57  <hr/>
    58  
    59  This document was generated from [builtins/core/escape/escape_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/escape/escape_doc.yaml).