UM_calibre_371

calibre User Manual, Release 3.35.0

calibredb-catalog command line option, 276 ebook-convert command line option, 286
calibredb-list command line option, 272 –sr2-search
–search-replace
ebook-convert command line option, 286 ebook-convert command line option, 286
–sectionize –sr3-replace
ebook-convert-fb2-output command line option, 296
–separator ebook-convert command line option, 286
calibredb-list command line option, 272 –sr3-search
–series
ebook-convert command line option, 288 ebook-convert command line option, 286
–series, -s –ssl-certfile
calibredb-add command line option, 273
ebook-meta command line option, 305 calibre-server command line option, 268
–series-index –ssl-keyfile
ebook-convert command line option, 288
–series-index, -S calibre-server command line option, 269
calibredb-add command line option, 273 –start-in-tray
–serif-family
ebook-convert-lrf-output command line option, 298 calibre command line option, 264
–share-not-sync –start-reading-at
ebook-convert-azw3-output command line option,
ebook-convert command line option, 287
294 –subject, -s
ebook-convert-mobi-output command line option,
calibre-smtp command line option, 270
298 –subset-embedded-fonts
–shutdown-running-calibre, -s
ebook-convert command line option, 285
calibre command line option, 263 –subset-font, -f
calibre-debug command line option, 266
–shutdown-timeout calibre-debug command line option, 266
calibre-server command line option, 268 –subset-fonts, -f
–single-dir
calibredb-export command line option, 275 ebook-polish command line option, 306
–smarten-punctuation –tags
ebook-convert command line option, 285
–smarten-punctuation, -p ebook-convert command line option, 289
ebook-polish command line option, 306 ebook-meta command line option, 305
–snb-dont-indent-first-line –tags, -T
ebook-convert-snb-output command line option, 301 calibredb-add command line option, 273
–snb-full-screen –tcr-output-encoding
ebook-convert-snb-output command line option, 301 ebook-convert-tcr-output command line option, 302
–snb-hide-chapter-name –template
ebook-convert-snb-output command line option, 301 calibredb-export command line option, 275
–snb-insert-empty-line –template-css
ebook-convert-snb-output command line option, 301 ebook-convert-html-output command line option,
–snb-max-line-length
ebook-convert-snb-output command line option, 301 297
–snb-output-encoding –template-html
ebook-convert-snb-output command line option, 301
–sort-by ebook-convert-html-output command line option,
calibredb-list command line option, 272 297
–sr1-replace
ebook-convert command line option, 286 –template-html-index
–sr1-search ebook-convert-html-output command line option,
ebook-convert command line option, 286 297
–sr2-replace
–test
ebook-convert-recipe-input command line option,
293

–test-build
calibre-debug command line option, 266

–text-size-multiplier-for-rendered-tables
ebook-convert-lrf-output command line option, 298

–thumb-width
calibredb-catalog command line option, 277

–timefmt
calibredb-export command line option, 276

–timeout
calibre-server command line option, 269

Index 347

calibre User Manual, Release 3.35.0

–timeout, -d –url-prefix
fetch-ebook-metadata command line option, 307 calibre-server command line option, 269

–timeout, -t –use-auto-toc
calibre-smtp command line option, 269 ebook-convert command line option, 288
web2disk command line option, 310
–use-existing-cover
–timestamp calibredb-catalog command line option, 277
ebook-convert command line option, 289
–use-profile-size
–title ebook-convert-pdf-output command line option, 300
ebook-convert command line option, 289
–userdb
–title, -t calibre-server command line option, 269
calibredb-add command line option, 273
ebook-meta command line option, 305 –username
fetch-ebook-metadata command line option, 307 command line option, 272
ebook-convert-recipe-input command line option,
–title-sort 293
ebook-convert command line option, 289
ebook-meta command line option, 305 –username, -u
calibre-smtp command line option, 270
–to-dir
calibredb-export command line option, 276 –verbose
ebook-polish command line option, 306
–to-lowercase lrf2lrs command line option, 308
calibredb-export command line option, 276 lrfviewer command line option, 308
lrs2lrf command line option, 309
–to-opf web2disk command line option, 310
ebook-meta command line option, 305
–verbose, -v
–toc-filter calibre command line option, 264
ebook-convert command line option, 288 calibre-smtp command line option, 269
calibredb-catalog command line option, 276
–toc-threshold ebook-convert command line option, 289
ebook-convert command line option, 288 fetch-ebook-metadata command line option, 307

–toc-title –version
ebook-convert-azw3-output command line option, calibre command line option, 264
294 calibre-customize command line option, 264
ebook-convert-epub-output command line option, calibre-debug command line option, 266
296 calibre-server command line option, 269
ebook-convert-mobi-output command line option, calibre-smtp command line option, 269
298 command line option, 272
ebook-convert-pdf-output command line option, 300 ebook-convert command line option, 283
ebook-edit command line option, 303
–transform-css-rules ebook-meta command line option, 305
ebook-convert command line option, 285 ebook-polish command line option, 306
ebook-viewer command line option, 307
–txt-in-remove-indents fetch-ebook-metadata command line option, 307
ebook-convert-txt-input command line option, 294 lrf2lrs command line option, 308
lrfviewer command line option, 308
–txt-output-encoding lrs2lrf command line option, 309
ebook-convert-txt-output command line option, 302 web2disk command line option, 310
ebook-convert-txtz-output command line option, 303
–viewer, -w
–txt-output-formatting calibre-debug command line option, 266
ebook-convert-txt-output command line option, 302
ebook-convert-txtz-output command line option, 303 –visual-debug
lrfviewer command line option, 308
–uncompressed-pdf
ebook-convert-pdf-output command line option, 300 –white-background
lrfviewer command line option, 308
–unit, -u
ebook-convert-pdf-output command line option, 300 –wide
ebook-convert-comic-input command line option,
–unsmarten-punctuation 290
ebook-convert command line option, 285

–unwrap-factor
ebook-convert-pdf-input command line option, 292

–upgrade-book, -U
ebook-polish command line option, 306

348 Index

calibre User Manual, Release 3.35.0

–width, -w method), 325
calibredb-list_categories command line option, 280
add_or_replace_jacket() (in module cali-
–with-library
calibre command line option, 264 bre.ebooks.oeb.polish.jacket), 330

–wordspace add_properties() (calibre.ebooks.oeb.polish.container.Container
ebook-convert-lrf-output command line option, 298
method), 325
–worker-count
calibre-server command line option, 269 add_savepoint() (calibre.gui2.tweak_book.boss.Boss

method), 333

add_toc_thumbnail() (cali-

A bre.web.feeds.news.BasicNewsRecipe

method), 47

abort_article() (calibre.web.feeds.news.BasicNewsRecipe adeify_images() (calibre.web.feeds.news.BasicNewsRecipe

method), 47 class method), 47

abort_recipe_processing() (cali- all_book_ids() (calibre.db.cache.Cache method), 319

bre.web.feeds.news.BasicNewsRecipe all_field_for() (calibre.db.cache.Cache method), 319

method), 47 all_field_ids() (calibre.db.cache.Cache method), 319

abspath_to_name() (cali- all_field_keys() (calibre.ebooks.metadata.book.base.Metadata

bre.ebooks.oeb.polish.container.Container method), 180

method), 325 all_field_names() (calibre.db.cache.Cache method), 319

accept_drag_move_event() (cali- all_non_none_fields() (cali-

bre.gui2.actions.InterfaceAction method), bre.ebooks.metadata.book.base.Metadata

245 method), 180

accept_enter_event() (cali- allowed_in_menu (calibre.gui2.tweak_book.plugin.Tool

bre.gui2.actions.InterfaceAction method), attribute), 332

245 allowed_in_toolbar (cali-

accepts_drops (calibre.gui2.actions.InterfaceAction at- bre.gui2.tweak_book.plugin.Tool attribute),

tribute), 244 332

action_add_menu (calibre.gui2.actions.InterfaceAction API, 335

attribute), 244 apply_container_update_to_gui() (cali-

action_menu_clone_qaction (cali- bre.gui2.tweak_book.boss.Boss method),

bre.gui2.actions.InterfaceAction attribute), 333

244 apply_unique_properties() (cali-

action_spec (calibre.gui2.actions.InterfaceAction at- bre.ebooks.oeb.polish.container.Container

tribute), 244 method), 326

action_type (calibre.gui2.actions.InterfaceAction at- articles_are_obfuscated (cali-

tribute), 244 bre.web.feeds.news.BasicNewsRecipe at-

add_annotation_to_library() (cali- tribute), 51

bre.devices.usbms.device.Device method), ASK_TO_ALLOW_CONNECT (cali-

241 bre.devices.interface.DevicePlugin attribute),

add_book() (calibre.devices.interface.BookList method), 233

238 author (calibre.customize.Plugin attribute), 222

add_books() (calibre.db.cache.Cache method), 319 author_data() (calibre.db.cache.Cache method), 319

