DOKK / manpages / debian 12 / wkhtmltopdf / wkhtmltopdf.1.en
WKHTMLTOPDF(1) General Commands Manual WKHTMLTOPDF(1)

wkhtmltopdf - html to pdf converter


wkhtmltopdf [GLOBAL OPTION]... [OBJECT]... <output file>

wkhtmltopdf is able to put several objects into the output file, an object is either a single webpage, a cover webpage or a table of contents. The objects are put into the output document in the order they are specified on the command line, options can be specified on a per object basis or in the global options area. Options from the Global Options section can only be placed in the global options area.

A page objects puts the content of a single webpage into the output document.


(page)? <input url/file name> [PAGE OPTION]...

Options for the page object can be placed in the global options and the page options areas. The applicable options can be found in the Page Options and Headers And Footer Options sections.

A cover objects puts the content of a single webpage into the output document, the page does not appear in the table of contents, and does not have headers and footers.


cover <input url/file name> [PAGE OPTION]...

All options that can be specified for a page object can also be specified for a cover.

A table of contents object inserts a table of contents into the output document.


toc [TOC OPTION]...

All options that can be specified for a page object can also be specified for a toc, further more the options from the TOC Options section can also be applied. The table of contents is generated via XSLT which means that it can be styled to look however you want it to look. To get an idea of how to do this you can dump the default xslt document by supplying the --dump-default-toc-xsl, and the outline it works on by supplying --dump-outline, see the Outline Options section.

Converts one or more HTML pages into a PDF document, not using wkhtmltopdf patched qt.

Collate when printing multiple copies
Do not collate when printing multiple copies
Read and write cookies from and to the supplied cookie jar file
Number of copies to print into the pdf file
Change the dpi explicitly (this has no effect on X11 based systems)
Display more extensive help, detailing less common command switches
PDF will be generated in grayscale
Display help
Output program html help
Output license information and exit
Set log level to: none, error, warn or info
Generates lower quality pdf/ps. Useful to shrink the result document space
Output program man page
Set the page bottom margin
Set the page left margin
Set the page right margin
Set the page top margin
Set orientation to Landscape or Portrait
Page height
Set paper size to: A4, Letter, etc.
Page width
Be less verbose, maintained for backwards compatibility; Same as using --log-level none
Read command line arguments from stdin
Output program readme
The title of the generated pdf file (The title of the first document is used if not specified)
Output version information and exit

Allow the file or files from the specified folder to be loaded (repeatable)
Do print background
Do not print background
Bypass proxy for host (repeatable)
Web cache directory
Use this SVG file when rendering checked checkboxes
Use this SVG file when rendering unchecked checkboxes
Set an additional cookie (repeatable), value should be url encoded.
Set an additional HTTP header (repeatable)
Add HTTP headers specified by --custom-header for each resource request.
Do not add HTTP headers specified by --custom-header for each resource request.
Show javascript debugging output
Do not show javascript debugging output
Set the default text encoding, for input
Do load or print images
Do not load or print images
Do not allow web pages to run javascript
Do allow web pages to run javascript
Wait some milliseconds for javascript finish
Specify how to handle pages that fail to load: abort, ignore or skip
Specify how to handle media files that fail to load: abort, ignore or skip
Do not allowed conversion of a local file to read in other local files, unless explicitly allowed with --allow
Allowed conversion of a local file to read in other local files.
Minimum font size
Set the starting page number
HTTP Authentication password
Disable installed plugins
Enable installed plugins (plugins will likely not work)
Add an additional post field (repeatable)
Post an additional file (repeatable)
Use a proxy
Use the proxy for resolving hostnames
Use this SVG file when rendering checked radiobuttons
Use this SVG file when rendering unchecked radiobuttons
Run this additional javascript after the page is done loading (repeatable)
Path to the ssl client cert public key in OpenSSL PEM format, optionally followed by intermediate ca and trusted certs
Password to ssl client cert private key
Path to ssl client cert private key in OpenSSL PEM format
Stop slow running javascripts
Do not Stop slow running javascripts
Specify a user style sheet, to load with every page
HTTP Authentication username
Wait until window.status is equal to this string before rendering page
Use this zoom factor

By default proxy information will be read from the environment variables: proxy, all_proxy and http_proxy, proxy options can also by specified with the -p switch


<type> := "http://" | "socks5://"
<serif> := <username> (":" <password>)? "@"
<proxy> := "None" | <type>? <string>? <host> (":" <port>)?

Here are some examples (In case you are unfamiliar with the BNF):


http://user:password@myproxyserver:8080
socks5://myproxyserver
None

This version of wkhtmltopdf has been compiled against a version of QT without the wkhtmltopdf patches. Therefore some features are missing, if you need these features please use the static version.

Currently the list of features only supported with patch QT includes:


* Printing more than one HTML document into a PDF file.
* Running without an X11 server.
* Adding a document outline to the PDF file.
* Adding headers and footers to the PDF file.
* Generating a table of contents.
* Adding links in the generated PDF file.
* Printing using the screen media-type.
* Disabling the smart shrink feature of WebKit.

The default page size of the rendered document is A4, but by using the --page-size option this can be changed to almost anything else, such as: A3, Letter and Legal. For a full list of supported pages sizes please see <https://qt-project.org/doc/qt-4.8/qprinter.html#PaperSize-enum>.

For a more fine grained control over the page size the --page-height and --page-width options may be used

If you need to convert a lot of pages in a batch, and you feel that wkhtmltopdf is a bit too slow to start up, then you should try --read-args-from-stdin,

When --read-args-from-stdin each line of input sent to wkhtmltopdf on stdin will act as a separate invocation of wkhtmltopdf, with the arguments specified on the given line combined with the arguments given to wkhtmltopdf

For example one could do the following:


echo "https://qt-project.org/doc/qt-4.8/qapplication.html qapplication.pdf" >> cmds
echo "cover google.com https://en.wikipedia.org/wiki/Qt_(software) qt.pdf" >> cmds
wkhtmltopdf --read-args-from-stdin --book < cmds

The current page breaking algorithm of WebKit leaves much to be desired. Basically WebKit will render everything into one long page, and then cut it up into pages. This means that if you have two columns of text where one is vertically shifted by half a line. Then WebKit will cut a line into to pieces display the top half on one page. And the bottom half on another page. It will also break image in two and so on. If you are using the patched version of QT you can use the CSS page-break-inside property to remedy this somewhat. There is no easy solution to this problem, until this is solved try organizing your HTML documents such that it contains many lines on which pages can be cut cleanly.

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


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

2009 February 23