Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/docs/reference/common/document-writer-options.md @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 # Document Writer Options
2
3 ## Supported output formats
4
5 Raster formats:
6 : `cbz`, `png`, `pnm`, `pgm`, `ppm`, `pam`, `pbm`, `pkm`
7
8 Print-raster formats:
9 : `pcl`, `pclm`, `ps`, `pwg`
10
11 Vector formats:
12 : `pdf`, `svg`
13
14 Text formats:
15 : `html`, `xhtml`, `text`, `stext`
16
17 ## Raster output options
18
19 rotate=N
20 : Rotate rendered pages N degrees counterclockwise.
21
22 resolution=N
23 : Set both X and Y resolution in pixels per inch.
24
25 x-resolution=N
26 : X resolution of rendered pages in pixels per inch.
27
28 y-resolution=N
29 : Y resolution of rendered pages in pixels per inch.
30
31 width=N
32 : Render pages to fit N pixels wide (ignore resolution option).
33
34 height=N
35 : Render pages to fit N pixels tall (ignore resolution option).
36
37 colorspace=(gray|rgb|cmyk)
38 : Render using specified colorspace.
39
40 alpha
41 : Render pages with alpha channel and transparent background.
42
43 graphics=(aaN|cop|app)
44 : Set the rasterizer to use for graphics.
45 - `aaN` Antialias with N bits (0 to 8).
46 - `cop` Center of pixel.
47 - `app` Any part of pixel.
48
49 text=(aaN|cop|app)
50 : Set the rasterizer to use for text.
51 - `aaN` Antialias with N bits (0 to 8).
52 - `cop` Center of pixel.
53 - `app` Any part of pixel.
54
55 ## PCL output options
56
57 colorspace=mono
58 : Render 1-bit black and white page.
59
60 colorspace=rgb
61 : Render full color page.
62
63 preset
64 : Possible values are: generic|ljet4|dj500|fs600|lj|lj2|lj3|lj3d|lj4|lj4pl|lj4d|lp2563b|oce9050
65
66 spacing=0
67 : No vertical spacing capability.
68
69 spacing=1
70 : PCL 3 spacing (`<ESC>*p+\<n\>Y`).
71
72 spacing=2
73 : PCL 4 spacing (`<ESC>*b\<n\>Y`).
74
75 spacing=3
76 : PCL 5 spacing (`<ESC>*b\<n\>Y` and clear seed row).
77
78 mode2
79 : Enable mode 2 graphics compression.
80
81 mode3
82 : Enable mode 3 graphics compression.
83
84 eog\_reset
85 : End of graphics (`<ESC>*rB)` resets all parameters.
86
87 has\_duplex
88 : Duplex supported (`<ESC>&l\<duplex\>S`).
89
90 has\_papersize
91 : Papersize setting supported (`<ESC>&l\<sizecode\>A`).
92
93 has\_copies
94 : Number of copies supported (`<ESC>&l\<copies\>X`).
95
96 is\_ljet4pjl
97 : Disable/Enable HP 4PJL model-specific output.
98
99 is\_oce9050
100 : Disable/Enable Oce 9050 model-specific output.
101
102
103 ## PCLm output options
104
105 compression=none
106 : No compression (default).
107
108 compression=flate
109 : Flate compression.
110
111 strip-height=N
112 : Strip height (default 16).
113
114
115 ## PDF output options
116
117 See <a href="pdf-write-options.html">PDF Write Options</a>.
118
119 ## PWG output options
120
121 media\_class=\<string\>
122 : Set the media\_class field.
123
124 media\_color=\<string\>
125 : Set the media\_color field.
126
127 media\_type=\<string\>
128 : Set the media\_type field.
129
130 output\_type=\<string\>
131 : Set the output\_type field.
132
133 rendering\_intent=\<string\>
134 : Set the rendering\_intent field.
135
136 page\_size\_name=\<string\>
137 : Set the page\_size\_name field.
138
139 advance\_distance=\<int\>
140 : Set the advance\_distance field.
141
142 advance\_media=\<int\>
143 : Set the advance\_media field.
144
145 collate=\<int\>
146 : Set the collate field.
147
148 cut\_media=\<int\>
149 : Set the cut\_media field.
150
151 duplex=\<int\>
152 : Set the duplex field.
153
154 insert\_sheet=\<int\>
155 : Set the insert\_sheet field.
156
157 jog=\<int\>
158 : Set the jog field.
159
160 leading\_edge=\<int\>
161 : Set the leading\_edge field.
162
163 manual\_feed=\<int\>
164 : Set the manual\_feed field.
165
166 media\_position=\<int\>
167 : Set the media\_position field.
168
169 media\_weight=\<int\>
170 : Set the media\_weight field.
171
172 mirror\_print=\<int\>
173 : Set the mirror\_print field.
174
175 negative\_print=\<int\>
176 : Set the negative\_print field.
177
178 num\_copies=\<int\>
179 : Set the num\_copies field.
180
181 orientation=\<int\>
182 : Set the orientation field.
183
184 output\_face\_up=\<int\>
185 : Set the output\_face\_up field.
186
187 page\_size\_x=\<int\>
188 : Set the page\_size\_x field.
189
190 page\_size\_y=\<int\>
191 : Set the page\_size\_y field.
192
193 separations=\<int\>
194 : Set the separations field.
195
196 tray\_switch=\<int\>
197 : Set the tray\_switch field.
198
199 tumble=\<int\>
200 : Set the tumble field.
201
202 media\_type\_num=\<int\>
203 : Set the media\_type\_num field.
204
205 compression=\<int\>
206 : Set the compression field.
207
208 row\_count=\<int\>
209 : Set the row\_count field.
210
211 row\_feed=\<int\>
212 : Set the row\_feed field.
213
214 row\_step=\<int\>
215 : Set the row\_step field.
216
217
218 ## SVG output options
219
220 text=text
221 : Emit text as \<text\> elements (inaccurate fonts).
222
223 text=path
224 : Emit text as \<path\> elements (accurate fonts).
225
226 no-reuse-images
227 : Do not reuse images using \<symbol\> definitions.
228
229
230 ## Text output options
231
232 See <a href="stext-options.html">Structured Text Options</a>.