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

     1  # `qr`
     2  
     3  > Creates a QR code from STDIN
     4  
     5  ## Description
     6  
     7  `qr` is an optional builtin which generates a PNG format image based on the
     8  input from STDIN. `qr` must be run as a method.
     9  
    10  ## Usage
    11  
    12  ```
    13  <stdin> -> qr -> <stdout>
    14  ```
    15  
    16  ## Examples
    17  
    18  Write the PNG to disk
    19  
    20  ```
    21  » out "Hello, World!" -> qr -> > qr.png
    22  ```
    23  
    24  Display PNG in the terminal
    25  
    26  ```
    27  » out "Hello, World!" -> qr -> open-image
    28  ```
    29  
    30  ## Detail
    31  
    32  `qr` sets stdout's data-type to be "image", which is defined in with the
    33  `open-image` optional builtin. So if you have that disabled then you may
    34  have to `cast` the output in some circumstances.
    35  
    36  ## See Also
    37  
    38  * [`cast`](../commands/cast.md):
    39    Alters the data type of the previous function without altering it's output
    40  * [`open-image`](../commands/open-image.md):
    41    Renders bitmap image data on your terminal
    42  
    43  <hr/>
    44  
    45  This document was generated from [builtins/optional/qr/qr_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/optional/qr/qr_doc.yaml).