Command line

This is the man page of version 0.8. Run man pdf2htmlEX for the latest manual.

Please file an issue if you find this page outdated.

NAME
     pdf2htmlEX - converts PDF to HTML without losing text and format.


USAGE
     pdf2htmlEX [options] <input-filename> [<output-filename>]


DESCRIPTION
   pdf2htmlEX is a utility that converts PDF files to HTML files.

   pdf2htmlEX  tries its best to render the PDF precisely, maintain proper
   styling, while retaining text and optimizing for Web.

   Fonts are extracted form PDF and then embedded into HTML (Type 3  fonts
   are  not  supported).  Text  in  the  converted  HTML  file  is usually
   selectable and copyable.

   Other objects are rendered as images and also embedded.


OPTIONS
Pages
   -f, --first-page <num> (Default: 1)
          Specify the first page to process


   -l, --last-page <num> (Default: last page)
          Specify the last page to process


Dimensions
   --zoom <ratio>, --fit-width <width>, --fit-height <height> --zoom spec‐
   ifies  the zoom factor directly; --fit-width/height specifies the maxi‐
   mum width/height of a page, the values are in pixels.

   If multiple values are specified, the minimum one will be used.

   If none is specified, pages will be rendered as 72DPI.


   --use-cropbox <0|1> (Default: 1)
          Use CropBox instead of MediaBox for output.


   --hdpi <dpi>, --vdpi <dpi> (Default: 144)
          Specify the horizontal and vertical DPI for images



Output
   --single-html <0|1> (Default: 1)
          Whether to embed everything into one HTML file.

          If switched off, there will be  several  files  generated  along
          with the HTML file including files for fonts, css, images.

          Note that the outline will always be embedded into the main HTML
          file no matter if this switch is on or not.  And only when  this
          switch  is  off  will there be a separate .outline file contains
          the outline.  You need to modify the manifest if you do not want
          outline embedded.


   --split-pages <0|1> (Default: 0)
          If  turned on, the content of each page is stored in a separated
          file.

          --page-filename may be used to specify the format for the  file‐
          names  for individual pages. A %d placeholder may be included to
          indicate where the page number should be placed. The placeholder
          supports  a  limited  subset  of  normal numerical placeholders,
          including specified width and zero padding.

          If --page-filename does not contain a placeholder for  the  page
          number,  the  page  number  will be inserted directly before the
          file extension. If the filename does not have an extension,  the
          page number will be placed at the end of the file name.

          If  --page-filename  is  not specified, <input-filename> will be
          used for the output filename, replacing the extension with .page
          and adding the page number directly before the extension.

          This  switch is useful if you want pages to be loaded separately
          & dynamically -- a supporting server might be necessary.

          Examples

          pdf2htmlEX --split-pages 1 foo.pdf

            Yields page files foo1.page, foo2.page, etc.

          pdf2htmlEX --split-pages 1 foo.pdf bar.baz

            Yields page files bar1.baz, bar2.baz, etc.

          pdf2htmlEX --split-pages 1 foo.pdf page%dbar.baz

            Yields page files page1bar.baz, page2bar.baz, etc.

          pdf2htmlEX --split-pages 1 foo.pdf bar%03d.baz

            Yields page files bar001.baz, bar002.baz, etc.


   --dest-dir <dir> (Default: .)
          Specify destination folder.


   --css-filename <filename> (Default: <none>)
          Specify the filename of the generated css file, if not embedded.

          If it's empty, the file name will be determined automatically.


   --page-filename <filename> (Default: <none>)
          Specify the filename template for pages.  This  is  only  useful
          when --split-pages is 1

          If  it's  empty,  a default one will be used, see description of
          --split-pages


   --outline-filename <filename> (Default: <none>)
          Specify the filename of  the  generated  outline  file,  if  not
          embedded.

          If it's empty, the file name will be determined automatically.


   --process-nontext <0|1> (Default: 1)
          Whether to process non-text objects (as images)


   --process-outline <0|1> (Default: 1)
          Whether to show outline in the generated HTML


   --printing <0|1> (Default: 1)
          Enable  printing  support.  Disabling this option may reduce the
          size of CSS.


   --fallback <0|1> (Deafult: 0)
          Output in fallback mode, for better accuracy and browser compat‐
          ibility, but the size becomes larger.