add_books_to_metadata() (cali- author_sort_from_authors() (calibre.db.cache.Cache

bre.devices.interface.DevicePlugin class method), 320

method), 235 auto_cleanup (calibre.web.feeds.news.BasicNewsRecipe

add_books_to_metadata() (cali- attribute), 51

bre.devices.usbms.driver.USBMS method), auto_cleanup_keep (cali-

243 bre.web.feeds.news.BasicNewsRecipe at-

add_custom_book_data() (calibre.db.cache.Cache tribute), 51

method), 319 auto_repeat (calibre.gui2.actions.InterfaceAction at-

add_file() (calibre.ebooks.oeb.polish.container.Container tribute), 244

method), 325 auto_trim_covers (cali-

add_format() (calibre.db.cache.Cache method), 319 bre.ebooks.metadata.sources.base.Source

add_name_to_manifest() (cali- attribute), 226

bre.ebooks.oeb.polish.container.Container

Index 349

calibre User Manual, Release 3.35.0

B BuiltinFinishFormatting (class in cali-
bre.utils.formatter_functions), 170
BasicNewsRecipe (class in calibre.web.feeds.news), 46
BuiltinFirstMatchingCmp (class in cali-
BCD (calibre.devices.interface.DevicePlugin attribute), bre.utils.formatter_functions), 177

232 BuiltinFirstNonEmpty (class in cali-
bre.utils.formatter_functions), 174
book_class (calibre.devices.usbms.driver.USBMS at-
BuiltinFormatDate (class in cali-
tribute), 242 bre.utils.formatter_functions), 170

book_type (calibre.ebooks.oeb.polish.container.Container BuiltinFormatNumber (class in cali-
bre.utils.formatter_functions), 171
attribute), 326
BuiltinFormatsModtimes (class in cali-
BookList (class in calibre.devices.interface), 238 bre.utils.formatter_functions), 172

booklist_class (calibre.devices.usbms.driver.USBMS at- BuiltinFormatsPaths (class in cali-
bre.utils.formatter_functions), 172
tribute), 242
BuiltinFormatsSizes (class in cali-
books() (calibre.devices.interface.DevicePlugin method), bre.utils.formatter_functions), 172

235 BuiltinHasCover (class in cali-
bre.utils.formatter_functions), 172
books() (calibre.devices.usbms.driver.USBMS method),
BuiltinHumanReadable (class in cali-
242 bre.utils.formatter_functions), 171

books_for_field() (calibre.db.cache.Cache method), 320 BuiltinIdentifierInList (class in cali-
bre.utils.formatter_functions), 174
books_in_virtual_library() (calibre.db.cache.Cache
BuiltinIfempty (class in cali-
method), 320 bre.utils.formatter_functions), 173

boss (calibre.gui2.tweak_book.plugin.Tool attribute), 332 BuiltinInList (class in calibre.utils.formatter_functions),
174
Boss (class in calibre.gui2.tweak_book.boss), 333
BuiltinLanguageCodes (class in cali-
BuiltinAdd (class in calibre.utils.formatter_functions), bre.utils.formatter_functions), 172

169 BuiltinLanguageStrings (class in cali-
bre.utils.formatter_functions), 172
BuiltinAnd (class in calibre.utils.formatter_functions),
BuiltinListDifference (class in cali-
170 bre.utils.formatter_functions), 175

BuiltinApproximateFormats (class in cali- BuiltinListEquals (class in cali-
bre.utils.formatter_functions), 175
bre.utils.formatter_functions), 171
BuiltinListIntersection (class in cali-
BuiltinAssign (class in calibre.utils.formatter_functions), bre.utils.formatter_functions), 175

176 BuiltinListitem (class in cali-
bre.utils.formatter_functions), 174
BuiltinAuthorLinks (class in cali-
BuiltinListRe (class in calibre.utils.formatter_functions),
bre.utils.formatter_functions), 171 175

BuiltinAuthorSorts (class in cali- BuiltinListReGroup (class in cali-
bre.utils.formatter_functions), 176
bre.utils.formatter_functions), 171
BuiltinListSort (class in cali-
BuiltinBooksize (class in cali- bre.utils.formatter_functions), 176

bre.utils.formatter_functions), 171 BuiltinListUnion (class in cali-
bre.utils.formatter_functions), 176
BuiltinCapitalize (class in cali-
BuiltinLookup (class in calibre.utils.formatter_functions),
bre.utils.formatter_functions), 177 174

BuiltinCmp (class in calibre.utils.formatter_functions), BuiltinLowercase (class in cali-
bre.utils.formatter_functions), 178
177
BuiltinMultiply (class in cali-
BuiltinContains (class in cali- bre.utils.formatter_functions), 169

bre.utils.formatter_functions), 173 BuiltinNot (class in calibre.utils.formatter_functions),
170
BuiltinCount (class in calibre.utils.formatter_functions),

175

BuiltinCurrentLibraryName (class in cali-

bre.utils.formatter_functions), 172

BuiltinCurrentLibraryPath (class in cali-

bre.utils.formatter_functions), 172

BuiltinDaysBetween (class in cali-

bre.utils.formatter_functions), 170

BuiltinDivide (class in calibre.utils.formatter_functions),

169

BuiltinEval (class in calibre.utils.formatter_functions),

177

BuiltinField (class in calibre.utils.formatter_functions),

172

350 Index

calibre User Manual, Release 3.35.0

BuiltinOndevice (class in cali- BuiltinVirtualLibraries (class in cali-
bre.utils.formatter_functions), 173
bre.utils.formatter_functions), 173
BuiltinOr (class in calibre.utils.formatter_functions), 170
BuiltinPrint (class in calibre.utils.formatter_functions), C

176 Cache (class in calibre.db.cache), 319
BuiltinRawField (class in cali-
cached_cover_url_is_reliable (cali-
bre.utils.formatter_functions), 173
BuiltinRawList (class in cali- bre.ebooks.metadata.sources.base.Source

bre.utils.formatter_functions), 173 attribute), 226
BuiltinRe (class in calibre.utils.formatter_functions), 178
BuiltinReGroup (class in cali- calibre command line option

bre.utils.formatter_functions), 178 –detach, 263
BuiltinSelect (class in calibre.utils.formatter_functions),
–help, -h, 263
175
BuiltinSeriesSort (class in cali- –ignore-plugins, 263

bre.utils.formatter_functions), 173 –no-update-check, 263
BuiltinShorten (class in calibre.utils.formatter_functions),
–shutdown-running-calibre, -s, 263
178
BuiltinStrcat (class in calibre.utils.formatter_functions), –start-in-tray, 264

178 –verbose, -v, 264
BuiltinStrcatMax (class in cali-
–version, 264
bre.utils.formatter_functions), 178
BuiltinStrcmp (class in calibre.utils.formatter_functions), –with-library, 264

177 calibre-customize command line option
BuiltinStrInList (class in cali-
–add-plugin, -a, 264
bre.utils.formatter_functions), 175
BuiltinStrlen (class in calibre.utils.formatter_functions), –build-plugin, -b, 264

179 –customize-plugin, 264
BuiltinSubitems (class in cali-
–disable-plugin, 264
bre.utils.formatter_functions), 176
BuiltinSublist (class in calibre.utils.formatter_functions), –enable-plugin, 264

176 –help, -h, 264
BuiltinSubstr (class in calibre.utils.formatter_functions),
–list-plugins, -l, 264
179
BuiltinSubtract (class in cali- –remove-plugin, -r, 264

bre.utils.formatter_functions), 169 –version, 264
BuiltinSwapAroundComma (class in cali-
calibre-debug command line option
bre.utils.formatter_functions), 179
BuiltinSwitch (class in calibre.utils.formatter_functions), –add-simple-plugin, 265

174 –command, -c, 265
BuiltinTemplate (class in cali-
–debug-device-driver, -d, 265
bre.utils.formatter_functions), 177
BuiltinTest (class in calibre.utils.formatter_functions), –default-programs, 265

174 –diff, 265
BuiltinTitlecase (class in cali-
–edit-book, -t, 265
bre.utils.formatter_functions), 178
BuiltinToday (class in calibre.utils.formatter_functions), –exec-file, -e, 265

170 –explode-book, -x, 265
BuiltinTransliterate (class in cali-
–export-all-calibre-data, 265
bre.utils.formatter_functions), 179
BuiltinUppercase (class in cali- –gui, -g, 265

bre.utils.formatter_functions), 178 –gui-debug, 265
BuiltinUserCategories (class in cali-
–help, -h, 265
bre.utils.formatter_functions), 173
–implode-book, -i, 265

–import-calibre-data, 266

–inspect-mobi, -m, 266

–paths, 266

–reinitialize-db, 266

–run-plugin, -r, 266

–shutdown-running-calibre, -s, 266

–subset-font, -f, 266

–test-build, 266

–version, 266

–viewer, -w, 266

calibre-server command line option

–access-log, 266

Index 351

calibre User Manual, Release 3.35.0

–ajax-timeout, 266 –timeout, -t, 269
–auth-mode, 266 –username, -u, 270
–auto-reload, 266 –verbose, -v, 269
–ban-after, 267 –version, 269
–ban-for, 267 calibre.customize (module), 221
–compress-min-size, 267 calibre.customize.conversion (module), 229
–custom-list-template, 267 calibre.db.cache (module), 319
–daemonize, 267 calibre.devices.interface (module), 231
–displayed-fields, 267 calibre.ebooks.metadata.book.base (module), 179
–enable-allow-socket-preallocation, –disable-allow- calibre.ebooks.metadata.sources.base (module), 226
calibre.ebooks.oeb.polish.container (module), 325
socket-preallocation, 267 calibre.ebooks.oeb.polish.cover (module), 330
–enable-auth, –disable-auth, 267 calibre.ebooks.oeb.polish.css (module), 331
–enable-fallback-to-detected-interface, –disable- calibre.ebooks.oeb.polish.jacket (module), 330
calibre.ebooks.oeb.polish.pretty (module), 329
fallback-to-detected-interface, 267 calibre.ebooks.oeb.polish.replace (module), 329
–enable-local-write, –disable-local-write, 267 calibre.ebooks.oeb.polish.split (module), 330
–enable-log-not-found, –disable-log-not-found, 267 calibre.ebooks.oeb.polish.toc (module), 331
–enable-use-bonjour, –disable-use-bonjour, 267 calibre.gui2.tweak_book.boss (module), 333
–enable-use-sendfile, –disable-use-sendfile, 267 calibre.gui2.tweak_book.plugin.Tool (module), 332
–help, -h, 268 calibre.utils.formatter_functions (module), 169
–ignored-fields, 268 calibre.web.feeds.news (module), 46
–listen-on, 268 calibredb-add command line option
–log, 268 –add, 273
–manage-users, 268 –authors, -a, 273
–max-header-line-size, 268 –cover, -c, 273
–max-job-time, 268 –duplicates, -d, 273
–max-jobs, 268 –empty, -e, 273
–max-log-size, 268 –identifier, -I, 273
–max-opds-items, 268 –ignore, 273
–max-opds-ungrouped-items, 268 –isbn, -i, 273
–max-request-body-size, 268 –languages, -l, 273
–num-per-page, 268 –one-book-per-directory, -1, 273
–pidfile, 268 –recurse, -r, 273
–port, 268 –series, -s, 273
–shutdown-timeout, 268 –series-index, -S, 273
–ssl-certfile, 268 –tags, -T, 273
–ssl-keyfile, 269 –title, -t, 273
–timeout, 269 calibredb-add_custom_column command line option
–url-prefix, 269 –display, 278
–userdb, 269 –is-multiple, 278
–version, 269 calibredb-add_format command line option
–worker-count, 269 –dont-replace, 274
calibre-smtp command line option calibredb-backup_metadata command line option
–attachment, -a, 270 –all, 280
–cafile, 270 calibredb-catalog command line option
–dont-verify-server-certificate, 270 –catalog-title, 276
–encryption-method, -e, 270 –cross-reference-authors, 276
–fork, -f, 269 –debug-pipeline, 276
–help, -h, 269 –exclude-genre, 276
–localhost, -l, 269 –exclusion-rules, 276
–outbox, -o, 269 –generate-authors, 277
–password, -p, 270 –generate-descriptions, 277
–port, 270 –generate-genres, 277
–relay, -r, 270
–subject, -s, 270

352 Index

calibre User Manual, Release 3.35.0

–generate-recently-added, 277 –permanent, 274
–generate-series, 277
–generate-titles, 277 calibredb-remove_custom_column command line option
–genre-source-field, 277
–header-note-source-field, 277 –force, -f, 278
–ids, -i, 276
–merge-comments-rule, 277 calibredb-restore_database command line option
–output-profile, 277
–prefix-rules, 277 –really-do-it, -r, 279
–preset, 277
–search, -s, 276 calibredb-search command line option
–thumb-width, 277
–use-existing-cover, 277 –limit, -l, 281
–verbose, -v, 276
calibredb-check_library command line option calibredb-set_custom command line option
–csv, -c, 279
–ignore_extensions, -e, 279 –append, -a, 279
–ignore_names, -n, 279
–report, -r, 279 calibredb-set_metadata command line option
calibredb-custom_columns command line option
–details, -d, 278 –field, -f, 275
calibredb-embed_metadata command line option
–only-formats, -f, 280 –list-fields, -l, 275
calibredb-export command line option
–all, 275 calibredb-show_metadata command line option
–dont-asciiize, 275
–dont-save-cover, 275 –as-opf, 274
–dont-update-metadata, 275
–dont-write-opf, 275 can_be_disabled (calibre.customize.Plugin attribute), 222
–formats, 275
–progress, 275 CAN_DO_DEVICE_DB_PLUGBOARD (cali-
–replace-whitespace, 275
–single-dir, 275 bre.devices.interface.DevicePlugin attribute),
–template, 275
–timefmt, 276 232
–to-dir, 276
–to-lowercase, 276 can_get_multiple_covers (cali-
calibredb-list command line option
–ascending, 272 bre.ebooks.metadata.sources.base.Source
–fields, -f, 272
–for-machine, 272 attribute), 226
–limit, 272
–line-width, -w, 272 can_handle() (calibre.devices.interface.DevicePlugin
–prefix, 272
–search, -s, 272 method), 234
–separator, 272
–sort-by, 272 can_handle_windows() (cali-
calibredb-list_categories command line option
–categories, -r, 280 bre.devices.interface.DevicePlugin method),
–csv, -c, 280
–dialect, 280 233
–item_count, -i, 280
–width, -w, 280 can_handle_windows() (cali-
calibredb-remove command line option
bre.devices.usbms.device.Device method),
Index
241

CAN_SET_METADATA (cali-

bre.devices.interface.DevicePlugin attribute),

232

canonicalize_internal_url() (cali-

bre.web.feeds.news.BasicNewsRecipe

method), 47

capabilities (calibre.ebooks.metadata.sources.base.Source

attribute), 226

card_prefix() (calibre.devices.interface.DevicePlugin

method), 234

card_prefix() (calibre.devices.usbms.device.Device

method), 240

CatalogPlugin (class in calibre.customize), 225

category (calibre.customize.PreferencesPlugin attribute),

246

category_order (calibre.customize.PreferencesPlugin at-

tribute), 246

center_navbar (calibre.web.feeds.news.BasicNewsRecipe

attribute), 51

change_font() (in module cali-

bre.ebooks.oeb.polish.fonts), 331

changed_signal (calibre.gui2.preferences.ConfigWidgetInterface

attribute), 247

clean_downloaded_metadata() (cali-

bre.ebooks.metadata.sources.base.Source

353

calibre User Manual, Release 3.35.0

method), 227 247

cleanup() (calibre.web.feeds.news.BasicNewsRecipe ConfigWidgetInterface (class in calibre.gui2.preferences),

method), 47 247

CLI (class in calibre.devices.usbms.cli), 242 Container (class in calibre.ebooks.oeb.polish.container),

cli_main() (calibre.customize.Plugin method), 223 325

cli_options (calibre.customize.CatalogPlugin attribute), contains(), 156

225 conversion_options (cali-

clone_browser() (calibre.web.feeds.news.BasicNewsRecipe bre.web.feeds.news.BasicNewsRecipe at-

method), 47 tribute), 51

close_editor() (calibre.gui2.tweak_book.boss.Boss convert() (calibre.customize.conversion.InputFormatPlugin

method), 333 method), 230

command line option convert() (calibre.customize.conversion.OutputFormatPlugin

–help, -h, 271 method), 231

–library-path, –with-library, 271 copy_cover_to() (calibre.db.cache.Cache method), 320

–password, 272 copy_format_to() (calibre.db.cache.Cache method), 320

–username, 272 core_usage (calibre.customize.conversion.InputFormatPlugin

–version, 272 attribute), 229

commit() (calibre.ebooks.oeb.polish.container.Container cover() (calibre.db.cache.Cache method), 320

method), 326 cover_margins (calibre.web.feeds.news.BasicNewsRecipe

commit() (calibre.gui2.preferences.ConfigWidgetBase attribute), 52

method), 248 create_action() (calibre.gui2.tweak_book.plugin.Tool

commit() (calibre.gui2.preferences.ConfigWidgetInterface method), 333

method), 247 create_inline_toc() (in module cali-

commit_all_editors_to_container() (cali- bre.ebooks.oeb.polish.toc), 331

bre.gui2.tweak_book.boss.Boss method), create_menu_action() (cali-

333 bre.gui2.actions.InterfaceAction method),

commit_item() (calibre.ebooks.oeb.polish.container.Container 245

method), 326 create_widget() (calibre.customize.PreferencesPlugin

common_options (cali- method), 247

bre.customize.conversion.InputFormatPlugin CSS, 335

attribute), 229 current_container (calibre.gui2.tweak_book.plugin.Tool

common_options (cali- attribute), 332

bre.customize.conversion.OutputFormatPlugin currently_editing (calibre.gui2.tweak_book.boss.Boss at-

attribute), 230 tribute), 333

compress_news_images (cali- custom_field_keys() (cali-

bre.web.feeds.news.BasicNewsRecipe at- bre.ebooks.metadata.book.base.Metadata

tribute), 51 method), 180

compress_news_images_auto_size (cali- customization_help() (calibre.customize.Plugin method),

bre.web.feeds.news.BasicNewsRecipe at- 223

tribute), 51 customization_help() (cali-

compress_news_images_max_size (cali- bre.ebooks.metadata.sources.base.Source

bre.web.feeds.news.BasicNewsRecipe at- method), 226

tribute), 51 customize_context_menu() (cali-

config_help_message (cali- bre.customize.ViewerPlugin method), 249

bre.ebooks.metadata.sources.base.Source customize_ui() (calibre.customize.ViewerPlugin

attribute), 226 method), 248

config_widget (calibre.customize.PreferencesPlugin at- D

tribute), 246

config_widget() (calibre.customize.Plugin method), 223 data_for_find_identical_books() (calibre.db.cache.Cache

config_widget() (calibre.devices.interface.DevicePlugin method), 320

class method), 236 data_for_has_book() (calibre.db.cache.Cache method),

config_widget() (calibre.ebooks.metadata.sources.base.Source 320

method), 227 debug_managed_device_detection() (cali-

ConfigWidgetBase (class in calibre.gui2.preferences), bre.devices.interface.DevicePlugin method),

354 Index

calibre User Manual, Release 3.35.0

233 –disable-font-rescaling, 284
–disable-format-scene-breaks, 286
deepcopy() (calibre.ebooks.metadata.book.base.Metadata –disable-italicize-common-cases, 286
–disable-markup-chapter-headings, 286
method), 179 –disable-remove-fake-margins, 287
–disable-renumber-headings, 286
default_cover() (calibre.web.feeds.news.BasicNewsRecipe –disable-unwrap-lines, 286
–duplicate-links-in-toc, 287
method), 47 –embed-all-fonts, 284
–embed-font-family, 284
delay (calibre.web.feeds.news.BasicNewsRecipe at- –enable-heuristics, 286
–expand-css, 284
tribute), 52 –extra-css, 284
–filter-css, 284
delete_books() (calibre.devices.interface.DevicePlugin –font-size-mapping, 284
–help, -h, 283
method), 236 –html-unwrap-factor, 286
–input-profile, 283
delete_books() (calibre.devices.usbms.driver.USBMS –insert-blank-line, 284
–insert-blank-line-size, 284
method), 243 –insert-metadata, 287
–isbn, 288
delete_custom_book_data() (calibre.db.cache.Cache –keep-ligatures, 284
–language, 288
method), 320 –level1-toc, 287
–level2-toc, 287
description (calibre.customize.Plugin attribute), 222 –level3-toc, 287
–line-height, 284
description (calibre.customize.PreferencesPlugin at- –linearize-tables, 284
–list-recipes, 283
tribute), 247 –margin-bottom, 285
–margin-left, 285
description (calibre.web.feeds.news.BasicNewsRecipe at- –margin-right, 285
–margin-top, 285
tribute), 52 –max-toc-links, 288
–minimum-line-height, 285
detect_managed_devices() (cali- –no-chapters-in-toc, 288
–output-profile, 283
bre.devices.interface.DevicePlugin method), –page-breaks-before, 287
–prefer-metadata-cover, 287
233 –pubdate, 288
–publisher, 288
Device (class in calibre.devices.usbms.device), 239 –rating, 288
–read-metadata-from-opf, –from-opf, -m, 288
DevicePlugin (class in calibre.devices.interface), 231 –remove-first-image, 287
–remove-paragraph-spacing, 285
dirty() (calibre.ebooks.oeb.polish.container.Container –remove-paragraph-spacing-indent-size, 285
–replace-scene-breaks, 286
method), 326 –search-replace, 286
–series, 288
do_user_config() (calibre.customize.Plugin method), 223 –series-index, 288
–smarten-punctuation, 285
dont_add_to (calibre.gui2.actions.InterfaceAction at- –sr1-replace, 286
–sr1-search, 286
tribute), 244

dont_remove_from (calibre.gui2.actions.InterfaceAction

attribute), 244

download() (calibre.web.feeds.news.BasicNewsRecipe

method), 47

download_cover() (cali-

bre.ebooks.metadata.sources.base.Source

method), 228

drop_event() (calibre.gui2.actions.InterfaceAction

method), 245

E

ebook-convert command line option
–asciiize, 283
–author-sort, 288
–authors, 288
–base-font-size, 283
–book-producer, 288
–change-justification, 283
–chapter, 287
–chapter-mark, 287
–comments, 288
–cover, 288
–debug-pipeline, -d, 289
–disable-dehyphenate, 285
–disable-delete-blank-paragraphs, 286
–disable-fix-indents, 286

Index 355

calibre User Manual, Release 3.35.0 ebook-convert-docx-output command line option
–docx-custom-page-size, 294
–sr2-replace, 286 –docx-no-cover, 294
–sr2-search, 286 –docx-no-toc, 294
–sr3-replace, 286 –docx-page-margin-bottom, 295
–sr3-search, 286 –docx-page-margin-left, 295
–start-reading-at, 287 –docx-page-margin-right, 295
–subset-embedded-fonts, 285 –docx-page-margin-top, 295
–tags, 289 –docx-page-size, 295
–timestamp, 289 –extract-to, 295
–title, 289 –preserve-cover-aspect-ratio, 295
–title-sort, 289 –pretty-print, 295
–toc-filter, 288
–toc-threshold, 288 ebook-convert-epub-input command line option
–transform-css-rules, 285 –input-encoding, 291
–unsmarten-punctuation, 285
–use-auto-toc, 288 ebook-convert-epub-output command line option
–verbose, -v, 289 –dont-split-on-page-breaks, 295
–version, 283 –epub-flatten, 295
ebook-convert-azw3-output command line option –epub-inline-toc, 295
–dont-compress, 294 –epub-toc-at-end, 295
–extract-to, 294 –epub-version, 295
–mobi-toc-at-start, 294 –extract-to, 295
–no-inline-toc, 294 –flow-size, 295
–prefer-author-sort, 294 –no-default-epub-cover, 295
–pretty-print, 294 –no-svg-cover, 296
–share-not-sync, 294 –preserve-cover-aspect-ratio, 296
–toc-title, 294 –pretty-print, 296
ebook-convert-azw4-input command line option –toc-title, 296
–input-encoding, 289
ebook-convert-chm-input command line option ebook-convert-fb2-input command line option
–input-encoding, 289 –input-encoding, 291
ebook-convert-comic-input command line option –no-inline-fb2-toc, 291
–colors, 289
–comic-image-size, 289 ebook-convert-fb2-output command line option
–despeckle, 289 –fb2-genre, 296
–disable-trim, 289 –pretty-print, 296
–dont-add-comic-pages-to-toc, 289 –sectionize, 296
–dont-grayscale, 289
–dont-normalize, 290 ebook-convert-htlz-input command line option
–dont-sharpen, 290 –input-encoding, 291
–input-encoding, 290
–keep-aspect-ratio, 290 ebook-convert-html-input command line option
–landscape, 290 –breadth-first, 291
–no-process, 290 –dont-package, 291
–no-sort, 290 –input-encoding, 291
–output-format, 290 –max-levels, 291
–right2left, 290
–wide, 290 ebook-convert-html-output command line option
ebook-convert-djvu-input command line option –extract-to, 296
–input-encoding, 290 –pretty-print, 296
ebook-convert-docx-input command line option –template-css, 297
–docx-inline-subsup, 290 –template-html, 297
–docx-no-cover, 290 –template-html-index, 297
–docx-no-pagebreaks-between-notes, 290
–input-encoding, 290 ebook-convert-htmlz-output command line option
–htmlz-class-style, 297
356 –htmlz-css-type, 297
–htmlz-title-filename, 297
–pretty-print, 297

ebook-convert-lit-input command line option
–input-encoding, 291

Index

ebook-convert-lit-output command line option calibre User Manual, Release 3.35.0
–pretty-print, 297
–pdf-header-template, 299
ebook-convert-lrf-input command line option –pdf-hyphenate, 299
–input-encoding, 291 –pdf-mark-links, 299
–pdf-mono-family, 299
ebook-convert-lrf-output command line option –pdf-mono-font-size, 299
–enable-autorotation, 297 –pdf-page-margin-bottom, 300
–header, 297 –pdf-page-margin-left, 300
–header-format, 297 –pdf-page-margin-right, 300
–header-separation, 297 –pdf-page-margin-top, 300
–minimum-indent, 297 –pdf-page-number-map, 300
–mono-family, 297 –pdf-page-numbers, 300
–pretty-print, 297 –pdf-sans-family, 300
–render-tables-as-images, 297 –pdf-serif-family, 300
–sans-family, 297 –pdf-standard-font, 300
–serif-family, 298 –pdf-use-document-margins, 300
–text-size-multiplier-for-rendered-tables, 298 –preserve-cover-aspect-ratio, 300
–wordspace, 298 –pretty-print, 300
–toc-title, 300
ebook-convert-mobi-input command line option –uncompressed-pdf, 300
–input-encoding, 292 –unit, -u, 300
–use-profile-size, 300
ebook-convert-mobi-output command line option ebook-convert-pml-input command line option
–dont-compress, 298 –input-encoding, 292
–extract-to, 298 ebook-convert-pml-output command line option
–mobi-file-type, 298 –full-image-depth, 301
–mobi-ignore-margins, 298 –inline-toc, 301
–mobi-keep-original-images, 298 –pml-output-encoding, 301
–mobi-toc-at-start, 298 –pretty-print, 301
–no-inline-toc, 298 ebook-convert-rb-input command line option
–personal-doc, 298 –input-encoding, 292
–prefer-author-sort, 298 ebook-convert-rb-output command line option
–pretty-print, 298 –inline-toc, 301
–share-not-sync, 298 –pretty-print, 301
–toc-title, 298 ebook-convert-recipe-input command line option
–dont-download-recipe, 293
ebook-convert-odt-input command line option –input-encoding, 293
–input-encoding, 292 –lrf, 293
–password, 293
ebook-convert-oeb-output command line option –test, 293
–pretty-print, 299 –username, 293
ebook-convert-rtf-input command line option
ebook-convert-pdb-input command line option –ignore-wmf, 292
–input-encoding, 292 –input-encoding, 292
ebook-convert-rtf-output command line option
ebook-convert-pdb-output command line option –pretty-print, 301
–format, -f, 299 ebook-convert-snb-input command line option
–inline-toc, 299 –input-encoding, 293
–pdb-output-encoding, 299 ebook-convert-snb-output command line option
–pretty-print, 299 –pretty-print, 301
–snb-dont-indent-first-line, 301
ebook-convert-pdf-input command line option –snb-full-screen, 301
–input-encoding, 292 –snb-hide-chapter-name, 301
–new-pdf-engine, 292 –snb-insert-empty-line, 301
–no-images, 292 –snb-max-line-length, 301
–unwrap-factor, 292
357
ebook-convert-pdf-output command line option
–custom-size, 299
–paper-size, 299
–pdf-add-toc, 299
–pdf-default-font-size, 299
–pdf-footer-template, 299

Index

calibre User Manual, Release 3.35.0 –lrf-bookid, 305

–snb-output-encoding, 301 –publisher, -p, 305
ebook-convert-tcr-input command line option
–rating, -r, 305
–input-encoding, 293
ebook-convert-tcr-output command line option –series, -s, 305

–pretty-print, 302 –tags, 305
–tcr-output-encoding, 302
ebook-convert-txt-input command line option –title, -t, 305
–formatting-type, 293
–input-encoding, 293 –title-sort, 305
–markdown-extensions, 293
–paragraph-type, 294 –to-opf, 305
–preserve-spaces, 294
–txt-in-remove-indents, 294 –version, 305
ebook-convert-txt-output command line option
–force-max-line-length, 302 ebook-polish command line option
–inline-toc, 302
–keep-color, 302 –compress-images, -i, 305
–keep-image-references, 302
–keep-links, 302 –cover, -c, 305
–max-line-length, 302
–newline, -n, 302 –embed-fonts, -e, 305
–pretty-print, 302
–txt-output-encoding, 302 –help, -h, 305
–txt-output-formatting, 302
ebook-convert-txtz-output command line option –jacket, -j, 305
–force-max-line-length, 302
–inline-toc, 302 –opf, -o, 306
–keep-color, 302
–keep-image-references, 303 –remove-jacket, 306
–keep-links, 303
–max-line-length, 303 –remove-unused-css, -u, 306
–newline, -n, 303
–pretty-print, 303 –smarten-punctuation, -p, 306
–txt-output-encoding, 303
–txt-output-formatting, 303 –subset-fonts, -f, 306
ebook-edit command line option
–detach, 303 –upgrade-book, -U, 306
–help, -h, 303
–version, 303 –verbose, 306
ebook-meta command line option
–author-sort, 304 –version, 306
–authors, -a, 304
–book-producer, -k, 304 ebook-viewer command line option
–category, 304
–comments, -c, 304 –continue, 306
–cover, 304
–date, -d, 304 –debug-javascript, 306
–from-opf, 304
–get-cover, 304 –detach, 306
–help, -h, 304
–identifier, 304 –full-screen, –fullscreen, -f, 306
–index, -i, 304
–isbn, 304 –help, -h, 306
–language, -l, 304
–open-at, 307
358
–raise-window, 307

–version, 307

edit_file() (calibre.gui2.tweak_book.boss.Boss method),

333

eject() (calibre.devices.interface.DevicePlugin method),

234

eject() (calibre.devices.usbms.device.Device method),

241

embed_metadata() (calibre.db.cache.Cache method), 320

encoding (calibre.web.feeds.news.BasicNewsRecipe at-

tribute), 52

exists() (calibre.ebooks.oeb.polish.container.Container

method), 326

extra_css (calibre.web.feeds.news.BasicNewsRecipe at-

tribute), 52

extract_readable_article() (cali-

bre.web.feeds.news.BasicNewsRecipe

method), 47

F

fast_field_for() (calibre.db.cache.Cache method), 320
feeds (calibre.web.feeds.news.BasicNewsRecipe at-

tribute), 52
fetch-ebook-metadata command line option

Index

calibre User Manual, Release 3.35.0

–allowed-plugin, -p, 307 method), 240

