这是 pdf2htmlEX 0.12 版本的帮助手册. 也可以直接在命令行执行 man pdf2htmlEX 来查看最新的帮助手册.

    如果发现本文档过期了，可以通过发起 issue 来通知我。

    1. pdf2htmlEX(1)              pdf2htmlEX 通用手册             pdf2htmlEX(1)
    3. NAME
    4.          pdf2htmlEX - 将 PDF 转换成 HTML（保持原有的文本和格式）。
    6. 用法
    7.          pdf2htmlEX [options] <input-filename> [<output-filename>]
    9. 描述
    10.        pdf2htmlEX 是一个将 PDF 转换成 HTML 文件的工具.
    12.        pdf2htmlEX  尝试准确的转换 PDF, 保留适当的样式和文本, 而且还会为 Web 展示做优化。
    14.        从 PDF 中提取到的字体会被嵌入到 HTML 中( Type 3 号字体暂不支持)。  转换后的 HTML 文件中的文本通常是可以被选中和复制的。
    16.        其他对象会被渲染为图像并嵌入到 HTML 中。
    18. 选项
    19.    页面相关
    20.        -f, --first-page <num> (默认值: 1)
    21.               指定要处理的第一页是那一页
    23.        -l, --last-page <num> (默认值: 最后一页)
    24.               指定最后要处理的是那一页
    26.    Dimensions
    27.        --zoom <ratio>, --fit-width <width>, --fit-height <height>
    28.               --zoom 指定了缩放因子;  --fit-width/height
    29.               指定了页面的最大宽度和高度, 单位是像素.
    31.               如果指定了多个值，会使用最小值。
    33.               如果没有指定, 页面将以 72DPI 的规格来渲染.
    35.        --use-cropbox <0|1> (默认值: 1)
    36.               使用 CropBox 来代替 MediaBox 作为输出.
    38.        --dpi <dpi> (默认值: 144)
    39.               指定图像的横向和纵向的 DPI 。
    41.    输出
    42.        --embed <string>
    43.        --embed-css <0|1> (默认值: 1)
    44.        --embed-font <0|1> (默认值: 1)
    45.        --embed-image <0|1> (默认值: 1)
    46.        --embed-javascript <0|1> (默认值: 1)
    47.        --embed-outline <0|1> (默认值: 1)
    48.               指定哪些元素会被嵌入到输出的 HTML 文件中。
    50.               如果被关闭,  对应的组成部分（CSS、font、image、Javascript）会被生成为单独的文件。
    52.               --embed 接受字符串作为值。 具体的值必须是 `cCfFiIjJoO` 其中的一个, `cCfFiIjJoO` 对应的是
    53.               --embed-*** 开关（比如 c 或者 C 就是代表 --embed-css）. 其中小写字母代表具体的值为 0，大写代表具体的值为 1。  例如,  `--embed  cFIJo` 表示除了 CSS 文件和 outlines (大纲) 其他部分都会被嵌入到 HTML 文件中.
    55.        --split-pages <0|1> (默认值: 0)
    56.               如果打开的话，每个页面都会被作为一个单独的文件输出。
    58.               这个开关在你想要动态加载单个 HTML 页面的时候会很有用，这需要服务端的支持（要自己实现单独加载特定页面的逻辑）.
    60.               也可以参考 --page-filename 选项。
    62.        --dest-dir <dir> (默认值: .)
    63.               指定输出的目标文件夹（默认是当前文件夹）。
    65.        --css-filename <filename> (默认值: <none>)
    66.               指定生成的 CSS 文件（如果使用的不是嵌入的方式的话）的文件名。
    68.               如果留空的话，对应的文件名会自动生成。
    70.        --page-filename <filename> (默认值: <none>)
    71.               Specify the filename template for pages when --split-pages is 1
    73.               A %d placeholder may be included in `filename` to indicate where
    74.               the  page  number  should  be placed. The placeholder supports a
    75.               limited subset of normal numerical placeholders, including spec‐
    76.               ified width and zero padding.
    78.               If  `filename`  does not contain a placeholder for the page num‐
    79.               ber, the page number will be inserted directly before  the  file
    80.               extension.  If the filename does not have an extension, the page
    81.               number will be placed at the end of the file name.
    83.               If --page-filename is not specified,  <input-filename>  will  be
    84.               used for the output filename, replacing the extension with .page
    85.               and adding the page number directly before the extension.
    87.               Examples
    89.               pdf2htmlEX --split-pages 1 foo.pdf
    91.                 Yields page files foo1.page, foo2.page, etc.
    93.               pdf2htmlEX --split-pages 1 foo.pdf --page-filename bar.baz
    95.                 Yields page files bar1.baz, bar2.baz, etc.
    97.               pdf2htmlEX --split-pages 1 foo.pdf --page-filename page%dbar.baz
    99.                 Yields page files page1bar.baz, page2bar.baz, etc.
    101.               pdf2htmlEX --split-pages 1 foo.pdf --page-filename bar%03d.baz
    103.                 Yields page files bar001.baz, bar002.baz, etc.
    105.        --outline-filename <filename> (默认值: <none>)
    106.               Specify the filename of  the  generated  outline  file,  if  not
    107.               embedded.
    109.               If it's empty, the file name will be determined automatically.
    111.        --process-nontext <0|1> (默认值: 1)
    112.               Whether to process non-text objects (as images)
    114.        --process-outline <0|1> (默认值: 1)
    115.               Whether to show outline in the generated HTML
    117.        --printing <0|1> (默认值: 1)
    118.               Enable  printing  support.  Disabling this option may reduce the
    119.               size of CSS.
    121.        --fallback <0|1> (默认值: 0)
    122.               Output in fallback mode, for better accuracy and browser compat‐
    123.               ibility, but the size becomes larger.
    125.        --tmp-file-size-limit <limit> (默认值: -1)
    126.               This  limits the total size (in KB) of the temporary files which
    127.               will also limit the total size of the output file.  This  is  an
    128.               estimate and it will stop after a page, once the total temporary
    129.               files size is greater than this number.
    131.               -1 means no limit and is the default.
    133.    Fonts
    134.        --embed-external-font <0|1> (默认值: 1)
    135.               Specify whether the local matched fonts, for fonts not  embedded
    136.               in PDF, should be embedded into HTML.
    138.               If  this  switch  is off, only font names are exported such that
    139.               web browsers may try to find proper fonts themselves,  and  that
    140.               might cause issues about incorrect font metrics.
    142.        --font-format <format> (默认值: woff)
    143.               Specify the format of fonts extracted from the PDF file.
    145.        --decompose-ligature <0|1> (默认值: 0)
    146.               Decompose ligatures. For example 'fi' -> 'f''i'.
    148.        --auto-hint <0|1> (默认值: 0)
    149.               If  set  to 1, hints will be generated for the fonts using font‐
    150.               forge.
    152.               This may be preceded by --external-hint-tool.
    154.        --external-hint-tool <tool> (默认值: <none>)
    155.               If specified, the tool will be called in order to enhanced hint‐
    156.               ing for fonts, this will precede --auto-hint.
    158.               The  tool  will  be called as '<tool> <in.suffix> <out.suffix>',
    159.               where suffix will be the same as specified for --font-format.
    161.        --stretch-narrow-glyph <0|1> (默认值: 0)
    162.               If set to 1, glyphs narrower  than  described  in  PDF  will  be
    163.               stretched;  otherwise  space  will be padded to the right of the
    164.               glyphs
    166.        --squeeze-wide-glyph <0|1> (默认值: 1)
    167.               If set to  1,  glyphs  wider  than  described  in  PDF  will  be
    168.               squeezed; otherwise it will be truncated.
    170.        --override-fstype <0|1> (默认值: 0)
    171.               Clear the fstype bits in TTF/OTF fonts.
    173.               Turn  this  on  if Internet Explorer complains about 'Permission
    174.               must be Installable' AND you have permission to do so.
    176.        --process-type3 <0|1> (默认值: 0)
    177.               If turned on, pdf2htmlEX will try to convert Type 3  fonts  such
    178.               that  text can be rendered natively in HTML.  Otherwise all text
    179.               with Type 3 fonts will be rendered as image.
    181.               This feature is highly experimental.
    183.    Text
    184.        --heps <len>, --veps <len> (默认值: 1)
    185.               Specify the maximum  tolerable  horizontal/vertical  offset  (in
    186.               pixels).
    188.               pdf2htmlEX  would try to optimize the generated HTML file moving
    189.               Text within this distance.
    191.        --space-threshold <ratio> (默认值: 0.125)
    192.               pdf2htmlEX would insert a whitespace character ' ' if  the  dis‐
    193.               tance  between two consecutive letters in the same line is wider
    194.               than ratio * font_size.
    196.        --font-size-multiplier <ratio> (默认值: 4.0)
    197.               Many web browsers limit the minimum font size,  and  many  would
    198.               round the given font size, which results in incorrect rendering.
    200.               Specify a ratio greater than 1 would resolve this issue, however
    201.               it might freeze some browsers.
    203.               For some versions of Firefox, however, there will be  a  problem
    204.               when  the  font size is too large, in which case a smaller value
    205.               should be specified here.
    207.        --space-as-offset <0|1> (默认值: 0)
    208.               If set to 1, space characters will be treated as offsets,  which
    209.               allows a better optimization.
    211.               For  PDF  files  with  bad encodings, turning on this option may
    212.               cause losing characters.
    214.        --tounicode <-1|0|1> (默认值: 0)
    215.               A ToUnicode map may be provided for each font in PDF which indi‐
    216.               cates  the  'meaning'  of the characters. However often there is
    217.               better "ToUnicode" info in Type 0/1  fonts,  and  sometimes  the
    218.               ToUnicode map provided is wrong.  If this value is set to 1, the
    219.               ToUnicode Map is always applied, if provided in PDF, and charac‐
    220.               ters may not render correctly in HTML if there are collisions.
    222.               If  set to -1, a customized map is used such that rendering will
    223.               be correct in HTML (visually the same), but you may not get cor‐
    224.               rect characters by select & copy & paste.
    226.               If  set  to  0, pdf2htmlEX would try its best to balance the two
    227.               methods above.
    229.        --optimize-text <0|1> (默认值: 0)
    230.               If set to 1, pdf2htmlEX will try to reduce the  number  of  HTML
    231.               elements used for text. Turn it off if anything goes wrong.
    233.    Background Image
    234.        --bg-format <format> (默认值: png)
    235.               Specify  the  background  image  format.  Run `pdf2htmlEX -v` to
    236.               check all supported formats.
    238.    PDF Protection
    239.        -o, --owner-password <password>
    240.               Specify owner password
    242.        -u, --user-password <password>
    243.               Specify user password
    245.        --no-drm <0|1> (默认值: 0)
    246.               Override document DRM settings
    248.               Turn this on only when you have permission.
    250.    Misc.
    251.        --clean-tmp <0|1> (默认值: 1)
    252.               If switched off, intermediate files won't be cleaned in the end.
    254.        --data-dir <dir> (默认值: /usr/local/share/pdf2htmlEX)
    255.               Specify the folder holding the manifest  and  other  files  (see
    256.               below for the manifest file)`
    258.        --tmp-dir <dir> (默认值: /tmp)
    259.               Specify the temporary folder to use for temporary files
    261.        --css-draw <0|1> (默认值: 0)
    262.               Experimental and unsupported CSS drawing
    264.        --debug <0|1> (默认值: 0)
    265.               Print debug information.
    267.    Meta
    268.        -v, --version
    269.               Print copyright and version info
    271.        --help Print usage information
    273. MANIFEST and DATA-DIR
    274.        When  split-pages  is 0, the manifest file describes how the final html
    275.        page should be generated.
    277.        By default, pdf2htmlEX will use the manifest in  the  default  data-dir
    278.        (run  `pdf2htmlEX  -v` to check), which gives a simple demo of its syn‐
    279.        tax.
    281.        You can modify the default one, or you can create a new one and specify
    282.        the correct data-dir in the command line.
    284.        All files referred by the manifest must be located in the data-dir.
    286. EXAMPLE
    287.        pdf2htmlEX /path/to/file.pdf
    288.               Convert file.pdf into file.html
    290.        pdf2htmlEX --clean-tmp 0 --debug 1 /path/to/file.pdf
    291.               Convert file.pdf and leave all intermediate files.
    293.        pdf2htmlEX --dest-dir out --embed fi /path/to/file.pdf
    294.               Convert  file.pdf  into out/file.html and leave font/image files
    295.               separated.
    297. COPYRIGHT
    298.        Copyright 2012,2013 Lu Wang <coolwanglu@gmail.com>
    300.        pdf2htmlEX is licensed under GPLv3 with additional terms, read  LICENSE
    301.        for details.
    303. AUTHOR
    304.        pdf2htmlEX is written by Lu Wang <coolwanglu@gmail.com>
    306. SEE ALSO
    307.        Home page
    308.               https://github.com/pdf2htmlEX/pdf2htmlEX
    310.        pdf2htmlEX Wiki
    311.               https://github.com/pdf2htmlEX/pdf2htmlEX/wiki
    313.                                 pdf2htmlEX 0.12                  pdf2htmlEX(1)