Fonts
   --embed-external-font <0|1> (Default: 1)
          Specify  whether the local matched fonts, for fonts not embedded
          in PDF, should be embedded into HTML.

          If this switch is off, only font names are  exported  such  that
          web  browsers  may try to find proper fonts themselves, and that
          might cause issues about incorrect font metrics.


   --font-suffix <suffix> (Default: .ttf)
          Specify the suffix of fonts extracted from the PDF file.


   --decompose-ligature <0|1> (Default: 0)
          Decompose ligatures. For example 'fi' -> 'f''i'.


   --remove-unused-glyph <0|1> (Default: 0)
          If set to 1, remove unused glyphs in embedded fonts in order  to
          reduce the file size.

          Currently  this  option is experimental, turning it on may cause
          segmentation fault or debris-like fonts.


   --auto-hint <0|1> (Default: 0)
          If set to 1, hints will be generated for the fonts  using  font‐
          forge.

          This may be preceded by --external-hint-tool.


   --external-hint-tool <tool> (Default: <none>)
          If specified, the tool will be called in order to enhanced hint‐
          ing for fonts, this will precede --auto-hint.

          The tool will be called as  '<tool>  <in.suffix>  <out.suffix>',
          where suffix will be the same as specified for --font-suffix.


   --stretch-narrow-glyph <0|1> (Default: 0)
          If  set  to  1,  glyphs  narrower  than described in PDF will be
          stretched; otherwise space will be padded to the  right  of  the
          glyphs


   --squeeze-wide-glyph <0|1> (Default: 1)
          If  set  to  1,  glyphs  wider  than  described  in  PDF will be
          squeezed; otherwise it will be truncated.


Text
   --heps <len>, --veps <len> (Default: 1)
          Specify the maximum  tolerable  horizontal/vertical  offset  (in
          pixels).

          pdf2htmlEX  would try to optimize the generated HTML file moving
          Text within this distance.


   --space-threshold <ratio> (Default: 0.125)
          pdf2htmlEX would insert a whitespace character ' ' if  the  dis‐
          tance  between two consecutive letters in the same line is wider
          than ratio * font_size.


   --font-size-multiplier <ratio> (Default: 4.0)
          Many web browsers limit the minimum font size,  and  many  would
          round the given font size, which results in incorrect rendering.

          Specify a ratio greater than 1 would resolve this issue, however
          it might freeze some browsers.

          For some versions of Firefox, however, there will be  a  problem
          when  the  font size is too large, in which case a smaller value
          should be specified here.


   --space-as-offset <0|1> (Default: 0)
          If set to 1, space characters will be treated as offsets,  which
          allows a better optimization.

          For  PDF  files  with  bad encodings, turning on this option may
          cause losing characters.


   --tounicode <-1|0|1> (Default: 0)
          A ToUnicode map may be provided for each font in PDF which indi‐
          cates  the  'meaning'  of the characters. However often there is
          better "ToUnicode" info in Type 0/1  fonts,  and  sometimes  the
          ToUnicode map provided is wrong.  If this value is set to 1, the
          ToUnicode Map is always applied, if provided in PDF, and charac‐
          ters may not render correctly in HTML if there are collisions.

          If  set to -1, a customized map is used such that rendering will
          be correct in HTML (visually the same), but you may not get cor‐
          rect characters by select & copy & paste.

          If  set  to  0, pdf2htmlEX would try its best to balance the two
          methods above.


   --optimize-text <0|1> (Deafult: 1)
          If set to 1, pdf2htmlEX will try to reduce the  number  of  HTML
          elements used for text. Turn it off if anything goes wrong.


PDF Protection
   -o, --owner-password <password>
          Specify owner password


   -u, --user-password <password>
          Specify user password


   --no-drm <0|1> (Default: 0)
          Override document DRM settings


Misc.
   --clean-tmp <0|1> (Default: 1)
          If switched off, intermediate files won't be cleaned in the end.


   --data-dir <dir> (Default: /usr/share/pdf2htmlEX)
          Specify  the  folder  holding  the manifest and other files (see
          below for the manifest file)`


   --css-draw <0|1> (Default: 0)
          Experimental and unsupported CSS drawing


   --debug <0|1> (Default: 0)
          Print debug information.


Meta
   -v, --version
          Print copyright and version info


   --help Print usage information


MANIFEST and DATA-DIR
   When split-pages is 0, the manifest file describes how the  final  html
   page should be generated.

   By  default,  pdf2htmlEX  will use the manifest in the default data-dir
   (run `pdf2htmlEX -v` to check), which gives a simple demo of  its  syn‐
   tax.

   You can modify the default one, or you can create a new one and specify
   the correct data-dir in the command line.

   When single-html is 1, all files  referred  by  the  manifest  must  be
   located in the data-dir.


EXAMPLE
   pdf2htmlEX /path/to/file.pdf
          Convert file.pdf into file.html

   pdf2htmlEX --clean-tmp 0 --debug 1 /path/to/file.pdf
          Convert file.pdf and leave all intermediate files.

   pdf2htmlEX --dest-dir out --single-html 0 /path/to/file.pdf
          Convert  file.pdf  into out/file.html and leave font/image files
          separated.