–authors, -a, 307 from_files() (in module calibre.ebooks.oeb.polish.toc),

–cover, -c, 307 331

–help, -h, 307 from_links() (in module calibre.ebooks.oeb.polish.toc),

–identifier, -I, 307 331

–isbn, -i, 307 from_xpaths() (in module calibre.ebooks.oeb.polish.toc),

–opf, -o, 307 331

–timeout, -d, 307 G
–title, -t, 307

–verbose, -v, 307 generate_item() (calibre.ebooks.oeb.polish.container.Container

–version, 307 method), 326

field_for() (calibre.db.cache.Cache method), 320 genesis() (calibre.gui2.actions.InterfaceAction method),

field_ids_for() (calibre.db.cache.Cache method), 321 245

file_type (calibre.customize.conversion.OutputFormatPlugingenesis() (calibre.gui2.preferences.ConfigWidgetInterface

attribute), 230 method), 247

file_types (calibre.customize.CatalogPlugin attribute), get_all_standard_metadata() (cali-

225 bre.ebooks.metadata.book.base.Metadata

file_types (calibre.customize.conversion.InputFormatPlugin method), 180

attribute), 229 get_all_user_metadata() (cali-

file_types (calibre.customize.FileTypePlugin attribute), bre.ebooks.metadata.book.base.Metadata

224 method), 180

