WKHTMLTOPDF(1)

πŸ“¦
version 0.12.6 Β· 2 versions
, in debian bookworm, fedora 43, fedora 44, ubuntu jammy, ubuntu noble

🌸 WKHTMLTOPDF(1) β€” General Commands Manual πŸŽ€

okay bestie, welcome to the manual page for WKHTMLTOPDF (section 1 of the General Commands Manual β€” that's the big girl section, general commands only πŸ’…). and yeah, the header says WKHTMLTOPDF but the tool we're actually talking about inside is wkhtmltoimage β€” that's just how this page is titled, we don't make the rules, we just screenshot them ✨

πŸ’– Name

wkhtmltoimage β€” html to image converter

like, it converts html. to an image. the name is literally doing the work for you 🫢

✨ Synopsis

wkhtmltoimage [OPTIONS]... <input file> <output file>

options first, then the thing you're feeding in, then where the picture goes. that's the whole shape of it. slay πŸ’…

πŸ¦‹ Description

Converts an HTML page into an image,

(yes, with the comma, we're keeping it, it's iconic, it's giving "trailing comma as a personality trait" 😭)

πŸ‘‘ General Options

  • --allow <path> β€” Allow the file or files from the specified folder to be loaded (repeatable)
  • --bypass-proxy-for <value> β€” Bypass proxy for host (repeatable)
  • --cache-dir <path> β€” Web cache directory
  • --checkbox-checked-svg <path> β€” Use this SVG file when rendering checked checkboxes
  • --checkbox-svg <path> β€” Use this SVG file when rendering unchecked checkboxes
  • --cookie <name> <value> β€” Set an additional cookie (repeatable), value should be url encoded.
  • --cookie-jar <path> β€” Read and write cookies from and to the supplied cookie jar file
  • --crop-h <int> β€” Set height for cropping
  • --crop-w <int> β€” Set width for cropping
  • --crop-x <int> β€” Set x coordinate for cropping
  • --crop-y <int> β€” Set y coordinate for cropping
  • --custom-header <name> <value> β€” Set an additional HTTP header (repeatable)
  • --custom-header-propagation β€” Add HTTP headers specified by --custom-header for each resource request.
  • --no-custom-header-propagation β€” Do not add HTTP headers specified by --custom-header for each resource request.
  • --debug-javascript β€” Show javascript debugging output
  • --no-debug-javascript β€” Do not show javascript debugging output
  • --encoding <encoding> β€” Set the default text encoding, for input
  • -H, --extended-help β€” Display more extensive help, detailing less common command switches
  • -f, --format <format> β€” Output file format
  • --height <int> β€” Set screen height (default is calculated from page content)
  • -h, --help β€” Display help
  • --htmldoc β€” Output program html help
  • --images β€” Do load or print images
  • --no-images β€” Do not load or print images
  • -n, --disable-javascript β€” Do not allow web pages to run javascript
  • --enable-javascript β€” Do allow web pages to run javascript
  • --javascript-delay <msec> β€” Wait some milliseconds for javascript finish
  • --license β€” Output license information and exit
  • --load-error-handling <handler> β€” Specify how to handle pages that fail to load: abort, ignore or skip
  • --load-media-error-handling <handler> β€” Specify how to handle media files that fail to load: abort, ignore or skip
  • --disable-local-file-access β€” Do not allowed conversion of a local file to read in other local files, unless explicitly allowed with --allow
  • --enable-local-file-access β€” Allowed conversion of a local file to read in other local files.
  • --log-level <level> β€” Set log level to: none, error, warn or info
  • --manpage β€” Output program man page
  • --minimum-font-size <int> β€” Minimum font size
  • --password <password> β€” HTTP Authentication password
  • --disable-plugins β€” Disable installed plugins
  • --enable-plugins β€” Enable installed plugins (plugins will likely not work)
  • --post <name> <value> β€” Add an additional post field (repeatable)
  • --post-file <name> <path> β€” Post an additional file (repeatable)
  • -p, --proxy <proxy> β€” Use a proxy
  • --proxy-hostname-lookup β€” Use the proxy for resolving hostnames
  • --quality <int> β€” Output image quality (between 0 and 100)
  • -q, --quiet β€” Be less verbose, maintained for backwards compatibility; Same as using --log-level none
  • --radiobutton-checked-svg <path> β€” Use this SVG file when rendering checked radiobuttons
  • --radiobutton-svg <path> β€” Use this SVG file when rendering unchecked radiobuttons
  • --readme β€” Output program readme
  • --run-script <js> β€” Run this additional javascript after the page is done loading (repeatable)
  • --ssl-crt-path <path> β€” Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs
  • --ssl-key-password <password> β€” Password to ssl client cert private key
  • --ssl-key-path <path> β€” Path to ssl client cert private key in OpenSSL PEM format
  • --stop-slow-scripts β€” Stop slow running javascripts
  • --no-stop-slow-scripts β€” Do not Stop slow running javascripts
  • --user-style-sheet <path> β€” Specify a user style sheet, to load with every page
  • --username <username> β€” HTTP Authentication username
  • -V, --version β€” Output version information and exit
  • --width <int> β€” Set screen width, note that this is used only as a guide line. Use --disable-smart-width to make it strict.
  • --window-status <windowStatus> β€” Wait until window.status is equal to this string before rendering page
  • --zoom <float> β€” Use this zoom factor
🫢 friendly reminder that the repeatable ones are genuinely repeatable β€” you can stack them, that's the whole point, go off.

🧚 Contact

If you experience bugs or want to request new features please visit https://wkhtmltopdf.org/support.html

bugs? feature ideas? that's the spot. take it there, bestie πŸ’œ

🌈 Authors

look at this roster. this is a whole ensemble cast. main character energy from every single one of them πŸ‘‘

  • Jakob Truelsen <antialize@gmail.com>
  • Ashish Kulkarni <ashish@kulkarni.dev>
  • Jan Habermann <jan@habermann24.com>
  • Pablo Ruiz GarcΓ­a <pablo.ruiz@gmail.com>
  • Trevor North <trevor@blubolt.com>
  • Nate Pinchot <nate.pinchot@gmail.com>
  • pussbb <pussbb@gmail.com>
  • Aaron Stone <aaron@serendipity.cx>
  • Patrick Widauer @a-ctor
  • Peter van der Tak <pta@ibuildgreen.eu>
  • Benjamin Sinkula <bsinky@gmail.com>
  • Kasper F. Brandt <poizan@poizan.dk>
  • Michael Nitze <michael.nitze@online.de>
  • Rok Dvojmoc <rok.dvojmoc@gmail.com>
  • theirix <theirix@gmail.com>
  • Tomsgu <tomasjakll@gmail.com>
  • Artem Butusov <art.sormy@gmail.com>
  • Christian Sciberras <uuf6429@gmail.com>
  • Daniel M. Lambea <dmlambea@gmail.com>
  • Douglas Bagnall <douglas@paradise.net.nz>
  • peterrehm <peter.rehm@renvest.de>
  • Renan GonΓ§alves <renan.saddam@gmail.com>
  • Ruslan Grabovoy <kudgo.test@gmail.com>
  • Sander Kleykens <sander.kleykens@avnu.be>
  • Adam Thorsen <adam.thorsen@gmail.com>
  • Albin Kerouanton <albin.kerouanton@knplabs.com>
  • Alejandro Dubrovsky <alito@organicrobot.com>
  • Arthur Cinader @acinader
  • Benoit Garret <benoit.garret@gmail.com>
  • Bill Kuker <bkuker@billkuker.com>
  • cptjazz <alexander@jesner.eu>
  • daigot <daigot@rayze.com>
  • Destan Sarpkaya @destan
  • Duncan Smart <duncan.smart@gmail.com>
  • Emil Lerch <emil@lerch.org>
  • Erik Hyrkas <erik.hyrkas@thomsonreuters.com>
  • Erling Linde <erlingwl@gmail.com>
  • FΓ‘bio C. Barrionuevo da Luz <bnafta@gmail.com>
  • Fr33m1nd <lukion@gmx.de>
  • Frank Groeneveld <frank@frankgroeneveld.nl>
  • Immanuel HΓ€ussermann <haeussermann@gmail.com>
  • Jake Petroules <jake.petroules@petroules.com>
  • James Macdonald <james@kingfisher-systems.co.uk>
  • Jason Smith <JasonParallel@gmail.com>
  • John Muccigrosso @Jmuccigr
  • Julien Le Goff <julego@gmail.com>
  • Kay Lukas <kay.lukas@gmail.com>
  • Kurt Revis <krevis@snoize.com>
  • laura @holamon
  • Marc Laporte <marc@laporte.name>
  • Matthew M. Boedicker <matthewm@boedicker.org>
  • Matthieu Bontemps <matthieu.bontemps@gmail.com>
  • Max Sikstrom <max.sikstrom@op5.com>
  • Nolan Neustaeter <github@noolan.ca>
  • Oleg Kostyuk <cub.uanic@gmail.com>
  • Pankaj Jangid <pankaj.jangid@gmail.com>
  • robinbetts <robinbetts@yahoo.com>
  • Sem <spam@esemi.ru>
  • Stefan Weil <sw@weilnetz.de>
  • Stephen Kennedy <sk4425@gmail.com>
  • Steve Shreeve <steve.shreeve@gmail.com>
  • Sven Nierlein <sven@nierlein.org>
  • Tobin Juday <tobinibot@gmail.com>
  • Todd Fisher <todd.fisher@gmail.com>
  • ΠšΠΎΡΡ‚Π°Π΄ΠΈΠ½ Дамянов <maxmight@gmail.com>
  • Emmanuel Bouthenot <kolter@openics.org>
  • Rami @icnocop
  • Khodeir-hubdoc @Khodeir-hubdoc
  • Jonathan Jefferies @jjok
  • Joe Ayers <joseph.ayers@crunchydata.com>
  • Jeffrey Cafferata <jeffrey@jcid.nl>
  • rainabba
  • Mehdi Abbad
  • Lyes Amazouz
  • Pascal Bach
  • MΓ‘rio Silva

and that's the whole page, bestie!! πŸŽ€ this one's dated 2009 February 23, it lives in the General Commands Manual as WKHTMLTOPDF(1), and every single one of those beautiful people above made it happen. go forth and convert html into an image, you absolute icon πŸŒΈβœ¨πŸ’…

πŸ“¦ where this page comes from