Command-Line Summary for XPSConvert

1Usage: xpsconvert [<options>] file...
2
3OPTIONS:
4
5  --file... arg              A list of folders and/or file names to process.
6
7  -o [ --output ] arg        The output folder used to store modified files. By
8                             default, the current working folder will be used
9                             to store converted files.
10
11  --subfolders               Process all subfolders.
12
13  --prefix arg               The prefix for the output file. The output
14                             filename will be constructed by concatenating the
15                             prefix string, the page number(when converting
16                             multi-page documents to image) and the appropriate
17                             extension (e.g. myprefix.pdf or
18                             myprefix_2.png).The prefix option should be used
19                             only for conversion of individual documents. By
20                             default, each input filename will be used as a
21                             prefix.
22
23  -f [ --format ] arg (=pdf) Output format. The following is a list of
24                             supported output formats:
25                               pdf
26                               png
27                               png8 (palettized png)
28                               jpg (or jpeg)
29                               tif (or tiff)
30                               tif8 (palettized tiff)
31                               bmp
32                               raw
33                             The default output format is PDF.
34
35  --physical_model arg       Specifies the physical model of the xps files to
36                             process.  The following is a list of supported
37                             physical models:
38                               zip
39                               dir
40                               all
41                             The default physical model is zip.
42
43  -r [ --rotate ] arg (=0)   Rotates all pages by a given number of degrees
44                             counterclockwise. The allowed values are 0, 90,
45                             180, and 270. The default value is 0.
46
47  -a [ --pages ] arg (=-)    Specifies the list of pages to convert. By
48                             default, all pages are converted.
49
50  --nosmooth                 Disables image smoothing.
51
52  --extension arg (=.xps)    The default file extension used to process XPS
53                             documents. The default extension is ".xps".
54
55  --verb arg (=1)            Set the verbosity level. Valid parameter values
56                             are 0, 1, and 2. The higher number results in more
57                             feedback. The default is 1.
58
59  -v [ --version ]           Print the version information.
60
61  -h [ --help ]              Print a listing of available options.
62
63
64Image Specific Options:
65  -c [ --clip ] arg          User definable clip box. By default, the clip
66                             region is identical to current page 'box'.
67
68  --digits arg               The number of digits used in the page counter
69                             portion of the output filename.  By default, new
70                             digits are added as needed; however this parameter
71                             could be used to format the page counter field to
72                             a uniform width (e.g. myfile_0001.png,
73                             myfile_0002.png, etc).
74
75  -d [ --dpi ] arg (=92)     For image conversion: The output resolution, from
76                             1 to 1000, in Dots Per Inch (DPI). The higher the
77                             DPI, the larger the image. Resolutions larger than
78                             1000 DPI can be achieved by rendering image in
79                             tiles or stripes. The default resolution is 92
80                             DPI.
81
82  --hres arg                 The width of the output image, in pixels.
83
84  --vres arg                 The height of the output image, in pixels.
85
86  -g [ --gray ]              Render and export the image in grayscale mode.
87                             Sets pixel format to 8 bits per pixel grayscale.
88                             By default, the image is rendered and exported in
89                             RGB color space.
90
91  --mono                     Export the rendered image as 1 bit per pixel
92                             (monochrome) image. If the output format is TIFF,
93                             the image will be compressed using G4 CCITT
94                             compression algorithm. By default, the image is
95                             not dithered. To enable dithering use '--dither'
96                             option.
97
98  -k [ --cmyk ]              Render and export the image in CMYK mode. To
99                             export CMYK, the output image format must support
100                             CMYK pixel format. An example of image format that
101                             supports CMYK is TIFF (e.g. -f tif -k). By
102                             default, the image is rendered and exported in RGB
103                             color space.
104
105  --dither                   Enables dithering when the image is exported in
106                             palettized or monochrome mode (e.g. for tif8 or
107                             png8 or --mono).
108
109  --gamma arg (=0)           Sets the gamma factor used for anti-aliased
110                             rendering. Typical values are in the range from
111                             0.1 to 3. Gamma correction can be used to improve
112                             the quality of anti-aliased image output and can
113                             (to some extent) decrease the appearance common
114                             anti-aliasing artifacts (such as pixel width lines
115                             between polygons).
116
117  -q [ --quality ] arg (=80) Compression quality is a number in the range from
118                             1 to 100. Lower numbers usually result in better
119                             compression at the expense of image quality. The
120                             default setting is 80.
121
122  -m [ --multipage ]         if the output image format supports multi-page or
123                             multi-frame capability, store all output images in
124                             one file instead of separate files. Currently,
125                             this option is only relevant to TIFF output. By
126                             default, images will be saved in separate files.
127
128  --transparent_page         sets the page color to transparent. By default,
129                             XPSConvert assumes that the page is drawn directly
130                             on an opaque white surface. Some applications may
131                             need to draw the page on a different backdrop. In
132                             this case any pixels that are not covered during
133                             rendering will be transparent.
134
135
136
137Examples:
138 xpsconvert -o test_out/ex1 "Apryse XPSConvert User Manual.xps"