Some test text!

menu
search
Optionskeyboard_arrow_down

Command-Line Summary

Usage: xpsconvert [<options>] file...

OPTIONS:

  --file... arg              A list of folders and/or file names to process.

  -o [ --output ] arg        The output folder used to store modified files. By
                             default, the current working folder will be used
                             to store converted files.

  --subfolders               Process all subfolders.

  --prefix arg               The prefix for the output file. The output
                             filename will be constructed by concatenating the
                             prefix string, the page number(when converting
                             multi-page documents to image) and the appropriate
                             extension (e.g. myprefix.pdf or
                             myprefix_2.png).The prefix option should be used
                             only for conversion of individual documents. By
                             default, each input filename will be used as a
                             prefix.

  -f [ --format ] arg (=pdf) Output format. The following is a list of
                             supported output formats:
                               pdf
                               png
                               png8 (palettized png)
                               jpg (or jpeg)
                               tif (or tiff)
                               tif8 (palettized tiff)
                               bmp
                               raw
                             The default output format is PDF.

  --physical_model arg       Specifies the physical model of the xps files to
                             process.  The following is a list of supported
                             physical models:
                               zip
                               dir
                               all
                             The default physical model is zip.

  -r [ --rotate ] arg (=0)   Rotates all pages by a given number of degrees
                             counterclockwise. The allowed values are 0, 90,
                             180, and 270. The default value is 0.

  -a [ --pages ] arg (=-)    Specifies the list of pages to convert. By
                             default, all pages are converted.

  --nosmooth                 Disables image smoothing.

  --extension arg (=.xps)    The default file extension used to process XPS
                             documents. The default extension is ".xps".

  --verb arg (=1)            Set the verbosity level. Valid parameter values
                             are 0, 1, and 2. The higher number results in more
                             feedback. The default is 1.

  -v [ --version ]           Print the version information.

  -h [ --help ]              Print a listing of available options.


Image Specific Options:
  -c [ --clip ] arg          User definable clip box. By default, the clip
                             region is identical to current page 'box'.

  --digits arg               The number of digits used in the page counter
                             portion of the output filename.  By default, new
                             digits are added as needed; however this parameter
                             could be used to format the page counter field to
                             a uniform width (e.g. myfile_0001.png,
                             myfile_0002.png, etc).

  -d [ --dpi ] arg (=92)     For image conversion: The output resolution, from
                             1 to 1000, in Dots Per Inch (DPI). The higher the
                             DPI, the larger the image. Resolutions larger than
                             1000 DPI can be achieved by rendering image in
                             tiles or stripes. The default resolution is 92
                             DPI.

  --hres arg                 The width of the output image, in pixels.

  --vres arg                 The height of the output image, in pixels.

  -g [ --gray ]              Render and export the image in grayscale mode.
                             Sets pixel format to 8 bits per pixel grayscale.
                             By default, the image is rendered and exported in
                             RGB color space.

  --mono                     Export the rendered image as 1 bit per pixel
                             (monochrome) image. If the output format is TIFF,
                             the image will be compressed using G4 CCITT
                             compression algorithm. By default, the image is
                             not dithered. To enable dithering use '--dither'
                             option.

  -k [ --cmyk ]              Render and export the image in CMYK mode. To
                             export CMYK, the output image format must support
                             CMYK pixel format. An example of image format that
                             supports CMYK is TIFF (e.g. -f tif -k). By
                             default, the image is rendered and exported in RGB
                             color space.

  --dither                   Enables dithering when the image is exported in
                             palettized or monochrome mode (e.g. for tif8 or
                             png8 or --mono).

  --gamma arg (=0)           Sets the gamma factor used for anti-aliased
                             rendering. Typical values are in the range from
                             0.1 to 3. Gamma correction can be used to improve
                             the quality of anti-aliased image output and can
                             (to some extent) decrease the appearance common
                             anti-aliasing artifacts (such as pixel width lines
                             between polygons).

  -q [ --quality ] arg (=80) Compression quality is a number in the range from
                             1 to 100. Lower numbers usually result in better
                             compression at the expense of image quality. The
                             default setting is 80.

  -m [ --multipage ]         if the output image format supports multi-page or
                             multi-frame capability, store all output images in
                             one file instead of separate files. Currently,
                             this option is only relevant to TIFF output. By
                             default, images will be saved in separate files.

  --transparent_page         sets the page color to transparent. By default,
                             XPSConvert assumes that the page is drawn directly
                             on an opaque white surface. Some applications may
                             need to draw the page on a different backdrop. In
                             this case any pixels that are not covered during
                             rendering will be transparent.



Examples:
 xpsconvert -o test_out/ex1 "PDFTron XPSConvert User Manual.xps"

Get the answers you need: Support

close

Free Trial

Get unlimited trial usage of PDFTron SDK to bring accurate, reliable, and fast document processing capabilities to any application or workflow.

Select a platform to get started with your free trial.

Unlimited usage. No email address required.

PDFTron Receives USD$71 Million Growth Investment Led By Silversmith Capital Partners

Learn more
close