file_types (calibre.customize.MetadataReaderPlugin at- get_annotations() (calibre.devices.usbms.device.Device

tribute), 225 method), 241

file_types (calibre.customize.MetadataWriterPlugin at- get_article_url() (calibre.web.feeds.news.BasicNewsRecipe

tribute), 225 method), 47

filename_callback() (cali- get_author_tokens() (cali-

bre.devices.usbms.device.Device method), bre.ebooks.metadata.sources.base.Source

241 method), 227

filesize() (calibre.ebooks.oeb.polish.container.Container get_book_url() (calibre.ebooks.metadata.sources.base.Source

method), 326 method), 227

FileTypePlugin (class in calibre.customize), 224 get_book_url_name() (cali-

filter_css() (in module calibre.ebooks.oeb.polish.css), 331 bre.ebooks.metadata.sources.base.Source

filter_regexps (calibre.web.feeds.news.BasicNewsRecipe method), 227

attribute), 52 get_book_urls() (calibre.ebooks.metadata.sources.base.Source

find_identical_books() (calibre.db.cache.Cache method), method), 227

321 get_browser() (calibre.web.feeds.news.BasicNewsRecipe

fix_all_html() (in module cali- method), 48

bre.ebooks.oeb.polish.pretty), 329 get_cached_cover_url() (cali-

fix_html() (in module calibre.ebooks.oeb.polish.pretty), bre.ebooks.metadata.sources.base.Source

329 method), 227

