m17n-dump(1)

📦
version 1.8.4 · 2 versions
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 m17n-dump — dump text image ✨

okay bestie, gather round, because m17n-dump from the m17n Library is about to eat 💅 it takes your text and turns it into a straight-up PNG glow-up. no cap.

✨ SYNOPSIS ✨

m17n-dump [ OPTION ... ] [ FILE ]

💖 DESCRIPTION 💖

So the whole vibe is: you dump a text as a PNG image file. that's it. that's the job. iconic.

The PNG file gets written to a file created in the current directory, and its name is BASE.png — where BASE is the basename of FILE. 🎀

If FILE is omitted? no stress. text is read from standard input, and the image gets dumped into the file output.png.

The following OPTIONs are available. yes, all of them. we're not skipping a single one, bestie. 🫶

  • -s SIZE — SIZE is the font size in point. the default font size is 12 point. tiny but cute.
  • -d DPI — DPI is the resolution in dots per inch. the default resolution is 300 dpi. crisp ✨
  • -p PAPER — PAPER is the paper size, and your options are: a4, a4r, a5, a5r, b5, b5r, letter, WxH, or W. for WxH, W and H are the width and height in millimeter. for W, W is the width in millimeter. if this option is specified, PAPER limits the image size. and if FILE is too large for a single page, multiple files with the names BASE.01.png, BASE.02.png, etc. are created. multipage slay 🦋
  • -m MARGIN — MARGIN is the horizontal and vertical margin in millimeter. the default margin is 20 mm. it is ignored when PAPER is not specified. lowkey a package deal, they come together 💀
  • -c POS — POS is the character position of cursor to draw. by default, cursor is not drawn. 🙈
  • -x — FILE is assumed to be an XML file generated by the serialize facility of the m17n library, and FILE is deserialized before an image is created. fancy 💅
  • -w — each line is broken at word boundary.
  • -f FILTER — FILTER is a string containing a shell command line. if this option is specified, the PNG image is not written into a file but is given to FILTER as standard input. if FILTER contains %s, that part is replaced by a basename of FILE. so, the default behaviour is the same as specifying cat > %s.png as FILTER.

and if FILTER is just -, the PNG image is written to stdout. periodt. 👑

  • -a — enable anti-alias drawing. smooth like butter 🧈✨
  • --family FAMILY — prefer a font whose family name is FAMILY.
  • --language LANG — prefer a font specified for the language LANG. LANG must be a 2-letter code of ISO 630 (e.g. en for English). iykyk 🌈
  • -fg FOREGROUND — specify the text color. the supported color names are those of HTML 4.0 and #RRGGBB notation.
  • -bg BACKGROUND — specify the background color. the supported color names are the same as FOREGROUND, except that if transparent is specified, make the background transparent. see-through moment 🫧
  • -r — specify that the orientation of the text is right-to-left.
  • -q — quiet mode. don't print any messages. 🤫
  • --version — print the version number.
  • -h, --help — print this message.
ngl bestie, some of these options interact in ways that matter — like -m doing literally nothing unless you also passed -p, and -f completely changing where your PNG ends up (file? pipe? stdout?). read twice, dump once. 💖

Copyright (C) 2001 Information-technology Promotion Agency (IPA)

Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.

and that's the whole page, bestie 🎀 Version 1.8.4, dated Mon Sep 25 2023 — m17n-dump(1), out. go dump something gorgeous ✨💜

📦 where this page comes from