# phpman > man > WKHTMLTOPDF(1)
> **TLDR:** Convert HTML documents or web pages into PDF files.
>
- Convert a HTML document into PDF:
`wkhtmltopdf {{input.html}} {{output.pdf}}`
- Specify the PDF page size (please see `PaperSize` of `QPrinter` for supported sizes):
`wkhtmltopdf --page-size {{A4}} {{input.html}} {{output.pdf}}`
- Set the PDF page margins:
`wkhtmltopdf --margin-{{top|bottom|left|right}} {{10mm}} {{input.html}} {{output.pdf}}`
- Set the PDF page orientation:
`wkhtmltopdf --orientation {{Landscape|Portrait}} {{input.html}} {{output.pdf}}`
- Generate a greyscale version of the PDF document:
`wkhtmltopdf --grayscale {{input.html}} {{output.pdf}}`
*Source: tldr-pages*
---
[WKHTMLTOPDF(1)](https://www.chedong.com/phpMan.php/man/WKHTMLTOPDF/1/markdown) General Commands Manual [WKHTMLTOPDF(1)](https://www.chedong.com/phpMan.php/man/WKHTMLTOPDF/1/markdown)
## Name
wkhtmltopdf - html to pdf converter
## Synopsis
wkhtmltopdf [GLOBAL OPTION]... [OBJECT]...
### Document objects
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 docu‐
ment 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)? _
Read and write cookies from and to the supplied cookie jar file
**--copies** __
Number of copies to print into the pdf file
### -d, --dpi
Change the dpi explicitly (this has no effect on X11 based systems)
### -H, --extended-help
Display more extensive help, detailing less common command switches
### -g, --grayscale
PDF will be generated in grayscale
### -h, --help
Display help
**--htmldoc**
Output program html help
**--license**
Output license information and exit
**--log-level** __
Set log level to: none, error, warn or info
### -l, --lowquality
Generates lower quality pdf/ps. Useful to shrink the result document space
**--manpage**
Output program man page
### -B, --margin-bottom
Set the page bottom margin
### -L, --margin-left
Set the page left margin
### -R, --margin-right
Set the page right margin
### -T, --margin-top
Set the page top margin
### -O, --orientation
Set orientation to Landscape or Portrait
**--page-height** __
Page height
### -s, --page-size
Set paper size to: A4, Letter, etc.
**--page-width** __
Page width
### -q, --quiet
Be less verbose, maintained for backwards compatibility; Same as using --log-level
none
**--read-args-from-stdin**
Read command line arguments from stdin
**--readme**
Output program readme
**--title** __
The title of the generated pdf file (The title of the first document is used if not
specified)
### -V, --version
Output version information and exit
### Page Options
**--allow** __
Allow the file or files from the specified folder to be loaded (repeatable)
**--background**
Do print background
**--no-background**
Do not print background
**--bypass-proxy-for** __
Bypass proxy for host (repeatable)
**--cache-dir** __
Web cache directory
**--checkbox-checked-svg** __
Use this SVG file when rendering checked checkboxes
**--checkbox-svg** __
Use this SVG file when rendering unchecked checkboxes
**--cookie** __ __
Set an additional cookie (repeatable), value should be url encoded.
**--custom-header** __ __
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** __
Set the default text encoding, for input
**--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** __
Wait some milliseconds for javascript finish
**--load-error-handling** __
Specify how to handle pages that fail to load: abort, ignore or skip
**--load-media-error-handling** __
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 explic‐
itly allowed with --allow
**--enable-local-file-access**
Allowed conversion of a local file to read in other local files.
**--minimum-font-size** __
Minimum font size
**--page-offset** __
Set the starting page number
**--password** __
HTTP Authentication password
**--disable-plugins**
Disable installed plugins
**--enable-plugins**
Enable installed plugins (plugins will likely not work)
**--post** __ __
Add an additional post field (repeatable)
**--post-file** __ __
Post an additional file (repeatable)
### -p, --proxy
Use a proxy
**--proxy-hostname-lookup**
Use the proxy for resolving hostnames
**--radiobutton-checked-svg** __
Use this SVG file when rendering checked radiobuttons
**--radiobutton-svg** __
Use this SVG file when rendering unchecked radiobuttons
**--run-script** __
Run this additional javascript after the page is done loading (repeatable)
**--ssl-crt-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 to ssl client cert private key
**--ssl-key-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** __
Specify a user style sheet, to load with every page
**--username** __
HTTP Authentication username
**--window-status** __
Wait until window.status is equal to this string before rendering page
**--zoom** __
Use this zoom factor
### Specifying A Proxy
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
:= "http://" | "socks5://"
:= (":" )? "@"
:= "None" | ? ? (":" )?
Here are some examples (In case you are unfamiliar with the BNF):
socks5://myproxyserver
None
### Reduced Functionality
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.
### Page sizes
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 <‐
Size-enum>.
For a more fine grained control over the page size the --page-height and --page-width options
may be used
### Reading arguments from stdin
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 " qapplication.pdf" >> cmds
echo "cover google.com (software) qt.pdf" >> cmds
wkhtmltopdf --read-args-from-stdin --book < cmds
### Page Breaking
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 so‐
lution 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.
## Contact
If you experience bugs or want to request new features please visit <‐
topdf.org/support.html>
## Authors
Jakob Truelsen <>
Ashish Kulkarni <>
Jan Habermann <>
Pablo Ruiz García <>
Trevor North <>
Nate Pinchot <>
pussbb <>
Aaron Stone <>
Patrick Widauer @a-ctor
Peter van der Tak <>
Benjamin Sinkula <>
Kasper F. Brandt <>
Michael Nitze <>
Rok Dvojmoc <>
theirix <>
Tomsgu <>
Artem Butusov <>
Christian Sciberras <>
Daniel M. Lambea <>
Douglas Bagnall <>
peterrehm <>
Renan Gonçalves <>
Ruslan Grabovoy <>
Sander Kleykens <>
Adam Thorsen <>
Albin Kerouanton <>
Alejandro Dubrovsky <>
Arthur Cinader @acinader
Benoit Garret <>
Bill Kuker <>
cptjazz <>
daigot <>
Destan Sarpkaya @destan
Duncan Smart <>
Emil Lerch <>
Erik Hyrkas <>
Erling Linde <>
Fábio C. Barrionuevo da Luz <>
Fr33m1nd <>
Frank Groeneveld <>
Immanuel Häussermann <>
Jake Petroules <>
James Macdonald <>
Jason Smith <>
John Muccigrosso @Jmuccigr
Julien Le Goff <>
Kay Lukas <>
Kurt Revis <>
laura @holamon
Marc Laporte <>
Matthew M. Boedicker <>
Matthieu Bontemps <>
Max Sikstrom <>
Nolan Neustaeter <>
Oleg Kostyuk <>
Pankaj Jangid <>
robinbetts <>
Sem <>
Stefan Weil <>
Stephen Kennedy <>
Steve Shreeve <>
Sven Nierlein <>
Tobin Juday <>
Todd Fisher <>
Костадин Дамянов <>
Emmanuel Bouthenot <>
Rami @icnocop
Khodeir-hubdoc @Khodeir-hubdoc
Jonathan Jefferies @jjok
Joe Ayers <>
Jeffrey Cafferata <>
rainabba
Mehdi Abbad
Lyes Amazouz
Pascal Bach
Mário Silva
2009 February 23 [WKHTMLTOPDF(1)](https://www.chedong.com/phpMan.php/man/WKHTMLTOPDF/1/markdown)