for_viewer (calibre.customize.conversion.InputFormatPluginget_categories() (calibre.db.cache.Cache method), 321

attribute), 229 get_collections() (calibre.devices.interface.BookList

format() (calibre.db.cache.Cache method), 321 method), 239

format_abspath() (calibre.db.cache.Cache method), 321 get_cover_url() (calibre.web.feeds.news.BasicNewsRecipe

format_field() (calibre.ebooks.metadata.book.base.Metadata method), 48

method), 180 get_custom_book_data() (calibre.db.cache.Cache

format_hash() (calibre.db.cache.Cache method), 321 method), 322

format_metadata() (calibre.db.cache.Cache method), 321 get_device_information() (cali-

FORMATS (calibre.devices.interface.DevicePlugin at- bre.devices.interface.DevicePlugin method),

tribute), 231 234

formats() (calibre.db.cache.Cache method), 321 get_device_information() (cali-

free_space() (calibre.devices.interface.DevicePlugin bre.devices.usbms.driver.USBMS method),

method), 235 242

free_space() (calibre.devices.usbms.device.Device

Index 359

calibre User Manual, Release 3.35.0

get_device_uid() (calibre.devices.interface.DevicePlugin get_user_metadata() (cali-

method), 237 bre.ebooks.metadata.book.base.Metadata

get_driveinfo() (calibre.devices.interface.DevicePlugin method), 180

method), 234 gui (calibre.gui2.tweak_book.plugin.Tool attribute), 332

get_extra_css() (calibre.web.feeds.news.BasicNewsRecipe gui_category (calibre.customize.PreferencesPlugin

method), 48 attribute), 246

get_feeds() (calibre.web.feeds.news.BasicNewsRecipe gui_configuration_widget() (cali-

method), 48 bre.customize.conversion.InputFormatPlugin

get_file() (calibre.devices.interface.DevicePlugin method), 230

method), 236 gui_configuration_widget() (cali-

get_file_path_for_processing() (cali- bre.customize.conversion.OutputFormatPlugin

bre.ebooks.oeb.polish.container.Container method), 231

method), 326 gui_layout_complete() (cali-

get_id_map() (calibre.db.cache.Cache method), 322 bre.gui2.actions.InterfaceAction method),

get_identifiers() (calibre.ebooks.metadata.book.base.Metadata 246

method), 180 gui_name (calibre.customize.PreferencesPlugin at-

get_ids_for_custom_book_data() (cali- tribute), 246

bre.db.cache.Cache method), 322 guide_type_map (calibre.ebooks.oeb.polish.container.Container

get_images() (calibre.customize.conversion.InputFormatPlugin attribute), 326

method), 230 H
get_item_id() (calibre.db.cache.Cache method), 322

get_item_ids() (calibre.db.cache.Cache method), 322 handle_gzip (calibre.web.feeds.news.BasicNewsRecipe

get_item_name() (calibre.db.cache.Cache method), 322 attribute), 52

get_masthead_title() (cali- has_book() (calibre.db.cache.Cache method), 322

bre.web.feeds.news.BasicNewsRecipe has_format() (calibre.db.cache.Cache method), 322

method), 48 has_html_comments (cali-

get_masthead_url() (cali- bre.ebooks.metadata.sources.base.Source

bre.web.feeds.news.BasicNewsRecipe attribute), 226

method), 48 has_id() (calibre.db.cache.Cache method), 322

get_metadata() (calibre.customize.MetadataReaderPlugin has_name() (calibre.ebooks.oeb.polish.container.Container

method), 225 method), 326

get_metadata() (calibre.db.cache.Cache method), 322 href_to_name() (calibre.ebooks.oeb.polish.container.Container

get_next_series_num_for() (calibre.db.cache.Cache method), 326

method), 322 HTML, 335

get_obfuscated_article() (cali- I

bre.web.feeds.news.BasicNewsRecipe

method), 48 icon (calibre.customize.PreferencesPlugin attribute), 246

get_option() (calibre.devices.interface.DevicePlugin icon (calibre.devices.interface.DevicePlugin attribute),

method), 237 232

get_proxy_metadata() (calibre.db.cache.Cache method), id_from_url() (calibre.ebooks.metadata.sources.base.Source

322 method), 228

get_recommended_folders() (in module cali- identify() (calibre.ebooks.metadata.sources.base.Source

bre.ebooks.oeb.polish.replace), 329 method), 228

get_standard_metadata() (cali- identify_results_keygen() (cali-

bre.ebooks.metadata.book.base.Metadata bre.ebooks.metadata.sources.base.Source

method), 180 method), 228

get_title_tokens() (cali- ignore_connected_device() (cali-

bre.ebooks.metadata.sources.base.Source bre.devices.interface.DevicePlugin method),

method), 227 237

get_usage_count_by_id() (calibre.db.cache.Cache ignore_duplicate_articles (cali-

method), 322 bre.web.feeds.news.BasicNewsRecipe at-

get_user_blacklisted_devices() (cali- tribute), 52

bre.devices.interface.DevicePlugin method), ignore_ssl_errors (cali-

237 bre.ebooks.metadata.sources.base.Source

360 Index

calibre User Manual, Release 3.35.0

attribute), 226 tribute), 53

