{ "content": [ { "type": "text", "text": "# WKHTMLTOPDF (man)\n\n## DESCRIPTION\n\nConverts one or more HTML pages into a PDF document, not using wkhtmltopdf patched qt.\n\n## TLDR\n\n> Convert HTML documents or web pages into PDF files.\n\n- Convert a HTML document into PDF:\n `wkhtmltopdf {{input.html}} {{output.pdf}}`\n- Specify the PDF page size (please see `PaperSize` of `QPrinter` for supported sizes):\n `wkhtmltopdf --page-size {{A4}} {{input.html}} {{output.pdf}}`\n- Set the PDF page margins:\n `wkhtmltopdf --margin-{{top|bottom|left|right}} {{10mm}} {{input.html}} {{output.pdf}}`\n- Set the PDF page orientation:\n `wkhtmltopdf --orientation {{Landscape|Portrait}} {{input.html}} {{output.pdf}}`\n- Generate a greyscale version of the PDF document:\n `wkhtmltopdf --grayscale {{input.html}} {{output.pdf}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **Name**\n- **Synopsis** (1 subsections)\n- **Description** (22 subsections)\n- **Contact**\n- **Authors**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "WKHTMLTOPDF", "section": "", "mode": "man", "summary": null, "synopsis": null, "tldr_summary": "Convert HTML documents or web pages into PDF files.", "tldr_examples": [ { "description": "Convert a HTML document into PDF", "command": "wkhtmltopdf {{input.html}} {{output.pdf}}" }, { "description": "Specify the PDF page size (please see `PaperSize` of `QPrinter` for supported sizes)", "command": "wkhtmltopdf --page-size {{A4}} {{input.html}} {{output.pdf}}" }, { "description": "Set the PDF page margins", "command": "wkhtmltopdf --margin-{{top|bottom|left|right}} {{10mm}} {{input.html}} {{output.pdf}}" }, { "description": "Set the PDF page orientation", "command": "wkhtmltopdf --orientation {{Landscape|Portrait}} {{input.html}} {{output.pdf}}" }, { "description": "Generate a greyscale version of the PDF document", "command": "wkhtmltopdf --grayscale {{input.html}} {{output.pdf}}" } ], "tldr_source": "official", "flags": [ { "flag": "-d", "long": "--dpi", "arg": null, "description": "Change the dpi explicitly (this has no effect on X11 based systems)" }, { "flag": "-H", "long": "--extended-help", "arg": null, "description": "Display more extensive help, detailing less common command switches" }, { "flag": "-g", "long": "--grayscale", "arg": null, "description": "PDF will be generated in grayscale" }, { "flag": "-h", "long": "--help", "arg": null, "description": "Display help --htmldoc Output program html help --license Output license information and exit --log-level Set log level to: none, error, warn or info" }, { "flag": "-l", "long": "--lowquality", "arg": null, "description": "Generates lower quality pdf/ps. Useful to shrink the result document space --manpage Output program man page" }, { "flag": "-B", "long": "--margin-bottom", "arg": null, "description": "Set the page bottom margin" }, { "flag": "-L", "long": "--margin-left", "arg": null, "description": "Set the page left margin" }, { "flag": "-R", "long": "--margin-right", "arg": null, "description": "Set the page right margin" }, { "flag": "-T", "long": "--margin-top", "arg": null, "description": "Set the page top margin" }, { "flag": "-O", "long": "--orientation", "arg": null, "description": "Set orientation to Landscape or Portrait --page-height Page height" }, { "flag": "-s", "long": "--page-size", "arg": null, "description": "Set paper size to: A4, Letter, etc. --page-width Page width" }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "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)" }, { "flag": "-V", "long": "--version", "arg": null, "description": "Output version information and exit" }, { "flag": "-n", "long": "--disable-javascript", "arg": null, "description": "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)" }, { "flag": "-p", "long": "--proxy", "arg": null, "description": "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" } ], "examples": [], "see_also": [], "section_outline": [ { "name": "Name", "lines": 4, "subsections": [] }, { "name": "Synopsis", "lines": 4, "subsections": [ { "name": "Document objects", "lines": 34 } ] }, { "name": "Description", "lines": 4, "subsections": [ { "name": "Global Options", "lines": 8 }, { "name": "-d, --dpi", "lines": 1, "flag": "-d", "long": "--dpi" }, { "name": "-H, --extended-help", "lines": 1, "flag": "-H", "long": "--extended-help" }, { "name": "-g, --grayscale", "lines": 1, "flag": "-g", "long": "--grayscale" }, { "name": "-h, --help", "lines": 7, "flag": "-h", "long": "--help" }, { "name": "-l, --lowquality", "lines": 3, "flag": "-l", "long": "--lowquality" }, { "name": "-B, --margin-bottom", "lines": 1, "flag": "-B", "long": "--margin-bottom" }, { "name": "-L, --margin-left", "lines": 1, "flag": "-L", "long": "--margin-left" }, { "name": "-R, --margin-right", "lines": 1, "flag": "-R", "long": "--margin-right" }, { "name": "-T, --margin-top", "lines": 1, "flag": "-T", "long": "--margin-top" }, { "name": "-O, --orientation", "lines": 3, "flag": "-O", "long": "--orientation" }, { "name": "-s, --page-size", "lines": 3, "flag": "-s", "long": "--page-size" }, { "name": "-q, --quiet", "lines": 9, "flag": "-q", "long": "--quiet" }, { "name": "-V, --version", "lines": 4, "flag": "-V", "long": "--version" }, { "name": "Page Options", "lines": 32 }, { "name": "-n, --disable-javascript", "lines": 28, "flag": "-n", "long": "--disable-javascript" }, { "name": "-p, --proxy", "lines": 31, "flag": "-p", "long": "--proxy" }, { "name": "Specifying A Proxy", "lines": 15 }, { "name": "Reduced Functionality", "lines": 17 }, { "name": "Page sizes", "lines": 10 }, { "name": "Reading arguments from stdin", "lines": 15 }, { "name": "Page Breaking", "lines": 11 } ] }, { "name": "Contact", "lines": 5, "subsections": [] }, { "name": "Authors", "lines": 82, "subsections": [] } ], "sections": { "Name": { "content": "wkhtmltopdf - html to pdf converter\n\n\n", "subsections": [] }, "Synopsis": { "content": "wkhtmltopdf [GLOBAL OPTION]... [OBJECT]... \n\n\n", "subsections": [ { "name": "Document objects", "content": "wkhtmltopdf is able to put several objects into the output file, an object is either a single\nwebpage, a cover webpage or a table of contents. The objects are put into the output docu‐\nment in the order they are specified on the command line, options can be specified on a per\nobject basis or in the global options area. Options from the Global Options section can only\nbe placed in the global options area.\n\nA page objects puts the content of a single webpage into the output document.\n\n(page)? [PAGE OPTION]...\n\nOptions for the page object can be placed in the global options and the page options areas.\nThe applicable options can be found in the Page Options and Headers And Footer Options sec‐\ntions.\n\nA cover objects puts the content of a single webpage into the output document, the page does\nnot appear in the table of contents, and does not have headers and footers.\n\ncover [PAGE OPTION]...\n\nAll options that can be specified for a page object can also be specified for a cover.\n\nA table of contents object inserts a table of contents into the output document.\n\ntoc [TOC OPTION]...\n\nAll options that can be specified for a page object can also be specified for a toc, further\nmore the options from the TOC Options section can also be applied. The table of contents is\ngenerated via XSLT which means that it can be styled to look however you want it to look. To\nget an idea of how to do this you can dump the default xslt document by supplying the\n--dump-default-toc-xsl, and the outline it works on by supplying --dump-outline, see the Out‐\nline Options section.\n\n\n" } ] }, "Description": { "content": "Converts one or more HTML pages into a PDF document, not using wkhtmltopdf patched qt.\n\n\n", "subsections": [ { "name": "Global Options", "content": "--collate\nCollate when printing multiple copies\n--no-collate\nDo not collate when printing multiple copies\n--cookie-jar \nRead and write cookies from and to the supplied cookie jar file\n--copies \nNumber of copies to print into the pdf file" }, { "name": "-d, --dpi", "content": "Change the dpi explicitly (this has no effect on X11 based systems)", "flag": "-d", "long": "--dpi" }, { "name": "-H, --extended-help", "content": "Display more extensive help, detailing less common command switches", "flag": "-H", "long": "--extended-help" }, { "name": "-g, --grayscale", "content": "PDF will be generated in grayscale", "flag": "-g", "long": "--grayscale" }, { "name": "-h, --help", "content": "Display help\n--htmldoc\nOutput program html help\n--license\nOutput license information and exit\n--log-level \nSet log level to: none, error, warn or info", "flag": "-h", "long": "--help" }, { "name": "-l, --lowquality", "content": "Generates lower quality pdf/ps. Useful to shrink the result document space\n--manpage\nOutput program man page", "flag": "-l", "long": "--lowquality" }, { "name": "-B, --margin-bottom", "content": "Set the page bottom margin", "flag": "-B", "long": "--margin-bottom" }, { "name": "-L, --margin-left", "content": "Set the page left margin", "flag": "-L", "long": "--margin-left" }, { "name": "-R, --margin-right", "content": "Set the page right margin", "flag": "-R", "long": "--margin-right" }, { "name": "-T, --margin-top", "content": "Set the page top margin", "flag": "-T", "long": "--margin-top" }, { "name": "-O, --orientation", "content": "Set orientation to Landscape or Portrait\n--page-height \nPage height", "flag": "-O", "long": "--orientation" }, { "name": "-s, --page-size", "content": "Set paper size to: A4, Letter, etc.\n--page-width \nPage width", "flag": "-s", "long": "--page-size" }, { "name": "-q, --quiet", "content": "Be less verbose, maintained for backwards compatibility; Same as using --log-level\nnone\n--read-args-from-stdin\nRead command line arguments from stdin\n--readme\nOutput program readme\n--title \nThe title of the generated pdf file (The title of the first document is used if not\nspecified)", "flag": "-q", "long": "--quiet" }, { "name": "-V, --version", "content": "Output version information and exit\n\n\n", "flag": "-V", "long": "--version" }, { "name": "Page Options", "content": "--allow \nAllow the file or files from the specified folder to be loaded (repeatable)\n--background\nDo print background\n--no-background\nDo not print background\n--bypass-proxy-for \nBypass proxy for host (repeatable)\n--cache-dir \nWeb cache directory\n--checkbox-checked-svg \nUse this SVG file when rendering checked checkboxes\n--checkbox-svg \nUse this SVG file when rendering unchecked checkboxes\n--cookie \nSet an additional cookie (repeatable), value should be url encoded.\n--custom-header \nSet an additional HTTP header (repeatable)\n--custom-header-propagation\nAdd HTTP headers specified by --custom-header for each resource request.\n--no-custom-header-propagation\nDo not add HTTP headers specified by --custom-header for each resource request.\n--debug-javascript\nShow javascript debugging output\n--no-debug-javascript\nDo not show javascript debugging output\n--encoding \nSet the default text encoding, for input\n--images\nDo load or print images\n--no-images\nDo not load or print images" }, { "name": "-n, --disable-javascript", "content": "Do not allow web pages to run javascript\n--enable-javascript\nDo allow web pages to run javascript\n--javascript-delay \nWait some milliseconds for javascript finish\n--load-error-handling \nSpecify how to handle pages that fail to load: abort, ignore or skip\n--load-media-error-handling \nSpecify how to handle media files that fail to load: abort, ignore or skip\n--disable-local-file-access\nDo not allowed conversion of a local file to read in other local files, unless explic‐\nitly allowed with --allow\n--enable-local-file-access\nAllowed conversion of a local file to read in other local files.\n--minimum-font-size \nMinimum font size\n--page-offset \nSet the starting page number\n--password \nHTTP Authentication password\n--disable-plugins\nDisable installed plugins\n--enable-plugins\nEnable installed plugins (plugins will likely not work)\n--post \nAdd an additional post field (repeatable)\n--post-file \nPost an additional file (repeatable)", "flag": "-n", "long": "--disable-javascript" }, { "name": "-p, --proxy", "content": "Use a proxy\n--proxy-hostname-lookup\nUse the proxy for resolving hostnames\n--radiobutton-checked-svg \nUse this SVG file when rendering checked radiobuttons\n--radiobutton-svg \nUse this SVG file when rendering unchecked radiobuttons\n--run-script \nRun this additional javascript after the page is done loading (repeatable)\n--ssl-crt-path \nPath to the ssl client cert public key in OpenSSL PEM format, optionally followed by\nintermediate ca and trusted certs\n--ssl-key-password \nPassword to ssl client cert private key\n--ssl-key-path \nPath to ssl client cert private key in OpenSSL PEM format\n--stop-slow-scripts\nStop slow running javascripts\n--no-stop-slow-scripts\nDo not Stop slow running javascripts\n--user-style-sheet \nSpecify a user style sheet, to load with every page\n--username \nHTTP Authentication username\n--window-status \nWait until window.status is equal to this string before rendering page\n--zoom \nUse this zoom factor\n\n\n", "flag": "-p", "long": "--proxy" }, { "name": "Specifying A Proxy", "content": "By default proxy information will be read from the environment variables: proxy, allproxy\nand httpproxy, proxy options can also by specified with the -p switch\n\n := \"http://\" | \"socks5://\"\n := (\":\" )? \"@\"\n := \"None\" | ? ? (\":\" )?\n\nHere are some examples (In case you are unfamiliar with the BNF):\n\nhttp://user:password@myproxyserver:8080\nsocks5://myproxyserver\nNone\n\n\n" }, { "name": "Reduced Functionality", "content": "This version of wkhtmltopdf has been compiled against a version of QT without the wkhtmltopdf\npatches. Therefore some features are missing, if you need these features please use the\nstatic version.\n\nCurrently the list of features only supported with patch QT includes:\n\n* Printing more than one HTML document into a PDF file.\n* Running without an X11 server.\n* Adding a document outline to the PDF file.\n* Adding headers and footers to the PDF file.\n* Generating a table of contents.\n* Adding links in the generated PDF file.\n* Printing using the screen media-type.\n* Disabling the smart shrink feature of WebKit.\n\n\n" }, { "name": "Page sizes", "content": "The default page size of the rendered document is A4, but by using the --page-size option\nthis can be changed to almost anything else, such as: A3, Letter and Legal. For a full list\nof supported pages sizes please see .\n\nFor a more fine grained control over the page size the --page-height and --page-width options\nmay be used\n\n\n" }, { "name": "Reading arguments from stdin", "content": "If you need to convert a lot of pages in a batch, and you feel that wkhtmltopdf is a bit too\nslow to start up, then you should try --read-args-from-stdin,\n\nWhen --read-args-from-stdin each line of input sent to wkhtmltopdf on stdin will act as a\nseparate invocation of wkhtmltopdf, with the arguments specified on the given line combined\nwith the arguments given to wkhtmltopdf\n\nFor example one could do the following:\n\necho \"https://qt-project.org/doc/qt-4.8/qapplication.html qapplication.pdf\" >> cmds\necho \"cover google.com https://en.wikipedia.org/wiki/Qt(software) qt.pdf\" >> cmds\nwkhtmltopdf --read-args-from-stdin --book < cmds\n\n\n" }, { "name": "Page Breaking", "content": "The current page breaking algorithm of WebKit leaves much to be desired. Basically WebKit\nwill render everything into one long page, and then cut it up into pages. This means that if\nyou have two columns of text where one is vertically shifted by half a line. Then WebKit will\ncut a line into to pieces display the top half on one page. And the bottom half on another\npage. It will also break image in two and so on. If you are using the patched version of QT\nyou can use the CSS page-break-inside property to remedy this somewhat. There is no easy so‐\nlution to this problem, until this is solved try organizing your HTML documents such that it\ncontains many lines on which pages can be cut cleanly.\n\n\n" } ] }, "Contact": { "content": "If you experience bugs or want to request new features please visit \n\n\n", "subsections": [] }, "Authors": { "content": "Jakob Truelsen \nAshish Kulkarni \nJan Habermann \nPablo Ruiz García \nTrevor North \nNate Pinchot \npussbb \nAaron Stone \nPatrick Widauer @a-ctor\nPeter van der Tak \nBenjamin Sinkula \nKasper F. Brandt \nMichael Nitze \nRok Dvojmoc \ntheirix \nTomsgu \nArtem Butusov \nChristian Sciberras \nDaniel M. Lambea \nDouglas Bagnall \npeterrehm \nRenan Gonçalves \nRuslan Grabovoy \nSander Kleykens \nAdam Thorsen \nAlbin Kerouanton \nAlejandro Dubrovsky \nArthur Cinader @acinader\nBenoit Garret \nBill Kuker \ncptjazz \ndaigot \nDestan Sarpkaya @destan\nDuncan Smart \nEmil Lerch \nErik Hyrkas \nErling Linde \nFábio C. Barrionuevo da Luz \nFr33m1nd \nFrank Groeneveld \nImmanuel Häussermann \nJake Petroules \nJames Macdonald \nJason Smith \nJohn Muccigrosso @Jmuccigr\nJulien Le Goff \nKay Lukas \nKurt Revis \nlaura @holamon\nMarc Laporte \nMatthew M. Boedicker \nMatthieu Bontemps \nMax Sikstrom \nNolan Neustaeter \nOleg Kostyuk \nPankaj Jangid \nrobinbetts \nSem \nStefan Weil \nStephen Kennedy \nSteve Shreeve \nSven Nierlein \nTobin Juday \nTodd Fisher \nКостадин Дамянов \nEmmanuel Bouthenot \nRami @icnocop\nKhodeir-hubdoc @Khodeir-hubdoc\nJonathan Jefferies @jjok\nJoe Ayers \nJeffrey Cafferata \nrainabba\nMehdi Abbad\nLyes Amazouz\nPascal Bach\nMário Silva\n\n\n\n\n\n2009 February 23 WKHTMLTOPDF(1)", "subsections": [] } } } }