QRENCODE(1)

🌸 QRENCODE(1) 🌸

okay bestie, welcome to the General Commands Manual page for qrencode, and trust me you're gonna want to sit down for this one because it's lowkey iconic 💅

✨ NAME ✨

qrencode — encode input data in a QR Code and save as a PNG or EPS image. that's it. that's the whole job. and she serves.

🦋 SYNOPSIS 🦋

qrencode [-o FILENAME] [OPTION]...  [STRING]

like, that's the vibe. short, sweet, slays.

💖 DESCRIPTION 💖

Libqrencode is a library for encoding data in a QR Code symbol, which is a kind of 2D symbology that can be scanned by handy terminals such as a mobile phone with CCD. not me explaining QR codes to you like you've never held a phone, but okay, we're being thorough 🫶

the capacity of QR Code is up to 7000 digits or 4000 characters, and it has high robustness. she's strong, she's resilient, she holds a lot of tea.

qrencode is a utility software using libqrencode to encode string data in a QR Code and save as a PNG or EPS image. so basically: you give her words, she gives you a scannable little square masterpiece. main character energy fr fr 👑

🎀 OPTIONS 🎀

here's the full menu, no skips, no cuts, we don't gatekeep here ✨

• -h, --help — display help message. the "hey bestie what do I do" button.
• -o FILENAME, --output=FILENAME — write image to FILENAME. if - is specified, the result will be output to standard output. and if -S is given, structured symbols are written to FILENAME-01.png, FILENAME-02.png, ... (suffix is removed from FILENAME, if specified). yes she numbers them, she's organized like that 💅
• -r FILENAME, --read-from=FILENAME — read input data from FILENAME. instead of typing it all out, you just point at a file. queen behavior.
• -s NUMBER, --size=NUMBER — specify the size of dot (pixel). (default=3). bigger number = chunkier square.
• -l {LMQH}, --level={LMQH} — specify error correction level from L (lowest) to H (highest). (default=L). higher = she can survive more damage, at the cost of capacity. glow-up with a price tag.
• -v NUMBER, --symversion=NUMBER — specify the minimum version of the symbol. See SYMBOL VERSIONS for more information. (default=auto). she'll pick for you unless you insist.
• -m NUMBER, --margin=NUMBER — specify the width of margin. (default=4). personal space! respect it!
• -d NUMBER, --dpi=NUMBER — specify the DPI of the generated PNG. (default=72).
• -t {PNG,PNG32,EPS,SVG,XPM,ANSI,ANSI256,ASCII,ASCIIi,UTF8,UTF8i,ANSIUTF8,ANSIUTF8i,ANSI256UTF8}, --type={PNG,PNG32,EPS,SVG,XPM,ANSI,ANSI256,ASCII,ASCIIi,UTF8,UTF8i,ANSIUTF8,ANSIUTF8i,ANSI256UTF8} — specify the type of the generated image. (default=PNG). look at all those options, she's versatile, she contains multitudes 🌈
• -S, --structured — make structured symbols. version number must be specified with -v. no version, no structured symbols, that's the rule, periodt.
• -k, --kanji — assume that the input text contains kanji (shift-jis).
• -c, --casesensitive — encode lower-case alphabet characters in 8-bit mode. (default). she's paying attention to your caps, respectfully.
• -i, --ignorecase — ignore case distinctions and use only upper-case characters. EVERYTHING GETS LOUD. 📢
• -8, --8bit — encode entire data in 8-bit mode. -k, -c and -i will be ignored. sorry girlies, they're getting benched.
• -M, --micro — encode in a Micro QR Code. See MICRO QR CODE for more information. smol but mighty 🧚
• --rle — enable run-length encoding for SVG.
• --svg-path — use single path to draw modules for SVG.
• --inline — only useful for SVG output, generates an SVG without the XML tag.
• --foreground=RRGGBB[AA], --background=RRGGBB[AA] — specify foreground/background color in hexadecimal notation. 6-digit (RGB) or 8-digit (RGBA) form are supported. color output support available only in PNG, EPS and SVG. so if you're out here trying to colorize your ANSI output... no. not happening. 🙈
• --strict-version — disable automatic version number adjustment. if the input data is too large for the specified version, the program exits with the code of 1. no rescuing you, no being nice about it, she just leaves.
• -V, --version — display the version number and copyrights of the qrencode.
• --verbose — display verbose information to stderr. she's telling you everything, in detail, whether you asked or not.
• [STRING] — input data. if it is not specified, data will be taken from standard input.

🔥 SYMBOL VERSIONS 🔥

the symbol versions of QR Code range from Version 1 to Version 40. each version has a different module configuration or number of modules, ranging from Version 1 (21 x 21 modules) up to Version 40 (177 x 177 modules). each higher version number comprises 4 additional modules per side by default. see http://www.qrcode.com/en/about/version.html for a detailed version list. iykyk 📐

🌸 MICRO QR CODE 🌸

with Micro QR Code, You can embed data in a smaller area than with QR Code, but the data capacity is strongly limited. the symbol versions range from Version 1 to 4. tiny. adorable. do not ask her to carry your whole novel though 😭

💜 EXAMPLES 💜

okay these are the moments, the little demos, the show-and-tell:

qrencode -l L -v 1 -o output.png 'Hello, world!'

encode into a symbol version 1, level L.

qrencode -iSv 1 --output=output.png

read standard input and encode it into a structured-appended symbols in case-insensitive mode.

qrencode -S -v 40 -l L -r bigfile.txt -o output.png

read input data from bigfile.txt and encode into a symbol version 40, level L.

look at her go. obsessed. 🌟

👑 AUTHOR 👑

written by Kentaro Fukuchi. legend, icon, the moment.

🌈 RESOURCES 🌈

• main Web Site: https://fukuchi.org/works/qrencode/
• source code repository: https://github.com/fukuchi/libqrencode/

🫶 COPYRIGHT 🫶

Copyright (C) 2006-2018 Kentaro Fukuchi.

bestie reminder: that's qrencode 4.1.1, from Aug. 28, 2020, and yeah she's still eating 💖 go make something scannable, you've got this ✨🎀🦋