image_url_processor() (cali- library_changed() (calibre.gui2.actions.InterfaceAction

bre.web.feeds.news.BasicNewsRecipe class method), 246

method), 48 load_actual_plugin() (cali-

index_to_soup() (calibre.web.feeds.news.BasicNewsRecipe bre.customize.InterfaceActionBase method),

method), 48 246

init() (calibre.db.cache.Cache method), 322 load_fonts() (calibre.customize.ViewerPlugin method),

initialization_complete() (cali- 248

bre.gui2.actions.InterfaceAction method), load_javascript() (calibre.customize.ViewerPlugin

246 method), 248

initialize() (calibre.customize.CatalogPlugin method), load_resources() (calibre.customize.Plugin method), 223

225 load_resources() (calibre.gui2.actions.InterfaceAction

initialize() (calibre.customize.Plugin method), 222 method), 245

initialize() (calibre.gui2.preferences.ConfigWidgetBase location_selected() (calibre.gui2.actions.InterfaceAction

method), 248 method), 246

initialize() (calibre.gui2.preferences.ConfigWidgetInterface LRF, 335

method), 247 lrf2lrs command line option

InputFormatPlugin (class in cali- –dont-output-resources, 308

bre.customize.conversion), 229 –help, -h, 308

insert_into_xml() (cali- –output, -o, 308

bre.ebooks.oeb.polish.container.Container –verbose, 308

method), 326 –version, 308

InterfaceAction (class in calibre.gui2.actions), 243 lrfviewer command line option

InterfaceActionBase (class in calibre.customize), 246 –disable-hyphenation, 308

InternalMetadataCompareKeyGen (class in cali- –help, -h, 308

bre.ebooks.metadata.sources.base), 229 –profile, 308

is_configured() (calibre.ebooks.metadata.sources.base.Source –verbose, 308

method), 226 –version, 308

is_dir (calibre.ebooks.oeb.polish.container.Container at- –visual-debug, 308

tribute), 326 –white-background, 308

is_dynamically_controllable() (cali- lrs2lrf command line option

bre.devices.interface.DevicePlugin method), –help, -h, 309

237 –lrs, 309

is_image_collection (cali- –output, -o, 309

bre.customize.conversion.InputFormatPlugin –verbose, 309

attribute), 229 –version, 309

is_link_wanted() (calibre.web.feeds.news.BasicNewsRecipe M

method), 49

is_null() (calibre.ebooks.metadata.book.base.Metadata make_name_unique() (cali-

method), 179 bre.ebooks.oeb.polish.container.Container

is_running() (calibre.devices.interface.DevicePlugin method), 327

method), 238 MANAGES_DEVICE_PRESENCE (cali-

is_usb_connected() (cali- bre.devices.interface.DevicePlugin attribute),

bre.devices.interface.DevicePlugin method), 232

233 manifest_has_name() (cali-

iterlinks() (calibre.ebooks.oeb.polish.container.Container bre.ebooks.oeb.polish.container.Container

method), 326 method), 327

manifest_id_map (cali-
K bre.ebooks.oeb.polish.container.Container

keep_only_tags (calibre.web.feeds.news.BasicNewsRecipe attribute), 327

attribute), 53 manifest_items_of_type() (cali-

bre.ebooks.oeb.polish.container.Container

L method), 327

