wkhtmltoimage man page

wkhtmltoimage — html to image converter

Synopsis

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

Description

Converts an HTML page into an image,

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.

   --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

   --quality <int>

Output image quality (between 0 and 100)

-q, --quiet

Be less verbose

   --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)

   --stop-slow-scripts

Stop slow running javascripts

   --no-stop-slow-scripts

Do not Stop slow running javascripts

   --user-style-sheet <url>

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

Contact

If you experience bugs or want to request new features please visit <https://github.com/wkhtmltopdf/wkhtmltopdf/issues>

Authors

 Jakob Truelsen      <antialize@gmail.com>
 Ashish Kulkarni     <kulkarni.ashish@gmail.com>
 Jan Habermann       <jan@habermann24.com>
 Pablo Ruiz Garc��a   <pablo.ruiz@gmail.com>
 Trevor North        <trevor@blubolt.com>
 pussbb              <pussbb@gmail.com>
 Nate Pinchot        <nate.pinchot@gmail.com>
 Kasper F. Brandt    <poizan@poizan.dk>
 peterrehm           <peter.rehm@renvest.de>
 Ruslan Grabovoy     <kudgo.test@gmail.com>
 Renan Gon��alves     <renan.saddam@gmail.com>
 Douglas Bagnall     <douglas@paradise.net.nz>
 Christian Sciberras <uuf6429@gmail.com>
 Aaron Stone         <aaron@serendipity.cx>
 ���������������� ��������������    <maxmight@gmail.com>
 Todd Fisher         <todd.fisher@gmail.com>
 Tobin Juday         <tobinibot@gmail.com>
 Sven Nierlein       <sven@nierlein.org>
 Steve Shreeve       <steve.shreeve@gmail.com>
 Sem                 <spam@esemi.ru>
 Pankaj Jangid       <pankaj.jangid@gmail.com>
 Oleg Kostyuk        <cub.uanic@gmail.com>
 Nolan Neustaeter    <github@noolan.ca>
 Matthieu Bontemps   <matthieu.bontemps@gmail.com>
 Kurt Revis          <krevis@snoize.com>
 Erling Linde        <erlingwl@gmail.com>
 Bill Kuker          <bkuker@billkuker.com>
 Benoit Garret       <benoit.garret@gmail.com>
 Adam Thorsen        <adam.thorsen@gmail.com>
 Emmanuel Bouthenot  <kolter@openics.org>
 Artem Butusov       <art.sormy@gmail.com>
 Michael Nitze       <michael.nitze@online.de>
 theirix             <theirix@gmail.com>
 Kay Lukas           <kay.lukas@gmail.com>
 Emil Lerch          <emil@lerch.org>
 rainabba
 Mehdi Abbad
 Lyes Amazouz
 Pascal Bach
 M��rio Silva

Info

2009 February 23