Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

pdftoppm (1)

Name

pdftoppm - verter (version 3.03)

Synopsis

pdftoppm [options] PDF-file PPM-root

Description

pdftoppm(1)                 General Commands Manual                pdftoppm(1)



NAME
       pdftoppm - Portable Document Format (PDF) to Portable Pixmap (PPM) con-
       verter (version 3.03)

SYNOPSIS
       pdftoppm [options] PDF-file PPM-root

DESCRIPTION
       Pdftoppm converts Portable Document Format (PDF) files to  color  image
       files  in Portable Pixmap (PPM) format, grayscale image files in Porta-
       ble Graymap (PGM) format, or monochrome image files in Portable  Bitmap
       (PBM) format.

       Pdftoppm reads the PDF file, PDF-file, and writes one PPM file for each
       page, PPM-root-number.ppm, where number is the page  number.   If  PDF-
       file is '-', it reads the PDF file from stdin.

OPTIONS
       -f number
              Specifies the first page to convert.

       -l number
              Specifies the last page to convert.

       -o     Generates only the odd numbered pages.

       -e     Generates only the even numbered pages.

       -singlefile
              Writes only the first page and does not add digits.

       -r number
              Specifies  the  X  and Y resolution, in DPI.  The default is 150
              DPI.

       -rx number
              Specifies the X resolution, in DPI.  The default is 150 DPI.

       -ry number
              Specifies the Y resolution, in DPI.  The default is 150 DPI.

       -scale-to number
              Scales the long side of each page (width  for  landscape  pages,
              height  for  portrait pages) to fit in scale-to pixels. The size
              of the short side will be determined by the aspect ratio of  the
              page.

       -scale-to-x number
              Scales  each  page  horizontally to fit in scale-to-x pixels. If
              scale-to-y is set to -1, the vertical size  will  determined  by
              the aspect ratio of the page.

       -scale-to-y number
              Scales  each  page  vertically  to  fit in scale-to-y pixels. If
              scale-to-x is set to -1, the horizontal size will determined  by
              the aspect ratio of the page.

       -scale-dimension-before-rotation
              Swaps horizontal and vertical size for a rotated (landscape) pdf
              before scaling instead of after.

       -x number
              Specifies the x-coordinate of the crop area top left corner

       -y number
              Specifies the y-coordinate of the crop area top left corner

       -W number
              Specifies the width of crop area in pixels (default is 0)

       -H number
              Specifies the height of crop area in pixels (default is 0)

       -sz number
              Specifies the size of crop square in pixels (sets W and H)

       -cropbox
              Uses the crop box rather than  media  box  when  generating  the
              files

       -hide-annotations
              Do not show annotations

       -mono  Generate a monochrome PBM file (instead of a color PPM file).

       -gray  Generate a grayscale PGM file (instead of a color PPM file).

       -displayprofile displayprofilefile
              If  poppler  is  compiled  with  colour management support, this
              option sets the display profile to the  ICC  profile  stored  in
              displayprofilefile.

       -defaultgrayprofile defaultgrayprofilefile
              If  poppler  is  compiled  with  colour management support, this
              option sets the DefaultGray  color  space  to  the  ICC  profile
              stored in defaultgrayprofilefile.

       -defaultrgbprofile defaultrgbprofilefile
              If  poppler  is  compiled  with  colour management support, this
              option sets the DefaultRGB color space to the ICC profile stored
              in defaultrgbprofilefile.

       -defaultcmykprofile defaultcmykprofilefile
              If  poppler  is  compiled  with  colour management support, this
              option sets the DefaultCMYK  color  space  to  the  ICC  profile
              stored in defaultcmykprofilefile.

       -png   Generates a PNG file instead a PPM file.

       -jpeg  Generates a JPEG file instead a PPM file.

       -jpegopt jpeg-options
              When  used  with  -jpeg,  takes a list of options to control the
              jpeg compression. See JPEG OPTIONS for the available options.

       -tiff  Generates a TIFF file instead a PPM file.

       -tiffcompression none | packbits | jpeg | lzw | deflate
              Specifies the TIFF compression type.  This defaults to "none".

       -freetype yes | no
              Enable or disable FreeType (a TrueType /  Type  1  font  raster-
              izer).  This defaults to "yes".

       -thinlinemode none | solid | shape
              Specifies the thin line mode. This defaults to "none".

       "solid":
              adjust  lines with a width less than one pixel to pixel boundary
              and paint it with a width of one pixel.

       "shape":
              adjust lines with a width less than one pixel to pixel  boundary
              and  paint it with a width of one pixel but with a shape in pro-
              portion to its width.

       -aa yes | no
              Enable or disable font anti-aliasing.  This defaults to "yes".

       -aaVector yes | no
              Enable or disable vector anti-aliasing.  This defaults to "yes".

       -opw password
              Specify the owner password for the  PDF  file.   Providing  this
              will bypass all security restrictions.

       -upw password
              Specify the user password for the PDF file.

       -q     Don't print any messages or errors.

       -progress
              Print progress info as each page is generated.  Three space-sep-
              arated fields are printed to STDERR: the number of  the  current
              page,  the  number  of the last page that will be generated, and
              the path to the file written to.

       -sep char
              Specify single character separator between name and page number,
              default - .

       -forcenum
              Force page number even if there is only one page.

       -v     Print copyright and version information.

       -h     Print usage information.  (-help and --help are equivalent.)

EXIT CODES
       The Xpdf tools use the following exit codes:

       0      No error.

       1      Error opening a PDF file.

       2      Error opening an output file.

       3      Error related to PDF permissions.

       99     Other error.

JPEG OPTIONS
       When  JPEG output is specified, the -jpegopt option can be used to con-
       trol the JPEG compression parameters.  It takes a string  of  the  form
       "<opt>=<val>[,<opt>=<val>]". Currently the available options are:

       quality
              Selects  the  JPEG  quality  value. The value must be an integer
              between 0 and 100.

       progressive
              Select progressive JPEG output. The  possible  values  are  "y",
              "n",  indicating  progressive  (yes)  or  non-progressive  (no),
              respectively.

       optimize
              Sets whether to compute optimal Huffman coding  tables  for  the
              JPEG  output,  which will create smaller files but make an extra
              pass over the data. The value must be "y" or "n", with "y"  per-
              forming  optimization,  otherwise the default Huffman tables are
              used.

AUTHOR
       The pdftoppm software and documentation are copyright 1996-2011 Glyph &
       Cog, LLC.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE    |
       +---------------+----------------------+
       |Availability   | print/filter/poppler |
       +---------------+----------------------+
       |Stability      | Uncommitted          |
       +---------------+----------------------+

SEE ALSO
       pdfdetach(1),  pdffonts(1),  pdfimages(1),  pdfinfo(1),  pdftocairo(1),
       pdftohtml(1), pdftops(1), pdftotext(1) pdfseparate(1), pdfsig(1), pdfu-
       nite(1)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded   from   https://poppler.freedesktop.org/pop-
       pler-21.10.0.tar.xz.

       Further information about this software can be found on the open source
       community website at https://poppler.freedesktop.org/.



                                15 August 2011                     pdftoppm(1)