language (calibre.web.feeds.news.BasicNewsRecipe at-

Index 361

calibre User Manual, Release 3.35.0

manifest_items_with_property() (cali- names_that_need_not_be_manifested (cali-

bre.ebooks.oeb.polish.container.Container bre.ebooks.oeb.polish.container.Container

method), 327 attribute), 327

manifest_type_map (cali- needs_subscription (cali-

bre.ebooks.oeb.polish.container.Container bre.web.feeds.news.BasicNewsRecipe at-

attribute), 327 tribute), 53

mark_as_cover() (in module cali- NEWS_IN_FOLDER (cali-

bre.ebooks.oeb.polish.cover), 330 bre.devices.usbms.device.Device attribute),

mark_as_titlepage() (in module cali- 240

bre.ebooks.oeb.polish.cover), 331 no_stylesheets (calibre.web.feeds.news.BasicNewsRecipe

masthead_url (calibre.web.feeds.news.BasicNewsRecipe attribute), 53

attribute), 53 normalize_path() (calibre.devices.usbms.driver.USBMS

match_regexps (calibre.web.feeds.news.BasicNewsRecipe class method), 243

attribute), 53 NUKE_COMMENTS (cali-

max_articles_per_feed (cali- bre.devices.interface.DevicePlugin attribute),

bre.web.feeds.news.BasicNewsRecipe at- 232

tribute), 53

MAX_PATH_LEN (calibre.devices.usbms.device.Device O

attribute), 240 oldest_article (calibre.web.feeds.news.BasicNewsRecipe

merge() (in module calibre.ebooks.oeb.polish.split), 330 attribute), 53

Metadata (class in calibre.ebooks.metadata.book.base), on_import (calibre.customize.FileTypePlugin attribute),

179 224

metadata_for_field() (cali- on_postimport (calibre.customize.FileTypePlugin at-

bre.ebooks.metadata.book.base.Metadata tribute), 224

method), 180 on_postprocess (calibre.customize.FileTypePlugin

MetadataReaderPlugin (class in calibre.customize), 225 attribute), 224

MetadataWriterPlugin (class in calibre.customize), 225 on_preprocess (calibre.customize.FileTypePlugin at-

mi (calibre.ebooks.oeb.polish.container.Container at- tribute), 224

tribute), 327 open() (calibre.devices.interface.DevicePlugin method),

minimum_calibre_version (calibre.customize.Plugin at- 234

tribute), 222 open() (calibre.devices.usbms.device.Device method),

multisort() (calibre.db.cache.Cache method), 322 241

multisplit() (in module calibre.ebooks.oeb.polish.split), open() (calibre.ebooks.oeb.polish.container.Container

330 method), 327

N open_book() (calibre.gui2.tweak_book.boss.Boss

method), 334

name (calibre.customize.Plugin attribute), 222 OPEN_FEEDBACK_MESSAGE (cali-

name (calibre.gui2.actions.InterfaceAction attribute), 244 bre.devices.interface.DevicePlugin attribute),

name (calibre.gui2.tweak_book.plugin.Tool attribute), 232

332 opf (calibre.ebooks.oeb.polish.container.Container

name(), 156 attribute), 327

name_order (calibre.customize.PreferencesPlugin at- opf_get_or_create() (cali-

tribute), 246 bre.ebooks.oeb.polish.container.Container

name_to_abspath() (cali- method), 327

bre.ebooks.oeb.polish.container.Container opf_version (calibre.ebooks.oeb.polish.container.Container

method), 327 attribute), 327

name_to_href() (calibre.ebooks.oeb.polish.container.Containoeprf_version_parsed (cali-

method), 327 bre.ebooks.oeb.polish.container.Container

names_that_must_not_be_changed (cali- attribute), 327

bre.ebooks.oeb.polish.container.Container opf_xpath() (calibre.ebooks.oeb.polish.container.Container

attribute), 327 method), 327

names_that_must_not_be_removed (cali- options (calibre.customize.conversion.InputFormatPlugin

bre.ebooks.oeb.polish.container.Container attribute), 230

attribute), 327

362 Index

calibre User Manual, Release 3.35.0

options (calibre.customize.conversion.OutputFormatPlugin preprocess_html() (cali-

attribute), 230 bre.web.feeds.news.BasicNewsRecipe

options (calibre.ebooks.metadata.sources.base.Source at- method), 50

tribute), 226 preprocess_image() (cali-

OSX_MAIN_MEM_VOL_PAT (cali- bre.web.feeds.news.BasicNewsRecipe

bre.devices.usbms.device.Device attribute), method), 50

240 preprocess_raw_html() (cali-

output_encoding (calibre.customize.conversion.InputFormatPlugin bre.web.feeds.news.BasicNewsRecipe

attribute), 229 method), 50

OutputFormatPlugin (class in cali- preprocess_regexps (cali-

bre.customize.conversion), 230 bre.web.feeds.news.BasicNewsRecipe at-

tribute), 53

P pretty_all() (in module calibre.ebooks.oeb.polish.pretty),

parse_feeds() (calibre.web.feeds.news.BasicNewsRecipe 329

method), 49 pretty_css() (in module calibre.ebooks.oeb.polish.pretty),

parse_index() (calibre.web.feeds.news.BasicNewsRecipe 329

method), 49 pretty_html() (in module cali-

parsed() (calibre.ebooks.oeb.polish.container.Container bre.ebooks.oeb.polish.pretty), 329

method), 328 pretty_xml() (in module cali-

path_sep (calibre.devices.interface.DevicePlugin at- bre.ebooks.oeb.polish.pretty), 329

tribute), 232 print_version() (calibre.web.feeds.news.BasicNewsRecipe

Plugin (class in calibre.customize), 222 class method), 50

populate_article_metadata() (cali- priority (calibre.customize.Plugin attribute), 222

bre.web.feeds.news.BasicNewsRecipe priority (calibre.gui2.actions.InterfaceAction attribute),

method), 49 244

popup_type (calibre.gui2.actions.InterfaceAction at- PRODUCT_ID (calibre.devices.interface.DevicePlugin

tribute), 244 attribute), 232

post_yank_cleanup() (cali- publication_type (calibre.web.feeds.news.BasicNewsRecipe

bre.devices.interface.DevicePlugin method), attribute), 54

234 (cali- R
post_yank_cleanup()

bre.devices.usbms.device.Device method), raw_data() (calibre.ebooks.oeb.polish.container.Container

241 method), 328

postadd() (calibre.customize.FileTypePlugin method), re:test(), 156

224 read_backup() (calibre.db.cache.Cache method), 323

postimport() (calibre.customize.FileTypePlugin method), recipe, 335

224 recipe_disabled (calibre.web.feeds.news.BasicNewsRecipe

postprocess_book() (cali- attribute), 54

bre.customize.conversion.InputFormatPlugin recommendations (cali-

method), 230 bre.customize.conversion.InputFormatPlugin

postprocess_book() (cali- attribute), 230

bre.web.feeds.news.BasicNewsRecipe recommendations (cali-

method), 49 bre.customize.conversion.OutputFormatPlugin

postprocess_html() (cali- attribute), 231

bre.web.feeds.news.BasicNewsRecipe recursions (calibre.web.feeds.news.BasicNewsRecipe at-

method), 50 tribute), 54

pref() (calibre.db.cache.Cache method), 323 refresh_gui() (calibre.gui2.preferences.ConfigWidgetInterface

prefer_results_with_isbn (cali- method), 247

bre.ebooks.metadata.sources.base.Source regexp, 335

attribute), 226 register() (calibre.gui2.preferences.ConfigWidgetBase

PreferencesPlugin (class in calibre.customize), 246 method), 247

prepare_addable_books() (cali- register_shortcut() (calibre.gui2.tweak_book.plugin.Tool

bre.devices.interface.DevicePlugin method), method), 332

236

Index 363

calibre User Manual, Release 3.35.0

relpath() (calibre.ebooks.oeb.polish.container.Container attribute), 55

method), 328 reset() (calibre.devices.interface.DevicePlugin method),

remove_attributes (cali- 233

bre.web.feeds.news.BasicNewsRecipe at- reset() (calibre.devices.usbms.device.Device method),

tribute), 54 240

remove_book() (calibre.devices.interface.BookList resolve_internal_links (cali-

method), 239 bre.web.feeds.news.BasicNewsRecipe at-

remove_books() (calibre.db.cache.Cache method), 323 tribute), 55

remove_books_from_metadata() (cali- restart_critical (calibre.gui2.preferences.ConfigWidgetInterface

bre.devices.interface.DevicePlugin class attribute), 247

method), 236 restore_book() (calibre.db.cache.Cache method), 323

remove_books_from_metadata() (cali- restore_defaults() (cali-

bre.devices.usbms.driver.USBMS method), bre.gui2.preferences.ConfigWidgetBase

243 method), 248

remove_empty_feeds (cali- restore_defaults() (cali-

bre.web.feeds.news.BasicNewsRecipe at- bre.gui2.preferences.ConfigWidgetInterface

tribute), 54 method), 247

remove_formats() (calibre.db.cache.Cache method), 323 restore_defaults_desc (cali-

remove_from_spine() (cali- bre.gui2.preferences.ConfigWidgetInterface

bre.ebooks.oeb.polish.container.Container attribute), 247

method), 328 restore_original_format() (calibre.db.cache.Cache

remove_from_xml() (cali- method), 323

bre.ebooks.oeb.polish.container.Container reverse_article_order (cali-

method), 328 bre.web.feeds.news.BasicNewsRecipe at-

remove_item() (calibre.ebooks.oeb.polish.container.Container tribute), 55

method), 328 rewind_savepoint() (calibre.gui2.tweak_book.boss.Boss

remove_items() (calibre.db.cache.Cache method), 323 method), 334

remove_jacket() (in module cali- RSS, 335

bre.ebooks.oeb.polish.jacket), 330 run() (calibre.customize.CatalogPlugin method), 225

remove_javascript (cali- run() (calibre.customize.FileTypePlugin method), 224

bre.web.feeds.news.BasicNewsRecipe at- run_javascript() (calibre.customize.ViewerPlugin

tribute), 54 method), 248

remove_tags (calibre.web.feeds.news.BasicNewsRecipe S

attribute), 54

remove_tags_after (cali- safe_read_lock (calibre.db.cache.Cache attribute), 323

bre.web.feeds.news.BasicNewsRecipe at- sanitize_callback() (calibre.devices.usbms.device.Device

tribute), 54 method), 241

remove_tags_before (cali- sanitize_path_components() (cali-

bre.web.feeds.news.BasicNewsRecipe at- bre.devices.usbms.device.Device method),

tribute), 54 241

remove_unused_css() (in module cali- save_book() (calibre.gui2.tweak_book.boss.Boss

bre.ebooks.oeb.polish.css), 331 method), 334

rename() (calibre.ebooks.oeb.polish.container.Container save_original_format() (calibre.db.cache.Cache method),

method), 328 323

