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

     1  # `out`
     2  
     3  > Print a string to the STDOUT with a trailing new line character
     4  
     5  ## Description
     6  
     7  Write parameters to STDOUT with a trailing new line character.
     8  
     9  ## Usage
    10  
    11  ```
    12  out string to write -> <stdout>
    13  ```
    14  
    15  ## Examples
    16  
    17  ```
    18  » out Hello, World!
    19  Hello, World!
    20  ```
    21  
    22  For compatibility with other shells, `echo` is also supported:
    23  
    24  ```
    25  » echo Hello, World!
    26  Hello, World!
    27  ```
    28  
    29  ## Detail
    30  
    31  `out` / `echo` output as `string` data-type. This can be changed by casting
    32  (`cast`) or using the `tout` function.
    33  
    34  ### ANSI Constants
    35  
    36  `out` supports ANSI constants.
    37  
    38  ## Synonyms
    39  
    40  * `out`
    41  * `echo`
    42  
    43  
    44  ## See Also
    45  
    46  * [ANSI Constants](../user-guide/ansi.md):
    47    Infixed constants that return ANSI escape sequences
    48  * [`(brace quote)`](../parser/brace-quote-func.md):
    49    Write a string to the STDOUT without new line (deprecated)
    50  * [`>>` Append File](../parser/greater-than-greater-than.md):
    51    Writes STDIN to disk - appending contents if file already exists
    52  * [`cast`](../commands/cast.md):
    53    Alters the data type of the previous function without altering it's output
    54  * [`err`](../commands/err.md):
    55    Print a line to the STDERR
    56  * [`pt`](../commands/pt.md):
    57    Pipe telemetry. Writes data-types and bytes written
    58  * [`read`](../commands/read.md):
    59    `read` a line of input from the user and store as a variable
    60  * [`tout`](../commands/tout.md):
    61    Print a string to the STDOUT and set it's data-type
    62  * [`tread`](../commands/tread.md):
    63    `read` a line of input from the user and store as a user defined *typed* variable (deprecated)
    64  * [`|>` Truncate File](../parser/greater-than.md):
    65    Writes STDIN to disk - overwriting contents if file already exists
    66  
    67  <hr/>
    68  
    69  This document was generated from [builtins/core/io/echo_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/io/echo_doc.yaml).