qrtool-encode(1)
NAME
qrtool-encode - encode input data in a QR code
DESCRIPTION
This command encodes input data in a QR code. By default, the result will be output to stdout.
qrtool enc and qrtool e are aliases for this command.
POSITIONAL ARGUMENTS
- STRING
Input data. If STRING is not specified, data will be read from stdin. STRING must be a valid UTF-8 string. Use --read-from or read from stdin if taking other than a valid UTF-8 string. This positional argument conflicts with --read-from.
OPTIONS
- -o, --output FILE
Output the result to a file.
- -r, --read-from FILE
Read input data from a file. This option conflicts with STRING.
- -s, --size NUMBER
The module size in pixels. If this option is not specified, the module size is 8 when the output format is PNG or SVG, and 1 when the output format is UTF-8 string.
- -l, --error-correction-level LEVEL
Error correction level.
- The possible values are:
- l
Level L. 7% of codewords can be restored.
- m
Level M. 15% of codewords can be restored. This is the default value.
- q
Level Q. 25% of codewords can be restored.
- h
Level H. 30% of codewords can be restored.
- --level LEVEL
Alias for -l, --error-correction-level.
- -v, --symbol-version NUMBER
The version of the symbol. If this option is not specified, the minimum version required to store the data will be automatically chosen. For normal QR code, NUMBER should be between 1 and 40. For Micro QR code, NUMBER should be between 1 and 4.
- --symversion NUMBER
Alias for -v, --symbol-version.
- -m, --margin NUMBER
The width of margin. If this option is not specified, the margin will be 4 for normal QR code and 2 for Micro QR code.
- -t, --type FORMAT
The format of the output.
- The possible values are:
- png
Portable Network Graphics. This outputs 32-bit RGBA PNG image. This is the default value.
- svg
Scalable Vector Graphics.
- terminal
To the terminal as UTF-8 string.
- --mode MODE
The mode of the output. If this option is not specified, use the optimal encoding. This option requires --symbol-version.
- The possible values are:
- numeric
All digits.
- alphanumeric
Alphanumerics and few symbols.
- byte
Arbitrary binary data.
- kanji
Shift JIS text.
- --variant TYPE
The type of QR code. This option requires --symbol-version.
- The possible values are:
- normal
Normal QR code. This is the default value.
- micro
Micro QR code.
- --foreground COLOR
Foreground color. COLOR takes a CSS color string. Colored output is only available when the output format is PNG or SVG. Default is black.
- --background COLOR
Background color. COLOR takes a CSS color string. Colored output is only available when the output format is PNG or SVG. Default is white.
- --verbose
Also print the metadata. It is output to stderr.
- -h, --help
Print help message. The short flag (-h) will print a condensed help message while the long flag (--help) will print a detailed help message.
- -V, --version
Print version number. The long flag (--version) will also print the copyright notice, the license notice and where to report bugs.
EXIT STATUS
- 0
Successful program execution.
- 1
An error occurred.
- 2
An error occurred while parsing command-line arguments.
- 65
The input data was incorrect in some way.
- 66
An input file did not exist or was not readable.
- 69
A service is unavailable.
- 71
An operating system error has been detected.
- 74
An error occurred while doing I/O on some file.
- 77
You did not have sufficient permission to perform the operation.
EXAMPLES
- Encode the given string in a QR code:
$ qrtool encode "QR code" > output.png
- Encode the given file and output to the specified image:
$ qrtool encode -o output.png -r go.mod
- Encode to a SVG image:
$ qrtool encode -t svg "QR code" > output.svg
- Encode to a Micro QR code:
$ qrtool encode -v 3 --variant micro "QR code" > output.png
- Encode with the specified colors:
$ qrtool encode -o output.png --foreground brown --background lightslategray "QR code"
COPYRIGHT
Copyright © 2022-2024 Shun Sakai
This program is distributed under the terms of either the Apache License 2.0 or the MIT License.
This manual page is distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.