rename_files() (in module cali- save_settings() (calibre.customize.Plugin method), 223

bre.ebooks.oeb.polish.replace), 329 save_settings() (calibre.devices.interface.DevicePlugin

rename_items() (calibre.db.cache.Cache method), 323 class method), 236

replace() (calibre.ebooks.oeb.polish.container.Container save_settings() (calibre.ebooks.metadata.sources.base.Source

method), 328 method), 227

replace_links() (calibre.ebooks.oeb.polish.container.Containsecrale_news_images (cali-

method), 328 bre.web.feeds.news.BasicNewsRecipe at-

replace_links() (in module cali- tribute), 55

bre.ebooks.oeb.polish.replace), 329 scale_news_images_to_device (cali-

requires_version (calibre.web.feeds.news.BasicNewsRecipe bre.web.feeds.news.BasicNewsRecipe at-

364 Index

calibre User Manual, Release 3.35.0

tribute), 55 method), 334

search() (calibre.db.cache.Cache method), 324 shutdown() (calibre.devices.interface.DevicePlugin

serialize_item() (calibre.ebooks.oeb.polish.container.Container method), 237

method), 328 shutting_down() (calibre.gui2.actions.InterfaceAction

set_all_user_metadata() (cali- method), 246

bre.ebooks.metadata.book.base.Metadata simultaneous_downloads (cali-

method), 180 bre.web.feeds.news.BasicNewsRecipe at-

set_conversion_options() (calibre.db.cache.Cache tribute), 55

method), 324 skip_ad_pages() (calibre.web.feeds.news.BasicNewsRecipe

set_cover() (calibre.db.cache.Cache method), 324 method), 50

set_cover() (in module calibre.ebooks.oeb.polish.cover), SLOW_DRIVEINFO (cali-

330 bre.devices.interface.DevicePlugin attribute),

set_driveinfo_name() (cali- 233

bre.devices.interface.DevicePlugin method), smart_update() (calibre.ebooks.metadata.book.base.Metadata

236 method), 180

set_driveinfo_name() (cali- sort_index_by() (calibre.web.feeds.news.BasicNewsRecipe

bre.devices.usbms.driver.USBMS method), method), 50

242 Source (class in calibre.ebooks.metadata.sources.base),

set_field() (calibre.db.cache.Cache method), 324 226

set_identifier() (calibre.ebooks.metadata.book.base.Metadataspecialize() (calibre.customize.conversion.InputFormatPlugin

method), 180 method), 230

set_identifiers() (calibre.ebooks.metadata.book.base.Metadastapecialize_css_for_output() (cali-

method), 180 bre.customize.conversion.OutputFormatPlugin

set_library_info() (calibre.devices.interface.DevicePlugin method), 231

method), 237 specialize_global_preferences() (cali-

set_metadata() (calibre.customize.MetadataWriterPlugin bre.devices.interface.DevicePlugin method),

method), 225 237

set_metadata() (calibre.db.cache.Cache method), 324 specialize_options() (cali-

set_modified() (calibre.gui2.tweak_book.boss.Boss bre.customize.conversion.OutputFormatPlugin

method), 334 method), 231

set_option() (calibre.devices.interface.DevicePlugin spine_items (calibre.ebooks.oeb.polish.container.Container

method), 238 attribute), 328

set_plugboards() (calibre.devices.interface.DevicePlugin spine_iter (calibre.ebooks.oeb.polish.container.Container

method), 236 attribute), 328

set_pref() (calibre.db.cache.Cache method), 324 spine_names (calibre.ebooks.oeb.polish.container.Container

set_progress_reporter() (cali- attribute), 329

bre.devices.interface.DevicePlugin method), split() (in module calibre.ebooks.oeb.polish.split), 330

234 split_jobs() (calibre.ebooks.metadata.sources.base.Source

set_progress_reporter() (cali- method), 227

bre.devices.usbms.device.Device method), standard_field_keys() (cali-

240 bre.ebooks.metadata.book.base.Metadata

set_spine() (calibre.ebooks.oeb.polish.container.Container method), 180

method), 328 STANDARD_METADATA_FIELDS (in module cali-

set_user_blacklisted_devices() (cali- bre.ebooks.metadata.book.base), 181

bre.devices.interface.DevicePlugin method), start_plugin() (calibre.devices.interface.DevicePlugin

237 method), 237

set_user_metadata() (cali- startup() (calibre.devices.interface.DevicePlugin

bre.ebooks.metadata.book.base.Metadata method), 237

method), 180 stop_plugin() (calibre.devices.interface.DevicePlugin

settings() (calibre.devices.interface.DevicePlugin class method), 237

method), 236 summary_length (calibre.web.feeds.news.BasicNewsRecipe

show_current_diff() (calibre.gui2.tweak_book.boss.Boss attribute), 55

method), 334 supported_platforms (calibre.customize.Plugin attribute),

show_editor() (calibre.gui2.tweak_book.boss.Boss 222

Index 365

calibre User Manual, Release 3.35.0

supports_collections() (cali- touched_fields (calibre.ebooks.metadata.sources.base.Source

bre.devices.interface.BookList method), attribute), 226

238 type (calibre.customize.Plugin attribute), 222

supports_gzip_transfer_encoding (cali- type (calibre.customize.ViewerPlugin attribute), 248

bre.ebooks.metadata.sources.base.Source U
attribute), 226

supports_restoring_to_defaults (cali- upload_books() (calibre.devices.interface.DevicePlugin

bre.gui2.preferences.ConfigWidgetInterface method), 235

attribute), 247 upload_books() (calibre.devices.usbms.driver.USBMS

sync_booklists() (calibre.devices.interface.DevicePlugin method), 242

method), 236 upload_cover() (calibre.devices.usbms.driver.USBMS

sync_booklists() (calibre.devices.usbms.driver.USBMS method), 242

method), 243 URL, 335

sync_preview_to_editor() (cali- USBMS (class in calibre.devices.usbms.driver), 242

bre.gui2.tweak_book.boss.Boss method), use_embedded_content (cali-

334 bre.web.feeds.news.BasicNewsRecipe at-

synchronize_with_db() (cali- tribute), 55

bre.devices.interface.DevicePlugin method), user_categories_for_books() (calibre.db.cache.Cache

238 method), 325

T user_feedback_after_callback (cali-

bre.devices.interface.DevicePlugin attribute),

tag_to_string() (calibre.web.feeds.news.BasicNewsRecipe 233

class method), 51 UserAnnotation (calibre.devices.interface.DevicePlugin

tags_older_than() (calibre.db.cache.Cache method), 324 attribute), 232

template_css (calibre.web.feeds.news.BasicNewsRecipe V

attribute), 55

template_to_attribute() (cali- VENDOR_ID (calibre.devices.interface.DevicePlugin at-

bre.ebooks.metadata.book.base.Metadata tribute), 231

method), 180 version (calibre.customize.Plugin attribute), 222

temporary_file() (calibre.customize.Plugin method), 223 ViewerPlugin (class in calibre.customize), 248

test_fields() (calibre.ebooks.metadata.sources.base.Source VIRTUAL_BOOK_EXTENSION_MESSAGE (cali-

method), 227 bre.devices.interface.DevicePlugin attribute),

THUMBNAIL_COMPRESSION_QUALITY (cali- 232

bre.devices.interface.DevicePlugin attribute), VIRTUAL_BOOK_EXTENSIONS (cali-

232 bre.devices.interface.DevicePlugin attribute),

THUMBNAIL_HEIGHT (cali- 232

bre.devices.interface.DevicePlugin attribute),

232 W

timefmt (calibre.web.feeds.news.BasicNewsRecipe at- WANTS_UPDATED_THUMBNAILS (cali-
bre.devices.interface.DevicePlugin attribute),
tribute), 55 232

timeout (calibre.web.feeds.news.BasicNewsRecipe web2disk command line option
–base-dir, -d, 309
attribute), 55 –delay, 309
–dont-download-stylesheets, 309
title (calibre.web.feeds.news.BasicNewsRecipe attribute), –encoding, 309
–filter-regexp, 309
55 –help, -h, 309
–match-regexp, 309
to_html() (calibre.ebooks.metadata.book.base.Metadata –max-files, -n, 309
–max-recursions, -r, 310
method), 180 –timeout, -t, 310
–verbose, 310
Tool (class in calibre.gui2.tweak_book.plugin), 332 –version, 310

toolbar_button_popup_mode (cali-

bre.gui2.tweak_book.plugin.Tool attribute),

332

total_space() (calibre.devices.interface.DevicePlugin

method), 235

total_space() (calibre.devices.usbms.device.Device

method), 240

366 Index

calibre User Manual, Release 3.35.0

WINDOWS_CARD_A_MEM (cali-
bre.devices.usbms.device.Device attribute),
239
(cali-
WINDOWS_CARD_B_MEM attribute),
bre.devices.usbms.device.Device
240 (cali-
attribute),
WINDOWS_MAIN_MEM
bre.devices.usbms.device.Device (cali-
239 method),

windows_sort_drives()
bre.devices.usbms.device.Device
241

Index 367