Debian Codegraph @

man-pages/man1/ebook-convert.1

raw
1 .\" Man page generated from reStructuredText
2 .\" by the Docutils 0.22.4 manpage writer.
3 .
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .TH "EBOOK-CONVERT" "1" "September 18, 2026" "9.15.0" "calibre"
32 .SH NAME
33 ebook-convert \- ebook-convert
34 .INDENT 0.0
35 .INDENT 3.5
36 .sp
37 .EX
38 ebook\-convert input_file output_file [options]
39 .EE
40 .UNINDENT
41 .UNINDENT
42 .sp
43 Convert an e\-book from one format to another.
44 .sp
45 input_file is the input and output_file is the output. Both must be specified as the first two arguments to the command.
46 .sp
47 The output e\-book format is guessed from the file extension of output_file. output_file can also be of the special format .EXT where EXT is the output file extension. In this case, the name of the output file is derived from the name of the input file. Note that the filenames must not start with a hyphen. Finally, if output_file has no extension, then it is treated as a folder and an \(dqopen e\-book\(dq (OEB) consisting of HTML files is written to that folder. These files are the files that would normally have been passed to the output plugin.
48 .sp
49 After specifying the input and output file you can customize the conversion by specifying various options. The available options depend on the input and output file types. To get help on them specify the input and output file and then use the \-h option.
50 .sp
51 For full documentation of the conversion system see
52 E\-book conversion \%<#\:conversion>
53 .sp
54 Whenever you pass arguments to \fBebook\-convert\fP that have spaces in them, enclose the arguments in quotation marks. For example: \(dq/some path/with spaces\(dq
55 .sp
56 The options and default values for the options change depending on both the
57 input and output formats, so you should always check with:
58 .INDENT 0.0
59 .INDENT 3.5
60 .sp
61 .EX
62 ebook\-convert myfile.input_format myfile.output_format \-h
63 .EE
64 .UNINDENT
65 .UNINDENT
66 .sp
67 Below are the options that are common to all conversion, followed by the
68 options specific to every input and output format.
69 .INDENT 0.0
70 .IP \(bu 2
71 Look and Feel
72 .IP \(bu 2
73 Heuristic Processing
74 .IP \(bu 2
75 Search and Replace
76 .IP \(bu 2
77 Structure Detection
78 .IP \(bu 2
79 Table of Contents
80 .IP \(bu 2
81 Metadata
82 .IP \(bu 2
83 Debug
84 .IP \(bu 2
85 AZW4 Input Options
86 .IP \(bu 2
87 CHM Input Options
88 .IP \(bu 2
89 Comic Input Options
90 .IP \(bu 2
91 DJVU Input Options
92 .IP \(bu 2
93 DOCX Input Options
94 .IP \(bu 2
95 EPUB Input Options
96 .IP \(bu 2
97 FB2 Input Options
98 .IP \(bu 2
99 HTLZ Input Options
100 .IP \(bu 2
101 HTML Input Options
102 .IP \(bu 2
103 LIT Input Options
104 .IP \(bu 2
105 LRF Input Options
106 .IP \(bu 2
107 MOBI Input Options
108 .IP \(bu 2
109 ODT Input Options
110 .IP \(bu 2
111 PDB Input Options
112 .IP \(bu 2
113 PDF Input Options
114 .IP \(bu 2
115 PML Input Options
116 .IP \(bu 2
117 RB Input Options
118 .IP \(bu 2
119 RTF Input Options
120 .IP \(bu 2
121 Recipe Input Options
122 .IP \(bu 2
123 SNB Input Options
124 .IP \(bu 2
125 TCR Input Options
126 .IP \(bu 2
127 TXT Input Options
128 .IP \(bu 2
129 AZW3 Output Options
130 .IP \(bu 2
131 DOCX Output Options
132 .IP \(bu 2
133 EPUB Output Options
134 .IP \(bu 2
135 FB2 Output Options
136 .IP \(bu 2
137 HTML Output Options
138 .IP \(bu 2
139 HTMLZ Output Options
140 .IP \(bu 2
141 KEPUB Output Options
142 .IP \(bu 2
143 LIT Output Options
144 .IP \(bu 2
145 LRF Output Options
146 .IP \(bu 2
147 MOBI Output Options
148 .IP \(bu 2
149 OEB Output Options
150 .IP \(bu 2
151 PDB Output Options
152 .IP \(bu 2
153 PDF Output Options
154 .IP \(bu 2
155 PML Output Options
156 .IP \(bu 2
157 RB Output Options
158 .IP \(bu 2
159 RTF Output Options
160 .IP \(bu 2
161 SNB Output Options
162 .IP \(bu 2
163 TCR Output Options
164 .IP \(bu 2
165 TXT Output Options
166 .IP \(bu 2
167 TXTZ Output Options
168 .UNINDENT
169 .INDENT 0.0
170 .TP
171 .B \-\-help, \-h
172 show this help message and exit
173 .UNINDENT
174 .INDENT 0.0
175 .TP
176 .B \-\-input\-profile
177 Specify the input profile. The input profile gives the conversion system information on how to interpret various information in the input document. For example resolution dependent lengths (i.e. lengths in pixels). Choices are: cybookg3, cybook_opus, default, hanlinv3, hanlinv5, illiad, irexdr1000, irexdr800, kindle, msreader, mobipocket, nook, sony, sony300, sony900
178 .UNINDENT
179 .INDENT 0.0
180 .TP
181 .B \-\-list\-recipes
182 List builtin recipe names. You can create an e\-book from a builtin recipe like this: ebook\-convert \fB\(dq\fPRecipe Name.recipe\fB\(dq\fP output.epub
183 .UNINDENT
184 .INDENT 0.0
185 .TP
186 .B \-\-output\-profile
187 Specify the output profile. The output profile tells the conversion system how to optimize the created document for the specified device. In some cases, an output profile can be used to optimize the output for a particular device, but this is rarely necessary. Choices are:cybookg3, cybook_opus, default, generic_eink, generic_eink_hd, generic_eink_large, hanlinv3, hanlinv5, illiad, ipad, ipad3, irexdr1000, irexdr800, jetbook5, kindle, kindle_dx, kindle_fire, kindle_oasis, kindle_pw, kindle_pw3, kindle_scribe, kindle_voyage, kobo, msreader, mobipocket, nook, nook_color, nook_hd_plus, pocketbook_inkpad3, pocketbook_lux, pocketbook_hd, pocketbook_900, pocketbook_pro_912, galaxy, sony, sony300, sony900, sony\-landscape, sonyt3, tablet
188 .UNINDENT
189 .INDENT 0.0
190 .TP
191 .B \-\-version
192 show program\fB\(aq\fPs version number and exit
193 .UNINDENT
194 .SH LOOK AND FEEL
195 .sp
196 Options to control the look and feel of the output
197 .INDENT 0.0
198 .TP
199 .B \-\-asciiize
200 Transliterate Unicode characters to an ASCII representation. Use with care because this will replace Unicode characters with ASCII. For instance it will replace \fB\(dq\fPPelé\fB\(dq\fP with \fB\(dq\fPPele\fB\(dq\fP\&. Also, note that in cases where there are multiple representations of a character (characters shared by Chinese and Japanese for instance) the representation based on the current calibre interface language will be used.
201 .UNINDENT
202 .INDENT 0.0
203 .TP
204 .B \-\-base\-font\-size
205 The base font size in pts. All font sizes in the produced book will be rescaled based on this size. By choosing a larger size you can make the fonts in the output bigger and vice versa. By default, when the value is zero, the base font size is chosen based on the output profile you chose.
206 .UNINDENT
207 .INDENT 0.0
208 .TP
209 .B \-\-change\-justification
210 Change text justification. A value of \fB\(dq\fPleft\fB\(dq\fP converts all justified text in the source to left aligned (i.e. unjustified) text. A value of \fB\(dq\fPjustify\fB\(dq\fP converts all unjustified text to justified. A value of \fB\(dq\fPoriginal\fB\(dq\fP (the default) does not change justification in the source file. Note that only some output formats support justification.
211 .UNINDENT
212 .INDENT 0.0
213 .TP
214 .B \-\-disable\-font\-rescaling
215 Disable all rescaling of font sizes.
216 .UNINDENT
217 .INDENT 0.0
218 .TP
219 .B \-\-embed\-all\-fonts
220 Embed every font that is referenced in the input document but not already embedded. This will search your system for the fonts, and if found, they will be embedded. Embedding will only work if the format you are converting to supports embedded fonts, such as EPUB, AZW3, DOCX or PDF. Please ensure that you have the proper license for embedding the fonts used in this document.
221 .UNINDENT
222 .INDENT 0.0
223 .TP
224 .B \-\-embed\-font\-family
225 Embed the specified font family into the book. This specifies the \fB\(dq\fPbase\fB\(dq\fP font used for the book. If the input document specifies its own fonts, they may override this base font. You can use the filter style information option to remove fonts from the input document. Note that font embedding only works with some output formats, principally EPUB, AZW3 and DOCX.
226 .UNINDENT
227 .INDENT 0.0
228 .TP
229 .B \-\-expand\-css
230 By default, calibre will use the shorthand form for various CSS properties such as margin, padding, border, etc. This option will cause it to use the full expanded form instead. Note that CSS is always expanded when generating EPUB files with the output profile set to one of the Nook profiles as the Nook cannot handle shorthand CSS.
231 .UNINDENT
232 .INDENT 0.0
233 .TP
234 .B \-\-extra\-css
235 Either the path to a CSS stylesheet or raw CSS. This CSS will be appended to the style rules from the source file, so it can be used to override those rules.
236 .UNINDENT
237 .INDENT 0.0
238 .TP
239 .B \-\-filter\-css
240 A comma separated list of CSS properties that will be removed from all CSS style rules. This is useful if the presence of some style information prevents it from being overridden on your device. For example: font\-family,color,margin\-left,margin\-right
241 .UNINDENT
242 .INDENT 0.0
243 .TP
244 .B \-\-font\-size\-mapping
245 Mapping from CSS font names to font sizes in pts. An example setting is 12,12,14,16,18,20,22,24. These are the mappings for the sizes xx\-small to xx\-large, with the final size being for huge fonts. The font rescaling algorithm uses these sizes to intelligently rescale fonts. The default is to use a mapping based on the output profile you chose.
246 .UNINDENT
247 .INDENT 0.0
248 .TP
249 .B \-\-insert\-blank\-line
250 Insert a blank line between paragraphs. Will not work if the source file does not use paragraphs (<p> or <div> tags).
251 .UNINDENT
252 .INDENT 0.0
253 .TP
254 .B \-\-insert\-blank\-line\-size
255 Set the height of the inserted blank lines (in em). The height of the lines between paragraphs will be twice the value set here.
256 .UNINDENT
257 .INDENT 0.0
258 .TP
259 .B \-\-keep\-ligatures
260 Preserve ligatures present in the input document. A ligature is a combined character of a pair of characters like ff, fi, fl et cetera. Most readers do not have support for ligatures in their default fonts, so they are unlikely to render correctly. By default, calibre will turn a ligature into the corresponding pair of normal characters. Note that ligatures here mean only unicode ligatures not ligatures created via CSS or font styles. This option will preserve them instead.
261 .UNINDENT
262 .INDENT 0.0
263 .TP
264 .B \-\-line\-height
265 The line height in pts. Controls spacing between consecutive lines of text. Only applies to elements that do not define their own line height. In most cases, the minimum line height option is more useful. By default no line height manipulation is performed.
266 .UNINDENT
267 .INDENT 0.0
268 .TP
269 .B \-\-linearize\-tables
270 Some badly designed documents use tables to control the layout of text on the page. When converted these documents often have text that runs off the page and other artifacts. This option will extract the content from the tables and present it in a linear fashion.
271 .UNINDENT
272 .INDENT 0.0
273 .TP
274 .B \-\-margin\-bottom
275 Set the bottom margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
276 .UNINDENT
277 .INDENT 0.0
278 .TP
279 .B \-\-margin\-left
280 Set the left margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
281 .UNINDENT
282 .INDENT 0.0
283 .TP
284 .B \-\-margin\-right
285 Set the right margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
286 .UNINDENT
287 .INDENT 0.0
288 .TP
289 .B \-\-margin\-top
290 Set the top margin in pts. Default is 5.0. Setting this to less than zero will cause no margin to be set (the margin setting in the original document will be preserved). Note: Page oriented formats such as PDF and DOCX have their own margin settings that take precedence.
291 .UNINDENT
292 .INDENT 0.0
293 .TP
294 .B \-\-minimum\-line\-height
295 The minimum line height, as a percentage of the element\fB\(aq\fPs calculated font size. calibre will ensure that every element has a line height of at least this setting, irrespective of what the input document specifies. Set to zero to disable. Default is 120%. Use this setting in preference to the direct line height specification, unless you know what you are doing. For example, you can achieve \fB\(dq\fPdouble spaced\fB\(dq\fP text by setting this to 240.
296 .UNINDENT
297 .INDENT 0.0
298 .TP
299 .B \-\-remove\-paragraph\-spacing
300 Remove spacing between paragraphs. Also sets an indent on paragraphs of 1.5em. Spacing removal will not work if the source file does not use paragraphs (<p> or <div> tags).
301 .UNINDENT
302 .INDENT 0.0
303 .TP
304 .B \-\-remove\-paragraph\-spacing\-indent\-size
305 When calibre removes blank lines between paragraphs, it automatically sets a paragraph indent, to ensure that paragraphs can be easily distinguished. This option controls the width of that indent (in em). If you set this value negative, then the indent specified in the input document is used, that is, calibre does not change the indentation.
306 .UNINDENT
307 .INDENT 0.0
308 .TP
309 .B \-\-smarten\-punctuation
310 Convert plain quotes, dashes and ellipsis to their typographically correct equivalents. For details, see: \%<https://\:daringfireball\:.net/\:projects/\:smartypants>\&.
311 .UNINDENT
312 .INDENT 0.0
313 .TP
314 .B \-\-subset\-embedded\-fonts
315 Subset all embedded fonts. Every embedded font is reduced to contain only the glyphs used in this document. This decreases the size of the font files. Useful if you are embedding a particularly large font with lots of unused glyphs.
316 .UNINDENT
317 .INDENT 0.0
318 .TP
319 .B \-\-transform\-css\-rules
320 Path to a file containing rules to transform the CSS styles in this book. The easiest way to create such a file is to use the wizard for creating rules in the calibre GUI. Access it in the \fB\(dq\fPLook & feel\->Transform styles\fB\(dq\fP section of the conversion dialog. Once you create the rules, you can use the \fB\(dq\fPExport\fB\(dq\fP button to save them to a file.
321 .UNINDENT
322 .INDENT 0.0
323 .TP
324 .B \-\-transform\-html\-rules
325 Path to a file containing rules to transform the HTML in this book. The easiest way to create such a file is to use the wizard for creating rules in the calibre GUI. Access it in the \fB\(dq\fPLook & feel\->Transform HTML\fB\(dq\fP section of the conversion dialog. Once you create the rules, you can use the \fB\(dq\fPExport\fB\(dq\fP button to save them to a file.
326 .UNINDENT
327 .INDENT 0.0
328 .TP
329 .B \-\-unsmarten\-punctuation
330 Convert fancy quotes, dashes and ellipsis to their plain equivalents.
331 .UNINDENT
332 .SH HEURISTIC PROCESSING
333 .sp
334 Modify the document text and structure using common patterns. Disabled by default. Use \-\-enable\-heuristics to enable. Individual actions can be disabled with the \-\-disable\-* options.
335 .INDENT 0.0
336 .TP
337 .B \-\-disable\-dehyphenate
338 Analyze hyphenated words throughout the document. The document itself is used as a dictionary to determine whether hyphens should be retained or removed.
339 .UNINDENT
340 .INDENT 0.0
341 .TP
342 .B \-\-disable\-delete\-blank\-paragraphs
343 Remove empty paragraphs from the document when they exist between every other paragraph
344 .UNINDENT
345 .INDENT 0.0
346 .TP
347 .B \-\-disable\-fix\-indents
348 Turn indentation created from multiple non\-breaking space entities into CSS indents.
349 .UNINDENT
350 .INDENT 0.0
351 .TP
352 .B \-\-disable\-format\-scene\-breaks
353 Left aligned scene break markers are center aligned. Replace soft scene breaks that use multiple blank lines with horizontal rules.
354 .UNINDENT
355 .INDENT 0.0
356 .TP
357 .B \-\-disable\-italicize\-common\-cases
358 Look for common words and patterns that denote italics and italicize them.
359 .UNINDENT
360 .INDENT 0.0
361 .TP
362 .B \-\-disable\-markup\-chapter\-headings
363 Detect unformatted chapter headings and sub headings. Change them to h2 and h3 tags. This setting will not create a TOC, but can be used in conjunction with structure detection to create one.
364 .UNINDENT
365 .INDENT 0.0
366 .TP
367 .B \-\-disable\-renumber\-headings
368 Looks for occurrences of sequential <h1> or <h2> tags. The tags are renumbered to prevent splitting in the middle of chapter headings.
369 .UNINDENT
370 .INDENT 0.0
371 .TP
372 .B \-\-disable\-unwrap\-lines
373 Unwrap lines using punctuation and other formatting clues.
374 .UNINDENT
375 .INDENT 0.0
376 .TP
377 .B \-\-enable\-heuristics
378 Enable heuristic processing. This option must be set for any heuristic processing to take place.
379 .UNINDENT
380 .INDENT 0.0
381 .TP
382 .B \-\-html\-unwrap\-factor
383 Scale used to determine the length at which a line should be unwrapped. Valid values are a decimal between 0 and 1. The default is 0.4, just below the median line length. If only a few lines in the document require unwrapping this value should be reduced
384 .UNINDENT
385 .INDENT 0.0
386 .TP
387 .B \-\-replace\-scene\-breaks
388 Replace scene breaks with the specified text. By default, the text from the input document is used.
389 .UNINDENT
390 .SH SEARCH AND REPLACE
391 .sp
392 Modify the document text and structure using user defined patterns.
393 .INDENT 0.0
394 .TP
395 .B \-\-search\-replace
396 Path to a file containing search and replace regular expressions. The file must contain alternating lines of regular expression followed by replacement pattern (which can be an empty line). The regular expression must be in the Python regex syntax and the file must be UTF\-8 encoded.
397 .UNINDENT
398 .INDENT 0.0
399 .TP
400 .B \-\-sr1\-replace
401 Replacement to replace the text found with sr1\-search.
402 .UNINDENT
403 .INDENT 0.0
404 .TP
405 .B \-\-sr1\-search
406 Search pattern (regular expression) to be replaced with sr1\-replace.
407 .UNINDENT
408 .INDENT 0.0
409 .TP
410 .B \-\-sr2\-replace
411 Replacement to replace the text found with sr2\-search.
412 .UNINDENT
413 .INDENT 0.0
414 .TP
415 .B \-\-sr2\-search
416 Search pattern (regular expression) to be replaced with sr2\-replace.
417 .UNINDENT
418 .INDENT 0.0
419 .TP
420 .B \-\-sr3\-replace
421 Replacement to replace the text found with sr3\-search.
422 .UNINDENT
423 .INDENT 0.0
424 .TP
425 .B \-\-sr3\-search
426 Search pattern (regular expression) to be replaced with sr3\-replace.
427 .UNINDENT
428 .SH STRUCTURE DETECTION
429 .sp
430 Control auto\-detection of document structure.
431 .INDENT 0.0
432 .TP
433 .B \-\-add\-alt\-text\-to\-img
434 When an <img> tag has no alt attribute, check the associated image file for metadata that specifies alternate text, and use it to fill in the alt attribute. The alt attribute improves accessibility by providing text descriptions for users who cannot see or fully interpret visual content.
435 .UNINDENT
436 .INDENT 0.0
437 .TP
438 .B \-\-chapter
439 An XPath expression to detect chapter titles. The default is to consider <h1> or <h2> tags that contain the words \fB\(dq\fPchapter\fB\(dq\fP, \fB\(dq\fPbook\fB\(dq\fP, \fB\(dq\fPsection\fB\(dq\fP, \fB\(dq\fPprologue\fB\(dq\fP, \fB\(dq\fPepilogue\fB\(dq\fP or \fB\(dq\fPpart\fB\(dq\fP as chapter titles as well as any tags that have class=\fB\(dq\fPchapter\fB\(dq\fP\&. The expression used must evaluate to a list of elements. To disable chapter detection, use the expression \fB\(dq\fP/\fB\(dq\fP\&. See the XPath Tutorial in the calibre User Manual for further help on using this feature.
440 .UNINDENT
441 .INDENT 0.0
442 .TP
443 .B \-\-chapter\-mark
444 Specify how to mark detected chapters. A value of \fB\(dq\fPpagebreak\fB\(dq\fP will insert page breaks before chapters. A value of \fB\(dq\fPrule\fB\(dq\fP will insert a line before chapters. A value of \fB\(dq\fPnone\fB\(dq\fP will disable chapter marking and a value of \fB\(dq\fPboth\fB\(dq\fP will use both page breaks and lines to mark chapters.
445 .UNINDENT
446 .INDENT 0.0
447 .TP
448 .B \-\-disable\-remove\-fake\-margins
449 Some documents specify page margins by specifying a left and right margin on each individual paragraph. calibre will try to detect and remove these margins. Sometimes, this can cause the removal of margins that should not have been removed. In this case you can disable the removal.
450 .UNINDENT
451 .INDENT 0.0
452 .TP
453 .B \-\-insert\-metadata
454 Insert the book metadata at the start of the book. This is useful if your e\-book reader does not support displaying/searching metadata directly.
455 .UNINDENT
456 .INDENT 0.0
457 .TP
458 .B \-\-page\-breaks\-before
459 An XPath expression. Page breaks are inserted before the specified elements. To disable use the expression: /
460 .UNINDENT
461 .INDENT 0.0
462 .TP
463 .B \-\-prefer\-metadata\-cover
464 Use the cover detected from the source file in preference to the specified cover.
465 .UNINDENT
466 .INDENT 0.0
467 .TP
468 .B \-\-remove\-first\-image
469 Remove the first image from the input e\-book. Useful if the input document has a cover image that is not identified as a cover. In this case, if you set a cover in calibre, the output document will end up with two cover images if you do not specify this option.
470 .UNINDENT
471 .INDENT 0.0
472 .TP
473 .B \-\-start\-reading\-at
474 An XPath expression to detect the location in the document at which to start reading. Some e\-book reading programs (most prominently the Kindle) use this location as the position at which to open the book. See the XPath tutorial in the calibre User Manual for further help using this feature.
475 .UNINDENT
476 .SH TABLE OF CONTENTS
477 .sp
478 Control the automatic generation of a Table of Contents. By default, if the source file has a Table of Contents, it will be used in preference to the automatically generated one.
479 .INDENT 0.0
480 .TP
481 .B \-\-duplicate\-links\-in\-toc
482 When creating a TOC from links in the input document, allow duplicate entries, i.e. allow more than one entry with the same text, provided that they point to a different location.
483 .UNINDENT
484 .INDENT 0.0
485 .TP
486 .B \-\-level1\-toc
487 XPath expression that specifies all tags that should be added to the Table of Contents at level one. If this is specified, it takes precedence over other forms of auto\-detection. See the XPath Tutorial in the calibre User Manual for examples.
488 .UNINDENT
489 .INDENT 0.0
490 .TP
491 .B \-\-level2\-toc
492 XPath expression that specifies all tags that should be added to the Table of Contents at level two. Each entry is added under the previous level one entry. See the XPath Tutorial in the calibre User Manual for examples.
493 .UNINDENT
494 .INDENT 0.0
495 .TP
496 .B \-\-level3\-toc
497 XPath expression that specifies all tags that should be added to the Table of Contents at level three. Each entry is added under the previous level two entry. See the XPath Tutorial in the calibre User Manual for examples.
498 .UNINDENT
499 .INDENT 0.0
500 .TP
501 .B \-\-max\-toc\-links
502 Maximum number of links to insert into the TOC. Set to 0 to disable. Default is: 50. Links are only added to the TOC if less than the threshold number of chapters were detected.
503 .UNINDENT
504 .INDENT 0.0
505 .TP
506 .B \-\-no\-chapters\-in\-toc
507 Don\fB\(aq\fPt add auto\-detected chapters to the Table of Contents.
508 .UNINDENT
509 .INDENT 0.0
510 .TP
511 .B \-\-toc\-filter
512 Remove entries from the Table of Contents whose titles match the specified regular expression. Matching entries and all their children are removed.
513 .UNINDENT
514 .INDENT 0.0
515 .TP
516 .B \-\-toc\-threshold
517 If fewer than this number of chapters is detected, then links are added to the Table of Contents. Default: 6
518 .UNINDENT
519 .INDENT 0.0
520 .TP
521 .B \-\-use\-auto\-toc
522 Normally, if the source file already has a Table of Contents, it is used in preference to the auto\-generated one. With this option, the auto\-generated one is always used.
523 .UNINDENT
524 .SH METADATA
525 .sp
526 Options to set metadata in the output
527 .INDENT 0.0
528 .TP
529 .B \-\-author\-sort
530 String to be used when sorting by author.
531 .UNINDENT
532 .INDENT 0.0
533 .TP
534 .B \-\-authors
535 Set the authors. Multiple authors should be separated by ampersands.
536 .UNINDENT
537 .INDENT 0.0
538 .TP
539 .B \-\-book\-producer
540 Set the book producer.
541 .UNINDENT
542 .INDENT 0.0
543 .TP
544 .B \-\-comments
545 Set the e\-book description.
546 .UNINDENT
547 .INDENT 0.0
548 .TP
549 .B \-\-cover
550 Set the cover to the specified file or URL
551 .UNINDENT
552 .INDENT 0.0
553 .TP
554 .B \-\-isbn
555 Set the ISBN of the book.
556 .UNINDENT
557 .INDENT 0.0
558 .TP
559 .B \-\-language
560 Set the language.
561 .UNINDENT
562 .INDENT 0.0
563 .TP
564 .B \-\-pubdate
565 Set the publication date (assumed to be in the local timezone, unless the timezone is explicitly specified)
566 .UNINDENT
567 .INDENT 0.0
568 .TP
569 .B \-\-publisher
570 Set the e\-book publisher.
571 .UNINDENT
572 .INDENT 0.0
573 .TP
574 .B \-\-rating
575 Set the rating. Should be a number between 1 and 5.
576 .UNINDENT
577 .INDENT 0.0
578 .TP
579 .B \-\-read\-metadata\-from\-opf, \-\-from\-opf, \-m
580 Read metadata from the specified OPF file. Metadata read from this file will override any metadata in the source file.
581 .UNINDENT
582 .INDENT 0.0
583 .TP
584 .B \-\-series
585 Set the series this e\-book belongs to.
586 .UNINDENT
587 .INDENT 0.0
588 .TP
589 .B \-\-series\-index
590 Set the index of the book in this series.
591 .UNINDENT
592 .INDENT 0.0
593 .TP
594 .B \-\-tags
595 Set the tags for the book. Should be a comma separated list.
596 .UNINDENT
597 .INDENT 0.0
598 .TP
599 .B \-\-timestamp
600 Set the book timestamp (no longer used anywhere)
601 .UNINDENT
602 .INDENT 0.0
603 .TP
604 .B \-\-title
605 Set the title.
606 .UNINDENT
607 .INDENT 0.0
608 .TP
609 .B \-\-title\-sort
610 The version of the title to be used for sorting.
611 .UNINDENT
612 .SH DEBUG
613 .sp
614 Options to help with debugging the conversion
615 .INDENT 0.0
616 .TP
617 .B \-\-debug\-pipeline, \-d
618 Save the output from different stages of the conversion pipeline to the specified folder. Useful if you are unsure at which stage of the conversion process a bug is occurring.
619 .UNINDENT
620 .INDENT 0.0
621 .TP
622 .B \-\-verbose, \-v
623 Level of verbosity. Specify multiple times for greater verbosity. Specifying it twice will result in full verbosity, once medium verbosity and zero times least verbosity.
624 .UNINDENT
625 .SH AZW4 INPUT OPTIONS
626 .INDENT 0.0
627 .TP
628 .B \-\-input\-encoding
629 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
630 .UNINDENT
631 .SH CHM INPUT OPTIONS
632 .INDENT 0.0
633 .TP
634 .B \-\-input\-encoding
635 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
636 .UNINDENT
637 .SH COMIC INPUT OPTIONS
638 .INDENT 0.0
639 .TP
640 .B \-\-colors
641 Reduce the number of colors used in the image. This works only if you choose the PNG output format. It is useful to reduce file sizes. Set to zero to turn off. Maximum value is 256. It is off by default.
642 .UNINDENT
643 .INDENT 0.0
644 .TP
645 .B \-\-comic\-image\-size
646 Specify the image size as width x height pixels, for example: 123x321. Normally, an image size is automatically calculated from the output profile, this option overrides it.
647 .UNINDENT
648 .INDENT 0.0
649 .TP
650 .B \-\-despeckle
651 Enable Despeckle. Reduces speckle noise. May greatly increase processing time.
652 .UNINDENT
653 .INDENT 0.0
654 .TP
655 .B \-\-disable\-trim
656 Disable trimming of comic pages. For some comics, trimming might remove content as well as borders.
657 .UNINDENT
658 .INDENT 0.0
659 .TP
660 .B \-\-dont\-add\-comic\-pages\-to\-toc
661 When converting a CBC do not add links to each page to the TOC. Note this only applies if the TOC has more than one section
662 .UNINDENT
663 .INDENT 0.0
664 .TP
665 .B \-\-dont\-grayscale
666 Do not convert the image to grayscale (black and white)
667 .UNINDENT
668 .INDENT 0.0
669 .TP
670 .B \-\-dont\-normalize
671 Disable normalize (improve contrast) color range for pictures. Default: False
672 .UNINDENT
673 .INDENT 0.0
674 .TP
675 .B \-\-dont\-sharpen
676 Disable sharpening.
677 .UNINDENT
678 .INDENT 0.0
679 .TP
680 .B \-\-input\-encoding
681 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
682 .UNINDENT
683 .INDENT 0.0
684 .TP
685 .B \-\-keep\-aspect\-ratio
686 Maintain picture aspect ratio. Default is to fill the screen.
687 .UNINDENT
688 .INDENT 0.0
689 .TP
690 .B \-\-landscape
691 Don\fB\(aq\fPt split landscape images into two portrait images
692 .UNINDENT
693 .INDENT 0.0
694 .TP
695 .B \-\-no\-process
696 Apply no processing to the image
697 .UNINDENT
698 .INDENT 0.0
699 .TP
700 .B \-\-no\-sort
701 Don\fB\(aq\fPt sort the files found in the comic alphabetically by name. Instead use the order they were added to the comic.
702 .UNINDENT
703 .INDENT 0.0
704 .TP
705 .B \-\-output\-format
706 The format that images in the created e\-book are converted to. You can experiment to see which format gives you optimal size and look on your device.
707 .UNINDENT
708 .INDENT 0.0
709 .TP
710 .B \-\-right2left
711 Used for right\-to\-left publications like manga. Causes landscape pages to be split into portrait pages from right to left.
712 .UNINDENT
713 .INDENT 0.0
714 .TP
715 .B \-\-wide
716 Keep aspect ratio and scale image using screen height as image width for viewing in landscape mode.
717 .UNINDENT
718 .SH DJVU INPUT OPTIONS
719 .INDENT 0.0
720 .TP
721 .B \-\-input\-encoding
722 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
723 .UNINDENT
724 .SH DOCX INPUT OPTIONS
725 .INDENT 0.0
726 .TP
727 .B \-\-docx\-inline\-subsup
728 Render superscripts and subscripts so that they do not affect the line height
729 .UNINDENT
730 .INDENT 0.0
731 .TP
732 .B \-\-docx\-no\-cover
733 Normally, if a large image is present at the start of the document that looks like a cover, it will be removed from the document and used as the cover for created e\-book. This option turns off that behavior.
734 .UNINDENT
735 .INDENT 0.0
736 .TP
737 .B \-\-docx\-no\-pagebreaks\-between\-notes
738 Do not insert a page break after every endnote.
739 .UNINDENT
740 .INDENT 0.0
741 .TP
742 .B \-\-input\-encoding
743 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
744 .UNINDENT
745 .SH EPUB INPUT OPTIONS
746 .INDENT 0.0
747 .TP
748 .B \-\-input\-encoding
749 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
750 .UNINDENT
751 .SH FB2 INPUT OPTIONS
752 .INDENT 0.0
753 .TP
754 .B \-\-input\-encoding
755 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
756 .UNINDENT
757 .INDENT 0.0
758 .TP
759 .B \-\-no\-inline\-fb2\-toc
760 Do not insert a Table of Contents at the beginning of the book
761 .UNINDENT
762 .SH HTLZ INPUT OPTIONS
763 .INDENT 0.0
764 .TP
765 .B \-\-input\-encoding
766 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
767 .UNINDENT
768 .SH HTML INPUT OPTIONS
769 .INDENT 0.0
770 .TP
771 .B \-\-allow\-local\-files\-outside\-root
772 Normally, resources linked to by the HTML file or its children will only be allowed if they are in a sub\-folder of the original HTML file. This option allows including local files from any location on your computer. This can be a security risk if you are converting untrusted HTML and expecting to distribute the result of the conversion.
773 .UNINDENT
774 .INDENT 0.0
775 .TP
776 .B \-\-breadth\-first
777 Traverse links in HTML files breadth first. Normally, they are traversed depth first.
778 .UNINDENT
779 .INDENT 0.0
780 .TP
781 .B \-\-dont\-package
782 Normally this input plugin re\-arranges all the input files into a standard folder hierarchy. Only use this option if you know what you are doing as it can result in various nasty side effects in the rest of the conversion pipeline.
783 .UNINDENT
784 .INDENT 0.0
785 .TP
786 .B \-\-input\-encoding
787 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
788 .UNINDENT
789 .INDENT 0.0
790 .TP
791 .B \-\-max\-levels
792 Maximum levels of recursion when following links in HTML files. Must be non\-negative. 0 implies that no links in the root HTML file are followed. Default is 5.
793 .UNINDENT
794 .SH LIT INPUT OPTIONS
795 .INDENT 0.0
796 .TP
797 .B \-\-input\-encoding
798 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
799 .UNINDENT
800 .SH LRF INPUT OPTIONS
801 .INDENT 0.0
802 .TP
803 .B \-\-input\-encoding
804 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
805 .UNINDENT
806 .SH MOBI INPUT OPTIONS
807 .INDENT 0.0
808 .TP
809 .B \-\-input\-encoding
810 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
811 .UNINDENT
812 .SH ODT INPUT OPTIONS
813 .INDENT 0.0
814 .TP
815 .B \-\-input\-encoding
816 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
817 .UNINDENT
818 .SH PDB INPUT OPTIONS
819 .INDENT 0.0
820 .TP
821 .B \-\-input\-encoding
822 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
823 .UNINDENT
824 .SH PDF INPUT OPTIONS
825 .INDENT 0.0
826 .TP
827 .B \-\-input\-encoding
828 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
829 .UNINDENT
830 .INDENT 0.0
831 .TP
832 .B \-\-no\-images
833 Do not extract images from the document
834 .UNINDENT
835 .INDENT 0.0
836 .TP
837 .B \-\-pdf\-engine
838 The PDF engine to use, the \fB\(dq\fPcalibre\fB\(dq\fP engine is recommended as it has automatic header and footer removal. Choices: calibre, pdftohtml
839 .UNINDENT
840 .INDENT 0.0
841 .TP
842 .B \-\-pdf\-footer\-regex
843 Regular expression to remove lines at the bottom of a page. This only looks at the last line of a page and works only with the calibre PDF engine.
844 .UNINDENT
845 .INDENT 0.0
846 .TP
847 .B \-\-pdf\-footer\-skip
848 Skip everything to the specified number of pixels at the bottom of a page. Negative numbers mean auto\-detect and remove footers, zero means do not remove footers and positive numbers mean remove footers that appear below that many pixels from the bottom of the page. Works only with the calibre PDF engine.
849 .UNINDENT
850 .INDENT 0.0
851 .TP
852 .B \-\-pdf\-header\-regex
853 Regular expression to remove lines at the top of a page. This only looks at the first line of a page and works only with the calibre PDF engine.
854 .UNINDENT
855 .INDENT 0.0
856 .TP
857 .B \-\-pdf\-header\-skip
858 Skip everything to the specified number of pixels at the top of a page. Negative numbers mean auto\-detect and remove headers, zero means do not remove headers and positive numbers mean remove headers that appear above that many pixels from the top of the page. Works only with the new PDF engine.
859 .UNINDENT
860 .INDENT 0.0
861 .TP
862 .B \-\-unwrap\-factor
863 Scale used to determine the length at which a line should be unwrapped. Valid values are a decimal between 0 and 1. The default is 0.45, just below the median line length.
864 .UNINDENT
865 .SH PML INPUT OPTIONS
866 .INDENT 0.0
867 .TP
868 .B \-\-input\-encoding
869 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
870 .UNINDENT
871 .SH RB INPUT OPTIONS
872 .INDENT 0.0
873 .TP
874 .B \-\-input\-encoding
875 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
876 .UNINDENT
877 .SH RTF INPUT OPTIONS
878 .INDENT 0.0
879 .TP
880 .B \-\-ignore\-wmf
881 Ignore WMF images instead of replacing them with a placeholder image.
882 .UNINDENT
883 .INDENT 0.0
884 .TP
885 .B \-\-input\-encoding
886 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
887 .UNINDENT
888 .SH RECIPE INPUT OPTIONS
889 .INDENT 0.0
890 .TP
891 .B \-\-dont\-download\-recipe
892 Do not download latest version of builtin recipes from the calibre server
893 .UNINDENT
894 .INDENT 0.0
895 .TP
896 .B \-\-input\-encoding
897 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
898 .UNINDENT
899 .INDENT 0.0
900 .TP
901 .B \-\-lrf
902 Optimize fetching for subsequent conversion to LRF.
903 .UNINDENT
904 .INDENT 0.0
905 .TP
906 .B \-\-password
907 Password for sites that require a login to access content.
908 .UNINDENT
909 .INDENT 0.0
910 .TP
911 .B \-\-recipe\-specific\-option
912 Recipe specific options. Syntax is option_name:value. For example: \fB\-\-recipe\-specific\-option\fP = \fBdate\fP:2030\-11\-31. Can be specified multiple times to set different options. To see a list of all available options for a recipe, use \fB\-\-recipe\-specific\-option\fP = \fBlist\fP\&.
913 .UNINDENT
914 .INDENT 0.0
915 .TP
916 .B \-\-test
917 Useful for recipe development. Forces max_articles_per_feed to 2 and downloads at most 2 feeds. You can change the number of feeds and articles by supplying optional arguments. For example: \fB\-\-test\fP 3 1 will download at most 3 feeds and only 1 article per feed.
918 .UNINDENT
919 .INDENT 0.0
920 .TP
921 .B \-\-username
922 Username for sites that require a login to access content.
923 .UNINDENT
924 .SH SNB INPUT OPTIONS
925 .INDENT 0.0
926 .TP
927 .B \-\-input\-encoding
928 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
929 .UNINDENT
930 .SH TCR INPUT OPTIONS
931 .INDENT 0.0
932 .TP
933 .B \-\-input\-encoding
934 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
935 .UNINDENT
936 .SH TXT INPUT OPTIONS
937 .INDENT 0.0
938 .TP
939 .B \-\-formatting\-type
940 Formatting used within the document. * auto: Automatically decide which formatting processor to use * plain: No formatting * heuristic: Use heuristics to determine chapter headings, italics, etc. * textile: Use the Textile markup language * markdown: Use the Markdown markup language To learn more about Markdown see \%<https://\:daringfireball\:.net/\:projects/\:markdown/>
941 .UNINDENT
942 .INDENT 0.0
943 .TP
944 .B \-\-input\-encoding
945 Specify the character encoding of the input document. If set this option will override any encoding declared by the document itself. Particularly useful for documents that do not declare an encoding or that have erroneous encoding declarations.
946 .UNINDENT
947 .INDENT 0.0
948 .TP
949 .B \-\-markdown\-extensions
950 Enable extensions to Markdown syntax. Extensions are formatting that is not part of the standard Markdown format. The extensions enabled by default: footnotes, tables, toc. To learn more about Markdown extensions, see \%<https://\:python-markdown\:.github\:.io/\:extensions/> This should be a comma separated list of extensions to enable: * abbr: Abbreviations * admonition: Support admonitions * attr_list: Add attribute to HTML tags * codehilite: Add code highlighting via Pygments * def_list: Definition lists * extra: Enables various common extensions * fenced_code: Alternative code block syntax * footnotes: Footnotes * legacy_attrs: Use legacy element attributes * legacy_em: Use legacy underscore handling for connected words * meta: Metadata in the document * nl2br: Treat newlines as hard breaks * sane_lists: Do not allow mixing list types * smarty: Use Markdown\fB\(aq\fPs internal smartypants parser * tables: Support tables * toc: Generate a table of contents * wikilinks: Wiki style links
951 .UNINDENT
952 .INDENT 0.0
953 .TP
954 .B \-\-paragraph\-type
955 Paragraph structure to assume. The value of \fB\(dq\fPoff\fB\(dq\fP is useful for formatted documents such as Markdown or Textile. Choices are: * auto: Try to auto detect paragraph type * block: Treat a blank line as a paragraph break * single: Assume every line is a paragraph * print: Assume every line starting with 2+ spaces or a tab starts a paragraph * unformatted: Most lines have hard line breaks, few/no blank lines or indents * off: Don\fB\(aq\fPt modify the paragraph structure
956 .UNINDENT
957 .INDENT 0.0
958 .TP
959 .B \-\-preserve\-spaces
960 Normally extra spaces are condensed into a single space. With this option all spaces will be displayed.
961 .UNINDENT
962 .INDENT 0.0
963 .TP
964 .B \-\-txt\-in\-remove\-indents
965 Normally extra space at the beginning of lines is retained. With this option they will be removed.
966 .UNINDENT
967 .SH AZW3 OUTPUT OPTIONS
968 .INDENT 0.0
969 .TP
970 .B \-\-dont\-compress
971 Disable compression of the file contents.
972 .UNINDENT
973 .INDENT 0.0
974 .TP
975 .B \-\-extract\-to
976 Extract the contents of the generated AZW3 file to the specified folder. The contents of the folder are first deleted, so be careful.
977 .UNINDENT
978 .INDENT 0.0
979 .TP
980 .B \-\-mobi\-toc\-at\-start
981 When adding the Table of Contents to the book, add it at the start of the book instead of the end. Not recommended.
982 .UNINDENT
983 .INDENT 0.0
984 .TP
985 .B \-\-no\-inline\-toc
986 Don\fB\(aq\fPt add Table of Contents to the book. Useful if the book has its own table of contents.
987 .UNINDENT
988 .INDENT 0.0
989 .TP
990 .B \-\-prefer\-author\-sort
991 When present, use author sort field as author.
992 .UNINDENT
993 .INDENT 0.0
994 .TP
995 .B \-\-pretty\-print
996 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
997 .UNINDENT
998 .INDENT 0.0
999 .TP
1000 .B \-\-share\-not\-sync
1001 Enable sharing of book content via Facebook etc. on the Kindle. WARNING: Using this feature means that the book will not auto sync its last read position on multiple devices. Complain to Amazon.
1002 .UNINDENT
1003 .INDENT 0.0
1004 .TP
1005 .B \-\-toc\-title
1006 Title for any generated inline table of contents.
1007 .UNINDENT
1008 .SH DOCX OUTPUT OPTIONS
1009 .INDENT 0.0
1010 .TP
1011 .B \-\-docx\-custom\-page\-size
1012 Custom size of the document. Use the form width x height, for example: \fI123x321\fP to specify the width and height (in pts). This overrides any specified page\-size.
1013 .UNINDENT
1014 .INDENT 0.0
1015 .TP
1016 .B \-\-docx\-no\-cover
1017 Do not insert the book cover as an image at the start of the document. If you use this option, the book cover will be discarded.
1018 .UNINDENT
1019 .INDENT 0.0
1020 .TP
1021 .B \-\-docx\-no\-toc
1022 Do not insert the table of contents as a page at the start of the document.
1023 .UNINDENT
1024 .INDENT 0.0
1025 .TP
1026 .B \-\-docx\-page\-margin\-bottom
1027 The size of the bottom page margin, in pts. Default is 72pt. Overrides the common bottom page margin setting, unless set to zero.
1028 .UNINDENT
1029 .INDENT 0.0
1030 .TP
1031 .B \-\-docx\-page\-margin\-left
1032 The size of the left page margin, in pts. Default is 72pt. Overrides the common left page margin setting.
1033 .UNINDENT
1034 .INDENT 0.0
1035 .TP
1036 .B \-\-docx\-page\-margin\-right
1037 The size of the right page margin, in pts. Default is 72pt. Overrides the common right page margin setting, unless set to zero.
1038 .UNINDENT
1039 .INDENT 0.0
1040 .TP
1041 .B \-\-docx\-page\-margin\-top
1042 The size of the top page margin, in pts. Default is 72pt. Overrides the common top page margin setting, unless set to zero.
1043 .UNINDENT
1044 .INDENT 0.0
1045 .TP
1046 .B \-\-docx\-page\-size
1047 The size of the page. Default is letter. Choices are [\fB\(aq\fPa0\fB\(aq\fP, \fB\(aq\fPa1\fB\(aq\fP, \fB\(aq\fPa2\fB\(aq\fP, \fB\(aq\fPa3\fB\(aq\fP, \fB\(aq\fPa4\fB\(aq\fP, \fB\(aq\fPa5\fB\(aq\fP, \fB\(aq\fPa6\fB\(aq\fP, \fB\(aq\fPb0\fB\(aq\fP, \fB\(aq\fPb1\fB\(aq\fP, \fB\(aq\fPb2\fB\(aq\fP, \fB\(aq\fPb3\fB\(aq\fP, \fB\(aq\fPb4\fB\(aq\fP, \fB\(aq\fPb5\fB\(aq\fP, \fB\(aq\fPb6\fB\(aq\fP, \fB\(aq\fPlegal\fB\(aq\fP, \fB\(aq\fPletter\fB\(aq\fP]
1048 .UNINDENT
1049 .INDENT 0.0
1050 .TP
1051 .B \-\-extract\-to
1052 Extract the contents of the generated DOCX file to the specified folder. The contents of the folder are first deleted, so be careful.
1053 .UNINDENT
1054 .INDENT 0.0
1055 .TP
1056 .B \-\-preserve\-cover\-aspect\-ratio
1057 Preserve the aspect ratio of the cover image instead of stretching it out to cover the entire page.
1058 .UNINDENT
1059 .INDENT 0.0
1060 .TP
1061 .B \-\-pretty\-print
1062 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1063 .UNINDENT
1064 .SH EPUB OUTPUT OPTIONS
1065 .INDENT 0.0
1066 .TP
1067 .B \-\-dont\-split\-on\-page\-breaks
1068 Turn off splitting at page breaks. Normally, input files are automatically split at every page break into two files. This gives an output e\-book that can be parsed faster and with less resources. However, splitting is slow and if your source file contains a very large number of page breaks, you should turn off splitting on page breaks.
1069 .UNINDENT
1070 .INDENT 0.0
1071 .TP
1072 .B \-\-epub\-flatten
1073 This option is needed only if you intend to use the EPUB with FBReaderJ. It will flatten the file system inside the EPUB, putting all files into the top level.
1074 .UNINDENT
1075 .INDENT 0.0
1076 .TP
1077 .B \-\-epub\-inline\-toc
1078 Insert an inline Table of Contents that will appear as part of the main book content.
1079 .UNINDENT
1080 .INDENT 0.0
1081 .TP
1082 .B \-\-epub\-max\-image\-size
1083 The maximum image size (width x height). A value of profile means use the screen size from the output profile. A value of none means no maximum size is specified. For example, a value of 100x200 will cause all images to be resized so that their width is no more than 100 pixels and their height is no more than 200 pixels. Note that this only affects the size of the actual image files themselves. Any given image may be rendered at a different size depending on the styling applied to it in the document.
1084 .UNINDENT
1085 .INDENT 0.0
1086 .TP
1087 .B \-\-epub\-toc\-at\-end
1088 Put the inserted inline Table of Contents at the end of the book instead of the start.
1089 .UNINDENT
1090 .INDENT 0.0
1091 .TP
1092 .B \-\-epub\-version
1093 The version of the EPUB file to generate. EPUB 2 is the most widely compatible, only use EPUB 3 if you know you actually need it.
1094 .UNINDENT
1095 .INDENT 0.0
1096 .TP
1097 .B \-\-extract\-to
1098 Extract the contents of the generated book to the specified folder. The contents of the folder are first deleted, so be careful.
1099 .UNINDENT
1100 .INDENT 0.0
1101 .TP
1102 .B \-\-flow\-size
1103 Split all HTML files larger than this size (in KB). This is necessary as most EPUB readers cannot handle large file sizes. The default of 260KB is the size required for Adobe Digital Editions. Set to 0 to disable size based splitting.
1104 .UNINDENT
1105 .INDENT 0.0
1106 .TP
1107 .B \-\-no\-default\-epub\-cover
1108 Normally, if the input file has no cover and you don\fB\(aq\fPt specify one, a default cover is generated with the title, authors, etc. This option disables the generation of this cover.
1109 .UNINDENT
1110 .INDENT 0.0
1111 .TP
1112 .B \-\-no\-svg\-cover
1113 Do not use SVG for the book cover. Use this option if your EPUB is going to be used on a device that does not support SVG, like the iPhone or the JetBook Lite. Without this option, such devices will display the cover as a blank page.
1114 .UNINDENT
1115 .INDENT 0.0
1116 .TP
1117 .B \-\-preserve\-cover\-aspect\-ratio
1118 When using an SVG cover, this option will cause the cover to scale to cover the available screen area, but still preserve its aspect ratio (ratio of width to height). That means there may be white borders at the sides or top and bottom of the image, but the image will never be distorted. Without this option the image may be slightly distorted, but there will be no borders.
1119 .UNINDENT
1120 .INDENT 0.0
1121 .TP
1122 .B \-\-pretty\-print
1123 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1124 .UNINDENT
1125 .INDENT 0.0
1126 .TP
1127 .B \-\-toc\-title
1128 Title for any generated inline table of contents.
1129 .UNINDENT
1130 .SH FB2 OUTPUT OPTIONS
1131 .INDENT 0.0
1132 .TP
1133 .B \-\-fb2\-genre
1134 Genre for the book. Choices: sf_history, sf_action, sf_epic, sf_heroic, sf_detective, sf_cyberpunk, sf_space, sf_social, sf_horror, sf_humor, sf_fantasy, sf, det_classic, det_police, det_action, det_irony, det_history, det_espionage, det_crime, det_political, det_maniac, det_hard, thriller, detective, prose_classic, prose_history, prose_contemporary, prose_counter, prose_rus_classic, prose_su_classics, love_contemporary, love_history, love_detective, love_short, love_erotica, adv_western, adv_history, adv_indian, adv_maritime, adv_geo, adv_animal, adventure, child_tale, child_verse, child_prose, child_sf, child_det, child_adv, child_education, children, poetry, dramaturgy, antique_ant, antique_european, antique_russian, antique_east, antique_myths, antique, sci_history, sci_psychology, sci_culture, sci_religion, sci_philosophy, sci_politics, sci_business, sci_juris, sci_linguistic, sci_medicine, sci_phys, sci_math, sci_chem, sci_biology, sci_tech, science, comp_www, comp_programming, comp_hard, comp_soft, comp_db, comp_osnet, computers, ref_encyc, ref_dict, ref_ref, ref_guide, reference, nonf_biography, nonf_publicism, nonf_criticism, design, nonfiction, religion_rel, religion_esoterics, religion_self, religion, humor_anecdote, humor_prose, humor_verse, humor, home_cooking, home_pets, home_crafts, home_entertain, home_health, home_garden, home_diy, home_sport, home_sex, home See: \%<http://\:www\:.fictionbook\:.org/\:index\:.php/\:Eng:FictionBook_2\:.1_genres> for a complete list with descriptions.
1135 .UNINDENT
1136 .INDENT 0.0
1137 .TP
1138 .B \-\-pretty\-print
1139 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1140 .UNINDENT
1141 .INDENT 0.0
1142 .TP
1143 .B \-\-sectionize
1144 Specify how sections are created: * nothing: A single section * files: Section per file * toc: Section per entry in the ToC If ToC based generation fails, adjust the \fB\(dq\fPStructure detection\fB\(dq\fP and/or \fB\(dq\fPTable of Contents\fB\(dq\fP settings (turn on \fB\(dq\fPForce use of auto\-generated Table of Contents\fB\(dq\fP).
1145 .UNINDENT
1146 .SH HTML OUTPUT OPTIONS
1147 .INDENT 0.0
1148 .TP
1149 .B \-\-extract\-to
1150 Extract the contents of the generated ZIP file to the specified folder. WARNING: The contents of the folder will be deleted.
1151 .UNINDENT
1152 .INDENT 0.0
1153 .TP
1154 .B \-\-pretty\-print
1155 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1156 .UNINDENT
1157 .INDENT 0.0
1158 .TP
1159 .B \-\-template\-css
1160 CSS file used for the output instead of the default CSS.
1161 .UNINDENT
1162 .INDENT 0.0
1163 .TP
1164 .B \-\-template\-html
1165 Template used for the generation of the HTML contents of the book instead of the default template. In Mustache format.
1166 .UNINDENT
1167 .INDENT 0.0
1168 .TP
1169 .B \-\-template\-html\-index
1170 Template used for generation of the HTML index file instead of the default template. In Mustache format.
1171 .UNINDENT
1172 .SH HTMLZ OUTPUT OPTIONS
1173 .INDENT 0.0
1174 .TP
1175 .B \-\-htmlz\-class\-style
1176 How to handle the CSS when using css\-type = \fB\(aq\fPclass\fB\(aq\fP\&. Default is external. external: Use an external CSS file inline: Use a <style> tag in the HTML file
1177 .UNINDENT
1178 .INDENT 0.0
1179 .TP
1180 .B \-\-htmlz\-css\-type
1181 Specify the handling of CSS. Default is class. class: Use CSS classes inline: Use the style attribute tag: Use HTML tags wherever possible
1182 .UNINDENT
1183 .INDENT 0.0
1184 .TP
1185 .B \-\-htmlz\-title\-filename
1186 If set this option causes the file name of the HTML file inside the HTMLZ archive to be based on the book title.
1187 .UNINDENT
1188 .INDENT 0.0
1189 .TP
1190 .B \-\-pretty\-print
1191 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1192 .UNINDENT
1193 .SH KEPUB OUTPUT OPTIONS
1194 .INDENT 0.0
1195 .TP
1196 .B \-\-dont\-split\-on\-page\-breaks
1197 Turn off splitting at page breaks. Normally, input files are automatically split at every page break into two files. This gives an output e\-book that can be parsed faster and with less resources. However, splitting is slow and if your source file contains a very large number of page breaks, you should turn off splitting on page breaks.
1198 .UNINDENT
1199 .INDENT 0.0
1200 .TP
1201 .B \-\-extract\-to
1202 Extract the contents of the generated book to the specified folder. The contents of the folder are first deleted, so be careful.
1203 .UNINDENT
1204 .INDENT 0.0
1205 .TP
1206 .B \-\-flow\-size
1207 Split all HTML files larger than this size (in KB). This is necessary as some devices cannot handle large file sizes. Set to 0 to disable size based splitting.
1208 .UNINDENT
1209 .INDENT 0.0
1210 .TP
1211 .B \-\-kepub\-affect\-hyphenation
1212 Modify how hyphenation is performed for this book. Note that hyphenation does not perform well for all languages, as it depends on the dictionaries present on the device, which are not always of the highest quality.
1213 .UNINDENT
1214 .INDENT 0.0
1215 .TP
1216 .B \-\-kepub\-disable\-hyphenation
1217 Override all hyphenation settings in book, forcefully disabling hyphenation completely.
1218 .UNINDENT
1219 .INDENT 0.0
1220 .TP
1221 .B \-\-kepub\-hyphenation\-limit\-lines
1222 Maximum consecutive hyphenated lines.
1223 .UNINDENT
1224 .INDENT 0.0
1225 .TP
1226 .B \-\-kepub\-hyphenation\-min\-chars
1227 Minimum word length to hyphenate, in characters.
1228 .UNINDENT
1229 .INDENT 0.0
1230 .TP
1231 .B \-\-kepub\-hyphenation\-min\-chars\-after
1232 Minimum characters after hyphens.
1233 .UNINDENT
1234 .INDENT 0.0
1235 .TP
1236 .B \-\-kepub\-hyphenation\-min\-chars\-before
1237 Minimum characters before hyphens.
1238 .UNINDENT
1239 .INDENT 0.0
1240 .TP
1241 .B \-\-kepub\-max\-image\-size
1242 The maximum image size (width x height). A value of profile means use the screen size from the output profile. A value of none means no maximum size is specified. For example, a value of 100x200 will cause all images to be resized so that their width is no more than 100 pixels and their height is no more than 200 pixels. Note that this only affects the size of the actual image files themselves. Any given image may be rendered at a different size depending on the styling applied to it in the document.
1243 .UNINDENT
1244 .INDENT 0.0
1245 .TP
1246 .B \-\-kepub\-prefer\-justification
1247 The KEPUB renderer on the Kobo has a bug when text justification is turned on. It will either not justify text properly or when highlighting there will be gaps between neighboring highlighted parts of text. By default, calibre generates KEPUB that avoid the highlighting gaps at the expense of worse text justification. This option reverses that tradeoff. Use this option if you use justification when reading on your Kobo device.
1248 .UNINDENT
1249 .INDENT 0.0
1250 .TP
1251 .B \-\-pretty\-print
1252 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1253 .UNINDENT
1254 .SH LIT OUTPUT OPTIONS
1255 .INDENT 0.0
1256 .TP
1257 .B \-\-pretty\-print
1258 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1259 .UNINDENT
1260 .SH LRF OUTPUT OPTIONS
1261 .INDENT 0.0
1262 .TP
1263 .B \-\-enable\-autorotation
1264 Enable auto\-rotation of images that are wider than the screen width.
1265 .UNINDENT
1266 .INDENT 0.0
1267 .TP
1268 .B \-\-header
1269 Add a header to all the pages with title and author.
1270 .UNINDENT
1271 .INDENT 0.0
1272 .TP
1273 .B \-\-header\-format
1274 Set the format of the header. %a is replaced by the author and %t by the title. Default is %t by %a
1275 .UNINDENT
1276 .INDENT 0.0
1277 .TP
1278 .B \-\-header\-separation
1279 Add extra spacing below the header. Default is 0 pt.
1280 .UNINDENT
1281 .INDENT 0.0
1282 .TP
1283 .B \-\-minimum\-indent
1284 Minimum paragraph indent (the indent of the first line of a paragraph) in pts. Default: 0
1285 .UNINDENT
1286 .INDENT 0.0
1287 .TP
1288 .B \-\-mono\-family
1289 The monospace family of fonts to embed
1290 .UNINDENT
1291 .INDENT 0.0
1292 .TP
1293 .B \-\-pretty\-print
1294 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1295 .UNINDENT
1296 .INDENT 0.0
1297 .TP
1298 .B \-\-render\-tables\-as\-images
1299 This option has no effect
1300 .UNINDENT
1301 .INDENT 0.0
1302 .TP
1303 .B \-\-sans\-family
1304 The sans\-serif family of fonts to embed
1305 .UNINDENT
1306 .INDENT 0.0
1307 .TP
1308 .B \-\-serif\-family
1309 The serif family of fonts to embed
1310 .UNINDENT
1311 .INDENT 0.0
1312 .TP
1313 .B \-\-text\-size\-multiplier\-for\-rendered\-tables
1314 Multiply the size of text in rendered tables by this factor. Default is 1.0
1315 .UNINDENT
1316 .INDENT 0.0
1317 .TP
1318 .B \-\-wordspace
1319 Set the space between words in pts. Default is 2.5
1320 .UNINDENT
1321 .SH MOBI OUTPUT OPTIONS
1322 .INDENT 0.0
1323 .TP
1324 .B \-\-dont\-compress
1325 Disable compression of the file contents.
1326 .UNINDENT
1327 .INDENT 0.0
1328 .TP
1329 .B \-\-extract\-to
1330 Extract the contents of the generated MOBI file to the specified folder. The contents of the folder are first deleted, so be careful.
1331 .UNINDENT
1332 .INDENT 0.0
1333 .TP
1334 .B \-\-mobi\-file\-type
1335 By default calibre generates MOBI files that contain the old MOBI 6 format. This format is compatible with all devices. However, by changing this setting, you can tell calibre to generate MOBI files that contain both MOBI 6 and the new KF8 format, or only the new KF8 format. KF8 has more features than MOBI 6, but only works with newer Kindles. Allowed values: old, both, new
1336 .UNINDENT
1337 .INDENT 0.0
1338 .TP
1339 .B \-\-mobi\-ignore\-margins
1340 Ignore margins in the input document. If False, then the MOBI output plugin will try to convert margins specified in the input document, otherwise it will ignore them.
1341 .UNINDENT
1342 .INDENT 0.0
1343 .TP
1344 .B \-\-mobi\-keep\-original\-images
1345 By default calibre converts all images to JPEG format in the output MOBI file. This is for maximum compatibility as some older MOBI viewers have problems with other image formats. This option tells calibre not to do this. Useful if your document contains lots of GIF/PNG images that become very large when converted to JPEG.
1346 .UNINDENT
1347 .INDENT 0.0
1348 .TP
1349 .B \-\-mobi\-toc\-at\-start
1350 When adding the Table of Contents to the book, add it at the start of the book instead of the end. Not recommended.
1351 .UNINDENT
1352 .INDENT 0.0
1353 .TP
1354 .B \-\-no\-inline\-toc
1355 Don\fB\(aq\fPt add Table of Contents to the book. Useful if the book has its own table of contents.
1356 .UNINDENT
1357 .INDENT 0.0
1358 .TP
1359 .B \-\-personal\-doc
1360 Tag for MOBI files to be marked as personal documents. This option has no effect on the conversion. It is used only when sending MOBI files to a device. If the file being sent has the specified tag, it will be marked as a personal document when sent to the Kindle. Use the value * to match all books.
1361 .UNINDENT
1362 .INDENT 0.0
1363 .TP
1364 .B \-\-prefer\-author\-sort
1365 When present, use author sort field as author.
1366 .UNINDENT
1367 .INDENT 0.0
1368 .TP
1369 .B \-\-pretty\-print
1370 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1371 .UNINDENT
1372 .INDENT 0.0
1373 .TP
1374 .B \-\-share\-not\-sync
1375 Enable sharing of book content via Facebook etc. on the Kindle. WARNING: Using this feature means that the book will not auto sync its last read position on multiple devices. Complain to Amazon.
1376 .UNINDENT
1377 .INDENT 0.0
1378 .TP
1379 .B \-\-toc\-title
1380 Title for any generated inline table of contents.
1381 .UNINDENT
1382 .SH OEB OUTPUT OPTIONS
1383 .INDENT 0.0
1384 .TP
1385 .B \-\-pretty\-print
1386 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1387 .UNINDENT
1388 .SH PDB OUTPUT OPTIONS
1389 .INDENT 0.0
1390 .TP
1391 .B \-\-format, \-f
1392 Format to use inside the PDB container. Choices are: doc, ereader, ztxt
1393 .UNINDENT
1394 .INDENT 0.0
1395 .TP
1396 .B \-\-inline\-toc
1397 Add Table of Contents to beginning of the book.
1398 .UNINDENT
1399 .INDENT 0.0
1400 .TP
1401 .B \-\-pdb\-output\-encoding
1402 Specify the character encoding of the output document. The default is cp1252. Note: This option is not honored by all formats.
1403 .UNINDENT
1404 .INDENT 0.0
1405 .TP
1406 .B \-\-pretty\-print
1407 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1408 .UNINDENT
1409 .SH PDF OUTPUT OPTIONS
1410 .INDENT 0.0
1411 .TP
1412 .B \-\-custom\-size
1413 Custom size of the document. Use the form width x height e.g. \fI123x321\fP to specify the width and height. This overrides any specified paper\-size.
1414 .UNINDENT
1415 .INDENT 0.0
1416 .TP
1417 .B \-\-paper\-size
1418 The size of the paper. This size will be overridden when a non default output profile is used. Default is letter. Choices are a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3, b4, b5, b6, legal, letter
1419 .UNINDENT
1420 .INDENT 0.0
1421 .TP
1422 .B \-\-pdf\-add\-toc
1423 Add a Table of Contents at the end of the PDF that lists page numbers. Useful if you want to print out the PDF. If this PDF is intended for electronic use, use the PDF Outline instead.
1424 .UNINDENT
1425 .INDENT 0.0
1426 .TP
1427 .B \-\-pdf\-default\-font\-size
1428 The default font size (in pixels)
1429 .UNINDENT
1430 .INDENT 0.0
1431 .TP
1432 .B \-\-pdf\-footer\-template
1433 An HTML template used to generate footers on every page. The strings _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_ will be replaced by their current values.
1434 .UNINDENT
1435 .INDENT 0.0
1436 .TP
1437 .B \-\-pdf\-header\-template
1438 An HTML template used to generate headers on every page. The strings _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_ will be replaced by their current values.
1439 .UNINDENT
1440 .INDENT 0.0
1441 .TP
1442 .B \-\-pdf\-hyphenate
1443 Break long words at the end of lines. This can give the text at the right margin a more even appearance. Note that depending on the fonts used this option can break the copying of text from the PDF file.
1444 .UNINDENT
1445 .INDENT 0.0
1446 .TP
1447 .B \-\-pdf\-mark\-links
1448 Surround all links with a red box, useful for debugging.
1449 .UNINDENT
1450 .INDENT 0.0
1451 .TP
1452 .B \-\-pdf\-mono\-family
1453 The font family used to render monospace fonts. Will work only if the font is available system\-wide.
1454 .UNINDENT
1455 .INDENT 0.0
1456 .TP
1457 .B \-\-pdf\-mono\-font\-size
1458 The default font size for monospaced text (in pixels)
1459 .UNINDENT
1460 .INDENT 0.0
1461 .TP
1462 .B \-\-pdf\-no\-cover
1463 Do not insert the book cover as an image at the start of the document. If you use this option, the book cover will be discarded.
1464 .UNINDENT
1465 .INDENT 0.0
1466 .TP
1467 .B \-\-pdf\-odd\-even\-offset
1468 Shift the text horizontally by the specified offset (in pts). On odd numbered pages, it is shifted to the right and on even numbered pages to the left. Use negative numbers for the opposite effect. Note that this setting is ignored on pages where the margins are smaller than the specified offset. Shifting is done by setting the PDF CropBox, not all software respects the CropBox.
1469 .UNINDENT
1470 .INDENT 0.0
1471 .TP
1472 .B \-\-pdf\-page\-margin\-bottom
1473 The size of the bottom page margin, in pts. Default is 72pt. Overrides the common bottom page margin setting, unless set to zero.
1474 .UNINDENT
1475 .INDENT 0.0
1476 .TP
1477 .B \-\-pdf\-page\-margin\-left
1478 The size of the left page margin, in pts. Default is 72pt. Overrides the common left page margin setting.
1479 .UNINDENT
1480 .INDENT 0.0
1481 .TP
1482 .B \-\-pdf\-page\-margin\-right
1483 The size of the right page margin, in pts. Default is 72pt. Overrides the common right page margin setting, unless set to zero.
1484 .UNINDENT
1485 .INDENT 0.0
1486 .TP
1487 .B \-\-pdf\-page\-margin\-top
1488 The size of the top page margin, in pts. Default is 72pt. Overrides the common top page margin setting, unless set to zero.
1489 .UNINDENT
1490 .INDENT 0.0
1491 .TP
1492 .B \-\-pdf\-page\-number\-map
1493 Adjust page numbers, as needed. Syntax is a JavaScript expression for the page number. For example, \fB\(dq\fPif (n < 3) 0; else n \- 3;\fB\(dq\fP, where n is current page number.
1494 .UNINDENT
1495 .INDENT 0.0
1496 .TP
1497 .B \-\-pdf\-page\-numbers
1498 Add page numbers to the bottom of every page in the generated PDF file. If you specify a footer template, it will take precedence over this option.
1499 .UNINDENT
1500 .INDENT 0.0
1501 .TP
1502 .B \-\-pdf\-sans\-family
1503 The font family used to render sans\-serif fonts. Will work only if the font is available system\-wide.
1504 .UNINDENT
1505 .INDENT 0.0
1506 .TP
1507 .B \-\-pdf\-serif\-family
1508 The font family used to render serif fonts. Will work only if the font is available system\-wide.
1509 .UNINDENT
1510 .INDENT 0.0
1511 .TP
1512 .B \-\-pdf\-standard\-font
1513 The type of font family used to render font for which no font family is specified.
1514 .UNINDENT
1515 .INDENT 0.0
1516 .TP
1517 .B \-\-pdf\-use\-document\-margins
1518 Use the page margins specified in the input document via @page CSS rules. This will cause the margins specified in the conversion settings to be ignored. If the document does not specify page margins, the conversion settings will be used as a fallback.
1519 .UNINDENT
1520 .INDENT 0.0
1521 .TP
1522 .B \-\-preserve\-cover\-aspect\-ratio
1523 Preserve the aspect ratio of the cover, instead of stretching it to fill the full first page of the generated PDF.
1524 .UNINDENT
1525 .INDENT 0.0
1526 .TP
1527 .B \-\-pretty\-print
1528 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1529 .UNINDENT
1530 .INDENT 0.0
1531 .TP
1532 .B \-\-toc\-title
1533 Title for generated table of contents.
1534 .UNINDENT
1535 .INDENT 0.0
1536 .TP
1537 .B \-\-uncompressed\-pdf
1538 Generate an uncompressed PDF, useful for debugging.
1539 .UNINDENT
1540 .INDENT 0.0
1541 .TP
1542 .B \-\-unit, \-u
1543 The unit of measure for page sizes. Default is inch. Choices are millimeter, centimeter, point, inch, pica, didot, cicero, devicepixel Note: This does not override the unit for margins!
1544 .UNINDENT
1545 .INDENT 0.0
1546 .TP
1547 .B \-\-use\-profile\-size
1548 Instead of using the paper size specified in the PDF Output options, use a paper size corresponding to the current output profile. Useful if you want to generate a PDF for viewing on a specific device.
1549 .UNINDENT
1550 .SH PML OUTPUT OPTIONS
1551 .INDENT 0.0
1552 .TP
1553 .B \-\-full\-image\-depth
1554 Do not reduce the size or bit depth of images. Images have their size and depth reduced by default to accommodate applications that can not convert images on their own such as Dropbook.
1555 .UNINDENT
1556 .INDENT 0.0
1557 .TP
1558 .B \-\-inline\-toc
1559 Add Table of Contents to beginning of the book.
1560 .UNINDENT
1561 .INDENT 0.0
1562 .TP
1563 .B \-\-pml\-output\-encoding
1564 Specify the character encoding of the output document. The default is cp1252.
1565 .UNINDENT
1566 .INDENT 0.0
1567 .TP
1568 .B \-\-pretty\-print
1569 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1570 .UNINDENT
1571 .SH RB OUTPUT OPTIONS
1572 .INDENT 0.0
1573 .TP
1574 .B \-\-inline\-toc
1575 Add Table of Contents to beginning of the book.
1576 .UNINDENT
1577 .INDENT 0.0
1578 .TP
1579 .B \-\-pretty\-print
1580 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1581 .UNINDENT
1582 .SH RTF OUTPUT OPTIONS
1583 .INDENT 0.0
1584 .TP
1585 .B \-\-pretty\-print
1586 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1587 .UNINDENT
1588 .SH SNB OUTPUT OPTIONS
1589 .INDENT 0.0
1590 .TP
1591 .B \-\-pretty\-print
1592 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1593 .UNINDENT
1594 .INDENT 0.0
1595 .TP
1596 .B \-\-snb\-dont\-indent\-first\-line
1597 Specify whether or not to insert two space characters to indent the first line of each paragraph.
1598 .UNINDENT
1599 .INDENT 0.0
1600 .TP
1601 .B \-\-snb\-full\-screen
1602 Resize all the images for full screen mode.
1603 .UNINDENT
1604 .INDENT 0.0
1605 .TP
1606 .B \-\-snb\-hide\-chapter\-name
1607 Specify whether or not to hide the chapter title for each chapter. Useful for image\-only output (eg. comics).
1608 .UNINDENT
1609 .INDENT 0.0
1610 .TP
1611 .B \-\-snb\-insert\-empty\-line
1612 Specify whether or not to insert an empty line between two paragraphs.
1613 .UNINDENT
1614 .INDENT 0.0
1615 .TP
1616 .B \-\-snb\-max\-line\-length
1617 The maximum number of characters per line. This splits on the first space before the specified value. If no space is found the line will be broken at the space after and will exceed the specified value. Also, there is a minimum of 25 characters. Use 0 to disable line splitting.
1618 .UNINDENT
1619 .INDENT 0.0
1620 .TP
1621 .B \-\-snb\-output\-encoding
1622 Specify the character encoding of the output document. The default is utf\-8.
1623 .UNINDENT
1624 .SH TCR OUTPUT OPTIONS
1625 .INDENT 0.0
1626 .TP
1627 .B \-\-pretty\-print
1628 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1629 .UNINDENT
1630 .INDENT 0.0
1631 .TP
1632 .B \-\-tcr\-output\-encoding
1633 Specify the character encoding of the output document. The default is utf\-8.
1634 .UNINDENT
1635 .SH TXT OUTPUT OPTIONS
1636 .INDENT 0.0
1637 .TP
1638 .B \-\-force\-max\-line\-length
1639 Force splitting on the max\-line\-length value when no space is present. Also allows max\-line\-length to be below the minimum
1640 .UNINDENT
1641 .INDENT 0.0
1642 .TP
1643 .B \-\-inline\-toc
1644 Add Table of Contents to beginning of the book.
1645 .UNINDENT
1646 .INDENT 0.0
1647 .TP
1648 .B \-\-keep\-color
1649 Do not remove font color from output. This is only useful when TXT output formatting is set to textile. Textile is the only formatting that supports setting font color. If this option is not specified font color will not be set and default to the color displayed by the reader (generally this is black).
1650 .UNINDENT
1651 .INDENT 0.0
1652 .TP
1653 .B \-\-keep\-image\-references
1654 Do not remove image references within the document. This is only useful when paired with a TXT output formatting option that is not none because links are always removed with plain text output.
1655 .UNINDENT
1656 .INDENT 0.0
1657 .TP
1658 .B \-\-keep\-links
1659 Do not remove links within the document. This is only useful when paired with a TXT output formatting option that is not none because links are always removed with plain text output.
1660 .UNINDENT
1661 .INDENT 0.0
1662 .TP
1663 .B \-\-max\-line\-length
1664 The maximum number of characters per line. This splits on the first space before the specified value. If no space is found the line will be broken at the space after and will exceed the specified value. Also, there is a minimum of 25 characters. Use 0 to disable line splitting.
1665 .UNINDENT
1666 .INDENT 0.0
1667 .TP
1668 .B \-\-newline, \-n
1669 Type of newline to use. Options are [\fB\(aq\fPold_mac\fB\(aq\fP, \fB\(aq\fPsystem\fB\(aq\fP, \fB\(aq\fPunix\fB\(aq\fP, \fB\(aq\fPwindows\fB\(aq\fP]. Default is \fB\(aq\fPsystem\fB\(aq\fP\&. Use \fB\(aq\fPold_mac\fB\(aq\fP for compatibility with Mac OS 9 and earlier. For macOS use \fB\(aq\fPunix\fB\(aq\fP\&. \fB\(aq\fPsystem\fB\(aq\fP will default to the newline type used by this OS.
1670 .UNINDENT
1671 .INDENT 0.0
1672 .TP
1673 .B \-\-pretty\-print
1674 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1675 .UNINDENT
1676 .INDENT 0.0
1677 .TP
1678 .B \-\-txt\-output\-encoding
1679 Specify the character encoding of the output document. The default is utf\-8.
1680 .UNINDENT
1681 .INDENT 0.0
1682 .TP
1683 .B \-\-txt\-output\-formatting
1684 Formatting used within the document. * plain: Plain text * markdown: Markdown formatted text * textile: Textile formatted text
1685 .UNINDENT
1686 .INDENT 0.0
1687 .TP
1688 .B \-\-use\-alt\-text\-for\-images
1689 Replace images with the text from the alt attribute, if any. Ignored if the option to keep image references is specified.
1690 .UNINDENT
1691 .SH TXTZ OUTPUT OPTIONS
1692 .INDENT 0.0
1693 .TP
1694 .B \-\-force\-max\-line\-length
1695 Force splitting on the max\-line\-length value when no space is present. Also allows max\-line\-length to be below the minimum
1696 .UNINDENT
1697 .INDENT 0.0
1698 .TP
1699 .B \-\-inline\-toc
1700 Add Table of Contents to beginning of the book.
1701 .UNINDENT
1702 .INDENT 0.0
1703 .TP
1704 .B \-\-keep\-color
1705 Do not remove font color from output. This is only useful when TXT output formatting is set to textile. Textile is the only formatting that supports setting font color. If this option is not specified font color will not be set and default to the color displayed by the reader (generally this is black).
1706 .UNINDENT
1707 .INDENT 0.0
1708 .TP
1709 .B \-\-keep\-image\-references
1710 Do not remove image references within the document. This is only useful when paired with a TXT output formatting option that is not none because links are always removed with plain text output.
1711 .UNINDENT
1712 .INDENT 0.0
1713 .TP
1714 .B \-\-keep\-links
1715 Do not remove links within the document. This is only useful when paired with a TXT output formatting option that is not none because links are always removed with plain text output.
1716 .UNINDENT
1717 .INDENT 0.0
1718 .TP
1719 .B \-\-max\-line\-length
1720 The maximum number of characters per line. This splits on the first space before the specified value. If no space is found the line will be broken at the space after and will exceed the specified value. Also, there is a minimum of 25 characters. Use 0 to disable line splitting.
1721 .UNINDENT
1722 .INDENT 0.0
1723 .TP
1724 .B \-\-newline, \-n
1725 Type of newline to use. Options are [\fB\(aq\fPold_mac\fB\(aq\fP, \fB\(aq\fPsystem\fB\(aq\fP, \fB\(aq\fPunix\fB\(aq\fP, \fB\(aq\fPwindows\fB\(aq\fP]. Default is \fB\(aq\fPsystem\fB\(aq\fP\&. Use \fB\(aq\fPold_mac\fB\(aq\fP for compatibility with Mac OS 9 and earlier. For macOS use \fB\(aq\fPunix\fB\(aq\fP\&. \fB\(aq\fPsystem\fB\(aq\fP will default to the newline type used by this OS.
1726 .UNINDENT
1727 .INDENT 0.0
1728 .TP
1729 .B \-\-pretty\-print
1730 If specified, the output plugin will try to create output that is as human readable as possible. May not have any effect for some output plugins.
1731 .UNINDENT
1732 .INDENT 0.0
1733 .TP
1734 .B \-\-txt\-output\-encoding
1735 Specify the character encoding of the output document. The default is utf\-8.
1736 .UNINDENT
1737 .INDENT 0.0
1738 .TP
1739 .B \-\-txt\-output\-formatting
1740 Formatting used within the document. * plain: Plain text * markdown: Markdown formatted text * textile: Textile formatted text
1741 .UNINDENT
1742 .INDENT 0.0
1743 .TP
1744 .B \-\-use\-alt\-text\-for\-images
1745 Replace images with the text from the alt attribute, if any. Ignored if the option to keep image references is specified.
1746 .UNINDENT
1747 .SH Author
1748 Kovid Goyal
1749 .SH Copyright
1750 Kovid Goyal
1751 .\" End of generated man page.