Debian Codegraph @

manual/faq.rst

raw
1 .. _faq:
2
3 Frequently Asked Questions
4 ==========================
5
6 .. contents:: Contents
7 :depth: 1
8 :local:
9
10 E-book format conversion
11 -------------------------
12 .. contents:: Contents
13 :depth: 1
14 :local:
15
16 What formats does calibre support conversion to/from?
17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 calibre supports the conversion of many input formats to many output formats.
19 It can convert every input format in the following list, to every output format.
20
21 *Input Formats:* AZW, AZW3, AZW4, CBZ, CBR, CB7, CBC, CHM, DJVU, DOCX, EPUB, FB2, FBZ, HTML, HTMLZ, KEPUB, LIT, LRF, MOBI, ODT, PDF, PRC, PDB, PML, RB, RTF, SNB, TCR, TXT, TXTZ
22
23 *Output Formats:* AZW3, EPUB, DOCX, FB2, HTMLZ, KEPUB, OEB, LIT, LRF, MOBI, PDB, PMLZ, RB, PDF, RTF, SNB, TCR, TXT, TXTZ, ZIP
24
25 .. note ::
26
27 PRC is a generic format, calibre supports PRC files with TextRead and MOBIBook headers.
28 PDB is also a generic format. calibre supports eReader, Plucker (input only), PML and zTxt PDB files.
29 DJVU support is only for converting DJVU files that contain embedded text. These are typically generated by OCR software.
30 MOBI books can be of two types Mobi6 and KF8. calibre fully supports both. MOBI files often have .azw or .azw3 file extensions.
31 DOCX files from Microsoft Word 2007 and newer are supported.
32
33 .. _best-source-formats:
34
35 What are the best source formats to convert?
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 In order of decreasing preference: LIT, MOBI, AZW, EPUB, KEPUB, AZW3, FB2, FBZ, DOCX, HTML, PRC, ODT, RTF, PDB, TXT, PDF
38
39 I converted a PDF file, but the result has various problems?
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41
42 PDF is a terrible format to convert from. For a list of the various issues you will encounter when converting PDF, see: :ref:`pdfconversion`.
43
44
45 .. _char-encoding-faq:
46
47 How do I convert my file containing non-English characters, or smart quotes?
48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
49 There are two aspects to this problem:
50 1. Knowing the encoding of the source file: calibre tries to guess what character encoding your source files use, but often, this is impossible, so you need to tell it what encoding to use. This can be done in the GUI via the :guilabel:`Input character encoding` field in the :guilabel:`Look & feel->Text` section of the conversion dialog. The command-line tools have an :option:`ebook-convert-txt-input --input-encoding` option.
51 2. When adding HTML files to calibre, you may need to tell calibre what encoding the files are in. To do this go to :guilabel:`Preferences->Advanced->Plugins->File type` and customize the :guilabel:`HTML to ZIP` plugin, telling it what encoding your HTML files are in. Now when you add HTML files to calibre they will be correctly processed. HTML files from different sources often have different encodings, so you may have to change this setting repeatedly. A common encoding for many files from the web is ``cp1252`` and I would suggest you try that first. Note that when converting HTML files, leave the input encoding setting mentioned above blank. This is because the :guilabel:`HTML to ZIP` plugin automatically converts the HTML files to a standard encoding (UTF-8).
52
53 What's the deal with Table of Contents in MOBI files?
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55
56 The first thing to realize is that most e-books have two tables of contents. One is the traditional Table of Contents, like the ToC you find in paper books. This Table of Contents is part of the main document flow and can be styled however you like. This ToC is called the *content ToC*.
57
58 Then there is the *metadata ToC*. A metadata ToC is a ToC that is not part of the book text and is typically accessed by some special button on a reader. For example, in the calibre E-book viewer, you use the Show Table of Contents button to see this ToC. This ToC cannot be styled by the book creator. How it is represented is up to the viewer program.
59
60 In the MOBI format, the situation is a little confused. This is because the MOBI format, alone amongst mainstream e-book formats, *does not* have decent support for a metadata ToC. A MOBI book simulates the presence of a metadata ToC by putting an *extra* content ToC at the end of the book. When you click Go to Table of Contents on your Kindle, it is to this extra content ToC that the Kindle takes you.
61
62 Now it might well seem to you that the MOBI book has two identical ToCs. Remember that one is semantically a content ToC and the other is a metadata ToC, even though both might have exactly the same entries and look the same. One can be accessed directly from the Kindle's menus, the other cannot.
63
64 When converting to MOBI, calibre detects the *metadata ToC* in the input document and generates an end-of-file ToC in the output MOBI file. You can turn this off by an option in the MOBI Output settings. You can also tell calibre whether to put it at the start or the end of the book via an option in the MOBI Output settings. Remember this ToC is semantically a *metadata ToC*, in any format other than MOBI it *cannot be part of the text*. The fact that it is part of the text in MOBI is an accident caused by the limitations of MOBI. If you want a ToC at a particular location in your document text, create one by hand. So we strongly recommend that you leave the default as it is, i.e. with the metadata ToC at the end of the book. Also note that if you disable the generation of the end-of-file ToC the resulting MOBI file may not function correctly on a Kindle, since the Kindle's use the metadata ToC for many things, including the Page Flip feature.
65
66 If you have a hand edited ToC in the input document, you can use the ToC detection options in calibre to automatically generate the metadata ToC from it. See the conversion section of the User Manual for more details on how to use these options.
67
68 Finally, I encourage you to ditch the content ToC and only have a metadata ToC in your e-books. Metadata ToCs will give the people reading your e-books a much superior navigation experience (except on the Kindle, where they are essentially the same as a content ToC).
69
70 .. note::
71 The newer AZW3 format has proper support for a metadata ToC. However, the
72 Kindle firmware tends to malfunction if you disable the generation of the
73 end-of-file inline ToC. So it is recommended that you leave the generated
74 ToC alone. If you create an AZW3 file with a metadata ToC and no
75 end-of-file generated ToC, some features on the Kindle will not work, such
76 as the Page Flip feature.
77
78 How do I convert a collection of HTML files in a specific order?
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
80 In order to convert a collection of HTML files in a specific order, you have to
81 create a table of contents file. That is, another HTML file that contains links
82 to all the other files in the desired order. Such a file looks like::
83
84 <html>
85 <body>
86 <h1>Table of Contents</h1>
87 <p style="text-indent:0pt">
88 <a href="file1.html">First File</a><br/>
89 <a href="file2.html">Second File</a><br/>
90 .
91 .
92 .
93 </p>
94 </body>
95 </html>
96
97 Then, just add this HTML file to the GUI and use the :guilabel:`Convert` button to create
98 your e-book. You can use the option in the Table of Contents section in the
99 conversion dialog to control how the Table of Contents is generated.
100
101 .. note:: By default, when adding HTML files, calibre follows links in the files
102 in *depth first* order. This means that if file A.html links to B.html and
103 C.html and D.html, but B.html also links to D.html, then the files will be
104 in the order A.html, B.html, D.html, C.html. If instead you want the order
105 to be A.html, B.html, C.html, D.html then you must tell calibre to add your
106 files in *breadth first* order. Do this by going to
107 :guilabel:`Preferences->Advanced->Plugins->File type` and customizing the
108 :guilabel:`HTML to ZIP` plugin.
109
110 The EPUB I produced with calibre is not valid?
111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112
113 calibre does not guarantee that an EPUB produced by it is valid. The only
114 guarantee it makes is that if you feed it valid XHTML 1.1 + CSS 2.1 it will
115 output a valid EPUB. calibre tries hard to ensure that EPUBs it produces actually
116 work as intended on a wide variety of devices, a goal that is incompatible with
117 producing valid EPUBs, and one that is far more important to the vast majority
118 of its users. If you need a tool that always produces valid EPUBs, calibre is not
119 for you. This means that if you want to send a calibre produced EPUB to an
120 online store that uses an EPUB validity checker, you have to make sure that the
121 EPUB is valid yourself, calibre will not do it for you -- in other words you
122 must feed calibre valid XHTML + CSS as the input documents.
123
124
125 How do I use some of the advanced features of the conversion tools?
126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127 You can get help on any individual feature of the converters by mousing over
128 it in the GUI or running ``ebook-convert dummy.html .epub -h`` at a terminal.
129 A good place to start is to look at the following demo file that demonstrates
130 some of the advanced features :download_file:`html-demo.zip <html-demo.zip>`.
131
132
133 Device integration
134 -------------------
135
136 .. contents:: Contents
137 :depth: 1
138 :local:
139
140 What devices does calibre support?
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
142 calibre can directly connect to all the major (and most of the minor) e-book
143 reading devices, smartphones, tablets, etc. In addition, using the
144 :guilabel:`Connect to folder` function you can use it with any e-book reader
145 that exports itself as a USB disk. Finally, you can connect wirelessly to any
146 device that has a web browser using the calibre Content server.
147
148 .. _devsupport:
149
150 How can I help get my device supported in calibre?
151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
152
153 If your device appears as a USB disk to the operating system, adding support for it to calibre is very easy.
154 We just need some information from you:
155
156 * Complete list of e-book formats that your device supports.
157 * Is there a special folder on the device in which all e-book files should be placed? Also does the device detect files placed in sub-folders?
158 * We also need information about your device that calibre will collect automatically. First, if your
159 device supports SD cards, insert them. Then connect your device to the computer. In calibre go to :guilabel:`Preferences->Miscellaneous`
160 and click the "Debug device detection" button. This will create some debug output. Copy it to a file
161 and repeat the process, this time with your device disconnected from your computer.
162 * Send both the above outputs to us with the other information and we will write a device driver for your
163 device.
164
165 Once you send us the output for a particular operating system, support for the device in that operating system
166 will appear in the next release of calibre. To send us the output, open a bug report and attach the output to it.
167 See :website:`how to report bugs <bugs>`.
168
169 My device is not being detected by calibre?
170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171
172 Follow these steps to find the problem:
173
174 * Make sure that you are connecting only a single device to your computer
175 at a time. Do not have another calibre supported device like an iPhone/iPad
176 etc. at the same time.
177 * If you are connecting an Apple iDevice (iPad, iPod Touch, iPhone), Apple
178 no longer allows third party software to connect to their devices using a
179 USB cable. Instead use a wireless connection, via the calibre Content
180 server.
181 * If you are connecting a 2024 Kindle or newer or an Android device, and are on macOS or Linux,
182 read the note under :ref:`android_usb`.
183 * On macOS if you get permission errors when connecting a device to calibre, you can
184 fix that by looking under :guilabel:`System Preferences > Security and
185 Privacy > Privacy > Files and Folders`.
186 * Make sure you are running the latest version of calibre (currently
187 |version|). The latest version can always be downloaded from :website:`the calibre
188 website <download>`. You can tell what
189 version of calibre you are currently running by looking at the bottom
190 line of the main calibre window.
191 * Ensure your operating system is seeing the device. That is, the device
192 should show up in Windows Explorer (in Windows) or Finder (in macOS).
193 * In calibre, go to :guilabel:`Preferences->Ignored Devices` and check that your device
194 is not being ignored
195 * If all the above steps fail, go to :guilabel:`Preferences->Miscellaneous` and click
196 :guilabel:`Debug device detection` with your device attached and post the output as a
197 ticket on `the calibre bug tracker <https://bugs.launchpad.net/calibre>`_.
198
199 My device is non-standard or unusual. What can I do to connect to it?
200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201
202 In addition to the :guilabel:`Connect to folder` function found under the
203 :guilabel:`Connect/share` button, calibre provides a ``User defined`` device
204 plugin that can be used to connect to any USB device that shows up as a disk
205 drive in your operating system. Note: on Windows, the device must have a drive
206 letter for calibre to use it. See the device plugin ``Preferences -> Plugins ->
207 Device plugins -> User defined`` and ``Preferences -> Miscellaneous -> Get
208 information to setup the user defined device`` for more information. Note that
209 if you are using the user defined plugin for a device normally detected by a
210 builtin calibre plugin, you must disable the builtin plugin first, so that your
211 user defined plugin is used instead.
212
213 How do I use calibre with my iPad/iPhone/iPod touch?
214 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
215
216 An easy way to browse your calibre collection from your Apple device
217 is by using :doc:`server`, which makes your collection available
218 over the net. First perform the following steps in calibre
219
220 * Set the Preferred Output Format in calibre to EPUB (The output format can be
221 set under :guilabel:`Preferences->Interface->Behavior`)
222 * Set the output profile to iPad (this will work for iPhone/iPods as well),
223 under :guilabel:`Preferences->Conversion->Common options->Page setup`
224 * Convert the books you want to read on your iDevice to EPUB format by
225 selecting them and clicking the :guilabel:`Convert` button.
226 * Turn on the Content server by clicking the :guilabel:`Connect/share` button
227 and leave calibre running. You can also tell calibre to automatically start the
228 Content server via :guilabel:`Preferences->Sharing->Sharing over the net`.
229
230 The Content server allows you to read books directly in Safari itself. In
231 addition, there are many apps for your iDevice that can connect to the calibre
232 Content server. Examples include: Marvin, Mapleread and iBooks itself.
233
234 Using the Content server
235 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
236
237 Start the Safari browser and type in the IP address and port of the computer
238 running the calibre server, like this::
239
240 http://192.168.1.2:8080/
241
242 Replace ``192.168.1.2`` with the local IP address of the computer running
243 calibre. See :doc:`server` for details on running the server and finding out the
244 right IP address to use.
245
246 You will see a list of books in Safari, tap on any book and you will be given
247 the option to either download it, or read it in the browser itself. If you
248 choose to download it, Safari will ask you if you want to open it with iBooks.
249
250 Many reading apps support browsing the calibre library directly via its `OPDS <https://opds.io/>`__ support.
251 In such apps you can go to the online catalog screen and add the IP address of
252 the calibre server to browse and download books from your calibre library
253 within the app.
254
255 How do I use calibre with my Android phone/tablet or Kindle Fire?
256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
257
258 There are two ways that you can connect your Android device to calibre. Using a USB cable -- or wirelessly, over the air.
259 The first step to using an Android device is installing an e-book reading
260 application on it. There are many free and paid e-book reading applications for
261 Android: Some examples (in no particular order):
262 `FBReader <https://play.google.com/store/apps/details?id=org.geometerplus.zlibrary.ui.android&hl=en>`_,
263 `Moon+ <https://play.google.com/store/apps/details?id=com.flyersoft.moonreader&hl=en>`_,
264 `Mantano <https://play.google.com/store/apps/details?id=com.mantano.reader.android.lite&hl=en>`_,
265 `Aldiko <https://play.google.com/store/apps/details?id=com.aldiko.android&hl=en>`_,
266 `Kindle <https://play.google.com/store/apps/details?id=com.amazon.kindle&feature=related_apps>`_.
267
268 .. _android_usb:
269
270 Using a USB cable
271 ^^^^^^^^^^^^^^^^^^^^
272
273 Simply plug your device into the computer with a USB cable. calibre should
274 automatically detect the device and then you can transfer books to it by
275 clicking the :guilabel:`Send to device` button. Note that on macOS and Linux
276 only a single program can connect to an Android device at a time, so make
277 sure the device is not opened in the OS File manager, or the Android File Transfer
278 utility, etc.
279
280 .. note:: With newer Android devices, you might have to jump through a few hoops
281 to get the connection working, as Google really does not want you to be
282 independent of its cloud. First, unlock the screen before plugging in the
283 USB cable. When you plug in the USB cable you will get a popup
284 notification. Make sure it says something like "Transferring Media files"
285 or "MTP (Media Transfer mode)". If it does not, tap the notification, and
286 change the mode to Media Transfer (MTP). You may need to restart calibre
287 at this point in order for your device to be recognized. Finally, you
288 might get a popup on the device every time calibre or the operating system
289 actually tries to connect to it, asking for permission, tap OK.
290
291
292 .. note:: With the Kindle Fire 8 or newer there is an icon that shows up when
293 the USB cable is plugged in, showing that the device is charging. Tap that
294 and switch the device to data transfer mode, and then start calibre, it
295 should then be detected.
296
297 Over the air
298 ^^^^^^^^^^^^^^
299
300 calibre has a builtin web server, the :doc:`calibre Content server <server>`. It makes your calibre
301 collection available over the net. You can browse it on your device using a
302 simple browser or a dedicated application. First perform the following steps in calibre:
303
304 * Set the :guilabel:`Preferred Output Format` in calibre to EPUB for normal Android devices or MOBI for Kindles (The output format can be set under :guilabel:`Preferences->Interface->Behavior`)
305 * Convert the books you want to read on your device to EPUB/MOBI format by selecting them and clicking the :guilabel:`Convert` button.
306 * Turn on the :guilabel:`Content server` in calibre's preferences and leave calibre running.
307
308 Now on your Android device, open the browser and browse to
309
310 http://192.168.1.2:8080/
311
312 Replace ``192.168.1.2`` with the local IP address of the computer running
313 calibre. See :doc:`server` for details on running the server and finding out the
314 right IP address to use.
315
316 You can now browse your book collection and download books from calibre
317 to your device to open with whatever e-book reading software you have on your
318 Android device.
319
320 Many reading apps support browsing the calibre library directly via its `OPDS <https://opds.io/>`__ support.
321 In such apps you can go to the online catalog screen and add the IP address of
322 the calibre server to browse and download books from your calibre library
323 within the app.
324
325
326 Can I access my calibre books using the web browser in my Kindle or other reading device?
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328
329 calibre has a *Content server* that exports the books in calibre as a web page. See :doc:`server` for details.
330
331 Some devices, like the Kindle (1/2/DX), do not allow you to access port 8080 (the default port on which the content
332 server runs). In that case, change the port in the calibre Preferences to 80. (On some operating systems,
333 you may not be able to run the server on a port number less than 1024 because of security settings. In
334 this case the simplest solution is to adjust your router to forward requests on port 80 to port 8080).
335
336 Also some devices do not have browsers advanced enough to run the app-like
337 interface used by the Content server. For such devices, you can simply add
338 ``/mobile`` to the server URL to get a simplified, non-JavaScript interface.
339
340
341 I cannot send emails using calibre?
342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
343
344 Because of the large amount of spam in email, sending email can be tricky, as
345 different mail servers use different strategies to block email. The most
346 common problem is if you are sending email directly (without a mail relay) in
347 calibre. Many servers (for example, Amazon) block email that does not come from
348 a well known relay. The most robust way to setup email sending in calibre is to
349 do the following:
350
351 * Create a free GMX account at `GMX <https://www.gmx.com>`_.
352 * Go to :guilabel:`Preferences->Sharing->Sharing books by email` in calibre and click the :guilabel:`Use GMX` button and fill in the information asked for.
353 * Log into your GMX account on the website and enable SMTP sending (`Settings->POP3 & IMAP->Send and receive emails via external program`)
354 * calibre will then be able to use GMX to send the mail.
355 * If you are sending to your Kindle, remember to update the email preferences
356 on your Amazon Kindle page to allow email sent from your GMX email
357 address. Also note that Amazon does not allow email delivery of AZW3 and
358 new style (KF8) MOBI files. Finally, Amazon recently started sending
359 confirmation emails that you have to click on back to your GMX account
360 before the book is actually delivered.
361
362 Even after doing this, you may have problems. One common source of problems is that some poorly designed antivirus
363 programs block calibre from opening a connection to send email. Try adding an exclusion for calibre in your
364 antivirus program.
365
366 .. note::
367 Microsoft/GMX can disable your account if you use it to send large
368 amounts of email. So, when using these services to send mail calibre automatically
369 restricts itself to sending one book every five minutes. If you don't mind
370 risking your account being blocked you can reduce this wait interval by going
371 to :guilabel:`Preferences->Advanced->Tweaks` in calibre.
372
373 .. note::
374 Google recently deliberately broke their email sending protocol (SMTP) support in
375 an attempt to force everyone to use their web interface so they can
376 show you more ads. They are trying to claim that SMTP is insecure,
377 that is incorrect and simply an excuse. Use some other email provider
378 instead.
379
380 .. note::
381 If you are concerned about giving calibre access to your email
382 account, simply create a new free email account with GMX or Outlook
383 and use it only for calibre.
384
385
386 My device is getting mounted read-only in Linux, so calibre cannot connect to it?
387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
388
389 Linux kernels mount devices read-only when their filesystems have errors. You can repair the filesystem with::
390
391 sudo fsck.vfat -y /dev/sdc
392
393 Replace /dev/sdc with the path to the device node of your device. You can find the device node of your device, which
394 will always be under /dev by examining the output of::
395
396 mount
397
398
399 Why does calibre not support collections on the Kindle or shelves on the Nook?
400 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
401
402 Neither the Kindle nor the Nook provide any way to manipulate collections over
403 a USB connection. If you really care about using collections, I would urge you
404 to sell your Kindle/Nook and get a Kobo. Only Kobo seems to understand that
405 life is too short to be entering collections one by one on an e-ink screen 😇
406
407 Note that in the case of the Kindle, there is a way to manipulate collections
408 via USB, but it requires that the Kindle be rebooted *every time* it is
409 disconnected from the computer, for the changes to the collections to be
410 recognized. As such, it is unlikely that any calibre developers will ever feel
411 motivated enough to support it. There is however, a calibre plugin that allows
412 you to create collections on your Kindle from the calibre metadata. It is
413 available `from here <https://www.mobileread.com/forums/showthread.php?t=244202>`_.
414
415 .. note::
416 Amazon have removed the ability to manipulate collections completely
417 in their newer models, like the Kindle Touch and Kindle Fire, making even the
418 above plugin useless, unless you root your Kindle and install custom firmware.
419
420 I am getting an error when I try to use calibre with my Kobo Touch/Glo/etc.?
421 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
422
423 The Kobo has very buggy firmware. Connecting to it has been known to fail at
424 random. Certain combinations of motherboard, USB ports/cables/hubs can
425 exacerbate this tendency to fail. If you are getting an error when connecting
426 to your touch with calibre try the following, each of which has solved the
427 problem for *some* calibre users.
428
429 * Connect the Kobo directly to your computer, not via USB Hub
430 * Try a different USB cable and a different USB port on your computer
431 * Log out of the Kobo and log in again, this causes it to rebuild the
432 database, fixing corrupted database errors.
433 * Try upgrading the firmware on your Kobo Touch to the latest
434 * Try resetting the Kobo (sometimes this cures the problem for a little while, but then it re-appears, in which case you have to reset again and again)
435 * Try only putting one or two books onto the Kobo at a time and do not keep large collections on the Kobo
436
437
438 Covers for books I send to my e-ink Kindle show up momentarily and then are replaced by a generic cover?
439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440
441 This happens because of an Amazon bug. They try to download a cover for the
442 book from their servers and when that fails, they replace the existing cover
443 that calibre created with a generic cover. For details see `this forum thread
444 <https://www.mobileread.com/forums/showthread.php?t=329945>`_. As of version
445 4.17, calibre has a workaround, where if you connect the Kindle to calibre
446 after the covers have been destroyed by Amazon, calibre will restore them
447 automatically. So in order to see the covers on your Kindle, you have to:
448
449 1) Send the book to the Kindle with calibre
450 2) Disconnect the Kindle and wait for Amazon to destroy the cover
451 3) Reconnect the Kindle to calibre
452
453 Note that this workaround only works for books sent with calibre 4.17 or later.
454 Alternately, simply keep your Kindle in airplane mode, you don't really want
455 Amazon knowing every book you read anyway. I encourage you to contact Amazon
456 customer support and complain loudly about this bug. Maybe Amazon will listen.
457
458 .. note::
459
460 If the workaround is not working for you make sure your Kindle firmware
461 is at least version 5.12.5, released in April 2020.
462
463 Covers for books sent to my Kindle ColorSoft and newer do not show up in the book list?
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465
466 Amazon deliberately broke this functionality in their ColorSoft and newer
467 devices in order to discourage you from reading non Amazon books on their
468 devices. See `this forum thread
469 <https://www.mobileread.com/forums/showthread.php?t=364350>`__ for details. The
470 only known workaround is to send the books as "Personal documents" to the
471 Kindle which will fix the covers not showing up but break other features such
472 as Whispersync and the books will show up under "Personal documents" not
473 "Books" on the device. To enable this in calibre go to
474 :guilabel:`Preferences->Output options->MOBI output` and enable the check box
475 that says :guilabel:`Enable sharing of book content`. This will cause all
476 future books sent to the Kindle by calibre to be marked as personal documents.
477
478
479 The covers for my MOBI files have stopped showing up in Kindle for PC/Kindle for Android/iPad etc.
480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
481
482 This is caused by a bug in the Amazon software. You can work around it by going
483 to :guilabel:`Preferences->Conversion->Output Options->MOBI output` and setting
484 the :guilabel:`Enable sharing of book content` option. If you are reconverting
485 a previously converted book, you will also have to enable the option in the
486 conversion dialog for that individual book (as per book conversion settings are
487 saved and take precedence).
488
489 Note that doing this will mean that the generated MOBI will show up under
490 personal documents instead of Books on the Kindle Fire and Amazon whispersync
491 will not work, but the covers will. It's your choice which functionality is
492 more important to you. I encourage you to contact Amazon and ask them to fix
493 this bug.
494
495 The bug in Amazon's software is that when you put a MOBI file on a Kindle,
496 unless the file is marked as a Personal document, Amazon assumes you bought the
497 book from it and tries to download the cover thumbnail for it from its servers. When the
498 download fails, it refuses to fallback to the cover defined in the MOBI file.
499 This is likely deliberate on Amazon's part to try to force authors to sell only
500 through them. In other words, the Kindle only displays covers for books marked as
501 Personal Documents or books bought directly from Amazon.
502
503 If you send a MOBI file to an e-ink Kindle with calibre using a USB connection,
504 calibre works around this Amazon bug by uploading a cover thumbnail itself.
505 However, that workaround is only possible when using a USB connection and
506 sending with calibre. Note that if you send using email, Amazon will
507 automatically mark the MOBI file as a Personal Document and the cover will
508 work, but the book will show up in Personal Documents.
509
510
511 I transferred some books to my Kindle using calibre and they did not show up?
512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
513
514 Books sent to the Kindle only show up on the Kindle after they have been
515 *indexed* by the Kindle. This can take some time. If the book still does not
516 show up after some time, then it is likely that the Kindle indexer crashed.
517 Sometimes a particular book can cause the indexer to crash. Unfortunately, Amazon has
518 not provided any way to deduce which book is causing a crash on the Kindle.
519 Your only recourse is to either reset the Kindle, or delete all files from its
520 memory using Windows Explorer (or whatever file manager you use) and then send
521 the books to it again, one by one, until you discover the problem book. Once
522 you have found the problem book, delete it off the Kindle and do a MOBI to MOBI
523 or MOBI to AZW3 conversion in calibre and then send it back. This will most
524 likely take care of the problem.
525
526 Library management
527 ------------------
528
529 .. contents:: Contents
530 :depth: 1
531 :local:
532
533 Where are the book files stored?
534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
535 When you first run calibre, it will ask you for a folder in which to store your books. Whenever you add a book to calibre, it will copy the book into that folder. Books in the folder are nicely arranged into sub-folders by Author and Title. Note that the contents of this folder are automatically managed by calibre, **do not** add any files/folders manually to this folder, as they may be automatically deleted. If you want to add a file associated to a particular book, use the top right area of :guilabel:`Edit metadata` dialog to do so. Then, calibre will automatically put that file into the correct folder and move it around when the title/author changes.
536
537 Metadata about the books is stored in the file ``metadata.db`` at the top level of the library folder. This file is a sqlite database. When backing up your library make sure you copy the entire folder and all its sub-folders.
538
539 The library folder and all its contents make up what is called a calibre library. You can have multiple such libraries. To manage the libraries, click the calibre icon on the toolbar. You can create new libraries, remove/rename existing ones and switch between libraries easily.
540
541 You can copy or move books between different libraries (once you have more than one library setup) by right clicking on a book and selecting the :guilabel:`Copy to library` action.
542
543 How does calibre manage author names and sorting?
544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
545
546 Author names are complex, especially across cultures, see `this note
547 <https://www.w3.org/International/questions/qa-personal-names.en.php?changelang=en>`_
548 for some of the complexities. calibre has a very flexible strategy for managing
549 author names. The first thing to understand is that books and authors are
550 separate entities in calibre. A book can have more than one author, and an
551 author can have more than one book. You can manage the authors of a book by the
552 edit metadata dialog. You can manage individual authors by right clicking on
553 the author in the Tag browser on the left of the main calibre window and
554 selecting :guilabel:`Manage authors`. Using this dialog you can change the name
555 of an author and also how that name is sorted. This will automatically change
556 the name of the author in all the books of that author. When a book has
557 multiple authors, separate their names using the & character.
558
559 Now coming to author name sorting:
560
561 * When a new author is added to calibre (this happens whenever a book by a new author is added), calibre automatically computes a sort string for both the book and the author.
562 * Authors in the Tag browser are sorted by the sort value for the **authors**. Remember that this is different from the Author sort field for a book.
563 * By default, this sort algorithm assumes that the author name is in ``First name Last name`` format and generates a ``Last name, First name`` sort value.
564 * You can change this algorithm by going to :guilabel:`Preferences->Advanced->Tweaks` and setting the :guilabel:`author_sort_copy_method` tweak.
565 * You can force calibre to recalculate the author sort values for every author by right clicking on any author and selecting :guilabel:`Manage authors`, then pushing the :guilabel:`Recalculate all author sort values` button. Do this after you have set the author_sort_copy_method tweak to what you want.
566 * You can force calibre to recalculate the author sort values for all books by using the bulk metadata edit dialog (select all books and click edit metadata, check the :guilabel:`Automatically set author sort` checkbox, then press OK).
567 * When recalculating the author sort values for books, calibre uses the author sort values for each individual author. Therefore, ensure that the individual author sort values are correct before recalculating the books' author sort values.
568 * You can control whether the Tag browser display authors using their names or their sort values by setting the :guilabel:`categories_use_field_for_author_name` tweak in :guilabel:`Preferences->Advanced->Tweaks`
569
570 Note that you can set an individual author's sort value to whatever you want using :guilabel:`Manage authors`. This is useful when dealing with names that calibre will not get right, such as complex multi-part names like Miguel de Cervantes Saavedra or when dealing with Asian names like Sun Tzu.
571
572 With all this flexibility, it is possible to have calibre manage your author names however you like. For example, one common request is to have calibre display author names LN, FN. To do this, and if the note below does not apply to you, then:
573
574 * Set the ``author_sort_copy_method`` tweak to ``copy`` as described above.
575 * Restart calibre. Do not change any book metadata before doing the remaining steps.
576 * Change all author names to LN, FN using the Manage authors dialog.
577 * After you have changed all the authors, press the `Recalculate all author sort values` button.
578 * Press OK, at which point calibre will change the authors in all your books. This can take a while.
579
580 .. note::
581
582 When changing from FN LN to LN, FN, it is often the case that the values in author_sort are already in LN, FN format. If this is your case, then do the following:
583 * Set the ``author_sort_copy_method`` tweak to ``copy`` as described above.
584 * Restart calibre. Do not change any book metadata before doing the remaining steps.
585 * Open the Manage authors dialog. Press the ``copy all author sort values to author`` button.
586 * Check through the authors to be sure you are happy. You can still press Cancel to abandon the changes. Once you press OK, there is no undo.
587 * Press OK, at which point calibre will change the authors in all your books. This can take a while.
588
589
590 Why doesn't calibre let me store books in my own folder structure?
591 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
592
593 The whole point of calibre's library management features is that they provide a search and sort based interface for locating books that is *much* more efficient than any possible folder scheme you could come up with for your collection. Indeed, once you become comfortable using calibre's interface to find, sort and browse your collection, you won't ever feel the need to hunt through the files on your disk to find a book again. By managing books in its own folder structure of Author -> Title -> Book files, calibre is able to achieve a high level of reliability and standardization. To illustrate why a search/tagging based interface is superior to folders, consider the following. Suppose your book collection is nicely sorted into folders with the following scheme::
594
595 Genre -> Author -> Series -> ReadStatus
596
597 Now this makes it very easy to find for example all science fiction books by Isaac Asimov in the Foundation series. But suppose you want to find all unread science fiction books. There's no easy way to do this with this folder scheme, you would instead need a folder scheme that looks like::
598
599 ReadStatus -> Genre -> Author -> Series
600
601 In calibre, you would instead use tags to mark genre and read status and then just use a simple search query like ``tag:scifi and not tag:read``. calibre even has a nice graphical interface, so you don't need to learn its search language instead you can just click on tags to include or exclude them from the search.
602
603 To those of you that claim that you need access to the filesystem, so that you can have access to your books over the network, calibre has an excellent Content server that gives you access to your calibre library over the net.
604
605 If you are worried that someday calibre will cease to be developed, leaving all your books marooned in its folder structure, explore the powerful :guilabel:`Save to disk` feature in calibre that lets you export all your files into a folder structure of arbitrary complexity based on their metadata.
606
607 Finally, the reason there are numbers at the end of every title folder, is for *robustness*. That number is the id number of the book record in the calibre database. The presence of the number allows you to have multiple records with the same title and author names. It is also part of what allows calibre to magically regenerate the database with all metadata if the database file gets corrupted. Given that calibre's mission is to get you to stop storing metadata in filenames and stop using the filesystem to find things, the increased robustness afforded by the id numbers is well worth the uglier folder names.
608
609 If you are still not convinced, then I'm afraid calibre is not for you. Look elsewhere for your book cataloguing needs. Just so we're clear, **this is not going to change**. Kindly do not contact us in an attempt to get us to change this.
610
611 Why doesn't calibre have a column for foo?
612 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
613
614 calibre is designed to have columns for the most frequently and widely used
615 fields. In addition, you can add any columns you like. Columns can be added via
616 :guilabel:`Preferences->Interface->Add your own columns`. Watch the tutorial
617 :website:`UI Power tips <demo#tutorials>` to learn how to
618 create your own columns, or read `this blog post
619 <https://blog.calibre-ebook.com/calibre-custom-columns/>`_.
620
621 You can also create "virtual columns" that contain combinations of the metadata
622 from other columns. In the add column dialog use the :guilabel:`Quick create`
623 links to easily create columns to show the book ISBN or formats. You can use
624 the powerful calibre template language to do much more with columns. For more
625 details, see :ref:`templatelangcalibre`.
626
627
628 Can I have a column showing the formats or the ISBN?
629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
630 Yes, you can. Follow the instructions in the answer above for adding custom columns.
631
632 How do I move my calibre data from one computer to another?
633 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
634
635 You can export all calibre data (books, settings and plugins) and
636 then import it on another computer. First let's see how to export the data:
637
638 * Right click the calibre icon in the main calibre toolbar and select
639 :guilabel:`Export/import all calibre data`. Note that if there is currently
640 a device connected, this menu option will not be available -- so,
641 disconnect any connected devices. Then click the button labelled
642 :guilabel:`Export all your calibre data`. You will see a list of all your
643 calibre libraries. Click OK and choose an empty folder somewhere on your
644 computer. The exported data will be saved in this folder. Simply copy this
645 folder to your new computer and follow the instructions below to import the
646 data.
647
648 * Install calibre on your new computer and run through the :guilabel:`Welcome wizard`, it
649 does not matter what you do there, as you will be importing your old
650 settings in the next step. You will now have an empty calibre, with just
651 the :guilabel:`Getting Started` guide in your library. Once again, right
652 click the calibre button and choose :guilabel:`Export/import all calibre
653 data`. Then click the button labelled :guilabel:`Import previously exported
654 data`. Select the folder with the exported data that you copied over
655 earlier. You will now have a list of libraries you can import. Go through
656 the list one by one, and select the new location for each library (a
657 location is just an empty folder somewhere on your computer). Click OK.
658 After the import completes, calibre will restart, with all your old
659 libraries, settings and calibre plugins.
660
661
662 .. note:: This import/export functionality is only available from calibre
663 version 2.47 onwards. If you have an older version of calibre, or if you
664 encounter problems with the import/export, you can just copy over your
665 calibre library folder manually, as described in the next paragraph.
666
667 Simply copy the calibre library folder from the old to the new computer. You can
668 find out what the library folder is by clicking the calibre icon in the
669 toolbar. Choose the :guilabel:`Switch/create calibre library` action and
670 you will see the path to the current calibre library.
671
672 Now on the new computer, start calibre for the first time. It will run the
673 :guilabel:`Welcome wizard` asking you for the location of the calibre library. Point it
674 to the previously copied folder. If the computer you are transferring to
675 already has a calibre installation, then the :guilabel:`Welcome wizard` won't run. In
676 that case, right-click the calibre icon in the toolbar and point it to the
677 newly copied folder. You will now have two calibre libraries on your
678 computer and you can switch between them by clicking the calibre icon on
679 the toolbar. Transferring your library in this manner preserves all your
680 metadata, tags, custom columns, etc.
681
682
683 The list of books in calibre is blank!
684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
685
686 In order to understand why that happened, you have to understand what a calibre
687 library is. At the most basic level, a calibre library is just a folder. Whenever
688 you add a book to calibre, that book's files are copied into this folder
689 (arranged into sub folders by author and title). Inside the calibre library
690 folder, at the top level, you will see a file called metadata.db. This file is
691 where calibre stores the metadata like title/author/rating/tags etc. for *every*
692 book in your calibre library. The list of books that calibre displays is created by
693 reading the contents of this metadata.db file.
694
695 There can be two reasons why calibre is showing an empty list of books:
696
697 * Your calibre library folder changed its location. This can happen if it was
698 on an external disk and the drive letter for that disk changed. Or if you
699 accidentally moved the folder. In this case, calibre cannot find its library
700 and so starts up with an empty library instead. To remedy this, do a
701 right-click on the calibre icon in the calibre toolbar and select Switch/create
702 library. Click the little blue icon to select the new location of your
703 calibre library and click OK. If you don't know the new location search your
704 computer for the file :file:`metadata.db`.
705
706 * Your metadata.db file was deleted/corrupted. In this case, you can ask
707 calibre to rebuild the metadata.db from its backups. Right click the calibre
708 icon in the calibre toolbar and select Library maintenance->Restore database.
709 calibre will automatically rebuild metadata.db.
710
711 I am getting errors with my calibre library on a networked drive/NAS?
712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
713
714 **Do not put your calibre library on a networked drive**.
715
716 A filesystem is a complex beast. Most network filesystems lack various
717 filesystem features that calibre uses. Some don't support file locking, some don't
718 support hardlinking, some are just flaky. Additionally, calibre is a single user
719 application, if you accidentally run two copies of calibre on the same networked
720 library, bad things will happen. Finally, different OSes impose different
721 limitations on filesystems, so if you share your networked drive across OSes,
722 once again, bad things *will happen*.
723
724 Consider using the calibre Content server to make your books available on other
725 computers. Run calibre on a single computer and access it via the Content
726 server or a Remote Desktop solution.
727
728 If you must share the actual library, use a file syncing tool like
729 DropBox or rsync instead of a networked drive. If you are
730 using a file-syncing tool it is **essential** that you make sure that both
731 calibre and the file syncing tool do not try to access the calibre library at the
732 same time. In other words, **do not** run the file syncing tool and calibre at
733 the same time. calibre libraries should never be shared between users and you
734 should never open a calibre library you get from an untrusted source, as that
735 is a security risk.
736
737 Even with these tools there is danger of data corruption/loss, so only do this
738 if you are willing to live with that risk. In particular, be aware that
739 **Google Drive** is incompatible with calibre, if you put your calibre library in
740 Google Drive, **you will suffer data loss**. See `this thread
741 <https://www.mobileread.com/forums/showthread.php?t=205581>`_ for details.
742
743
744 Miscellaneous
745 --------------
746
747 .. contents:: Contents
748 :depth: 1
749 :local:
750
751
752 Amazon is stopping email delivery of MOBI files?
753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
754
755 Amazon `have announced
756 <https://blog.the-ebook-reader.com/2022/05/03/amazon-dropping-mobi-support-on-send-to-kindle-apps/>`__
757 that they will stop accepting MOBI files emailed to ``@kindle.com`` email
758 addresses. You can instruct calibre to send EPUB instead of MOBI by going to
759 :guilabel:`Preferences->Sharing books by email` and then removing MOBI from the
760 list of formats to send to your ``@kindle.com`` email address and adding EPUB
761 instead.
762
763 Note however, that Amazon's EPUB intake is very flawed, they will reject a
764 number of EPUB files that work everywhere else. In such cases you can try the
765 following trick:
766
767 #. Convert the EPUB file to MOBI
768 #. Then convert the MOBI file back to EPUB and send the resulting EPUB file
769
770 This will remove all advanced formatting, embedded fonts, etc., but greatly
771 increase the chances of Amazon accepting the EPUB.
772
773 .. note:: If you were previously using email delivery of periodicals downloaded
774 by calibre, you will be better off sending those by USB cable or downloading
775 them from the calibre Content server via the Kindle's built-in browser.
776 However, if you want to continue using email delivery you can try changing the
777 output format in Preferences->Behavior to EPUB, then calibre will download
778 the news in EPUB format. Whether Amazon will accept the EPUB or not is a
779 whole other question.
780
781
782 I want calibre to download news from my favorite news website.
783 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
784 If you are reasonably proficient with computers, you can teach calibre to download news from any website of your choosing. To learn how to do this see :ref:`news`.
785
786 Otherwise, you can request a particular news site by posting in the `calibre Recipes forum <https://www.mobileread.com/forums/forumdisplay.php?f=228>`_.
787
788
789 Why the name calibre?
790 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
791 Take your pick:
792 * Converter And LIBRary for E-books
793 * A high *calibre* product
794 * A tribute to the SONY Librie which was the first e-ink based e-book reader
795 * My wife chose it ;-)
796
797 calibre is pronounced as cal-i-ber *not* ca-li-bre. If you're wondering, calibre is the British/commonwealth spelling for caliber. Being Indian, that's the natural spelling for me.
798
799 Why does calibre show only some of my fonts on macOS?
800 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
801
802 calibre embeds fonts in e-book files it creates. E-book files support embedding
803 only TrueType and OpenType (.ttf and .otf) fonts. Most fonts on macOS systems
804 are in .dfont format, thus they cannot be embedded. calibre shows only TrueType
805 and OpenType fonts found on your system. You can obtain many such fonts on the
806 web. Simply download the .ttf/.otf files and add them to the Library/Fonts
807 folder in your home folder.
808
809 calibre is not starting on Windows?
810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
811 There can be several causes for this:
812
813 * If you get no errors but the calibre window does not appear, it has
814 probably just appeared off screen. You can gather all windows onto the
815 current screen using one of the techniques described `here <https://www.wikihow.com/Bring-an-Off-Screen-Window-Back-on-Windows>`__.
816
817 * Some software has been known to interfere with calibre, try rebooting in
818 Safe mode and see if it works. A known culprit is the `Sunshine
819 <https://github.com/LizardByte/Sunshine>`__ screen sharing software.
820
821 * If you get an error about calibre not being able to open a file because it is in use by another program, do the following:
822
823 * Uninstall calibre
824 * Reboot your computer
825 * Re-install calibre. But do not start calibre from the installation wizard.
826 * Temporarily disable your antivirus program (disconnect from the Internet before doing so, to be safe)
827 * Look inside the folder you chose for your calibre library. If you see a file named metadata.db, delete it.
828 * Start calibre
829 * From now on you should be able to start calibre normally.
830
831 * If you get an error about a Python function terminating unexpectedly after upgrading calibre, first uninstall calibre, then delete the folders (if they exist)
832 :file:`C:\\Program Files\\Calibre` and :file:`C:\\Program Files\\Calibre2`. Now re-install and you should be fine.
833 * If you get an error in the :guilabel:`Welcome wizard` on an initial run of calibre, try choosing a folder like :file:`C:\\library` as the calibre library (calibre sometimes
834 has trouble with library locations if the path contains non-English characters, or only numbers, etc.)
835 * Try running it as administrator (Right click on the icon and select :guilabel:`Run as administrator`)
836
837 If it still won't launch, start a command prompt (press the Windows key and R; then type :command:`cmd.exe` in the Run dialog that appears). At the command prompt type the following command and press Enter::
838
839 calibre-debug -g
840
841 Post any output you see in a help message on the `Forum <https://www.mobileread.com/forums/forumdisplay.php?f=166>`_.
842
843 calibre freezes/crashes occasionally?
844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
845
846 There are several possible things I know of, that can cause this:
847
848 * You recently connected an external monitor or TV to your computer. In
849 this case, whenever calibre opens a new window like the edit metadata
850 window or the conversion dialog, it appears on the second monitor where
851 you don't notice it and so you think calibre has frozen. Disconnect your
852 second monitor and restart calibre.
853
854 * The following programs have been reported to cause crashes in calibre: If
855 you are running any of these, close them before starting calibre, or
856 uninstall them:
857 *RoboForm*, *Logitech SetPoint Settings*, *Constant Guard Protection by
858 Xfinity*, *Spybot*, *Killer Network Manager*, *Nahimic UI Interface*,
859 *Acronis True Image*.
860
861 * You are using a Wacom branded USB mouse/tablet. There is an incompatibility between
862 Wacom drivers and the graphics toolkit calibre uses. Try using a non-Wacom
863 mouse.
864
865 * On some 64 bit versions of Windows there are security software/settings
866 that prevent 64-bit calibre from working properly. If you are using the 64-bit
867 version of calibre try switching to the 32-bit version.
868
869 * If the crash happens when you are trying to copy text from the calibre
870 E-book viewer, it is most likely caused by some clipboard
871 monitoring/managing application you have running. Turn it off and you
872 should be fine.
873
874 * If the crashes happen specifically when you are using a file dialog, like
875 clicking on the :guilabel:`Add books` button or the :guilabel:`Save to
876 Disk` button, then you have some software that has installed broken Shell
877 extensions on your computer. Known culprits include: *SpiderOak*, *odrive
878 sync* and *Dell Backup and Recovery* and *NetDrive*. If you have one of
879 these, uninstall them and you will be fine. You can also use the `NirSoft
880 Shell Extension Viewer <https://www.nirsoft.net/utils/shexview.html>`_ to
881 see what shell extensions are installed on your system and disable them
882 individually, if you don't want to uninstall the full program. Remember
883 to use "Restart Explorer" or reboot your computer after disabling the
884 shell extensions.
885
886 If none of the above apply to you, then there is some other program on your
887 computer that is interfering with calibre. First reboot your computer in safe
888 mode, to have as few running programs as possible, and see if the crashes still
889 happen. If they do not, then you know it is some program causing the problem.
890 The most likely such culprit is a program that modifies other programs'
891 behavior, such as an antivirus, a device driver, something like RoboForm (an
892 automatic form filling app) or an assistive technology like Voice Control or a
893 Screen Reader.
894
895 The only way to find the culprit is to eliminate the programs one by one and
896 see which one is causing the issue. Basically, stop a program, run calibre,
897 check for crashes. If they still happen, stop another program and repeat.
898
899
900 Using the viewer or doing any conversions results in a permission denied error on Windows
901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
902
903 Something on your computer is preventing calibre from accessing its own
904 temporary files. Most likely the permissions on your :file:`Temp` folder are incorrect.
905 Go to the folder :file:`C:\\Users\\USERNAME\\AppData\\Local` in Windows
906 Explorer and then right click on the :file:`Temp` folder, select :guilabel:`Properties` and go to
907 the :guilabel:`Security` tab. Make sure that your user account has full control for this
908 folder.
909
910 Some users have reported that running the following command in an Administrator
911 Command Prompt fixed their permissions. To get an Administrator Command Prompt
912 search for cmd.exe in the start menu, then right click on the command prompt
913 entry and select :guilabel:`Run as administrator`. At the command prompt type the following
914 command and press Enter::
915
916 icacls "%appdata%\..\Local\Temp" /reset /T
917
918 Alternately, you can run calibre as Administrator, but doing so will cause
919 some functionality, such as drag and drop to not work.
920
921 Finally, some users have reported that disabling UAC fixes the problem.
922
923
924 calibre is not starting/crashing on macOS?
925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
926
927 One common cause of failures on macOS is the use of accessibility technologies
928 that are incompatible with the graphics toolkit calibre uses. Try turning off
929 VoiceOver if you have it on. Also go to System Preferences->Accessibility
930 and turn off the setting for enabling access for assistive devices in
931 all the tabs. Another cause can be some third party apps that modify system
932 behavior, such as Smart Scroll and Default Folder X.
933
934 You can obtain debug output about why calibre is not starting by running `Console.app`. Debug output will
935 be printed to it. If the debug output contains a line that looks like::
936
937 Qt: internal: -108: Error ATSUMeasureTextImage text/qfontengine_mac.mm
938
939 then the problem is probably a corrupted font cache. You can clear the cache by following these
940 `instructions <https://typefaceapp.com/help/troubleshooting/macos-font-cache>`_. If that doesn't
941 solve it, look for a corrupted font file on your system, in ~/Library/Fonts or the like. An easy way to
942 check for corrupted fonts in macOS is to start the "Font Book" application, select all fonts and then in the File
943 menu, choose "Validate fonts".
944
945 I get only a black or white screen when running the calibre E-book viewer?
946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
947
948 This will be because of an incompatibility between Qt WebEngine, which the
949 viewer uses to render and the GPU drivers on your system. First try
950 upgrading the GPU drivers. If that does not help, you can try turning off
951 hardware acceleration in Qt WebEngine via Preferences->Tweaks->Control GPU
952 usage in Qt WebEngine.
953
954
955 I downloaded the installer, but it is not working?
956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
957
958 Downloading from the Internet can sometimes result in a corrupted download. If the calibre installer you downloaded is not opening, try downloading it again. If re-downloading it does not work, download it from `an alternate location <https://github.com/kovidgoyal/calibre/releases/latest>`_. If the installer still doesn't work, then something on your computer is preventing it from running.
959
960 * Try temporarily disabling your antivirus program (Microsoft Security Essentials, or Kaspersky or Norton or McAfee or whatever). This is most likely the culprit if the upgrade process is hanging in the middle.
961 * Similarly, if the installer is failing/rolling back and you have Microsoft PowerToys running, quit it.
962 * If you have installed to a non-standard location, try running the installer as Administrator
963 * Try rebooting your computer and running a registry cleaner like `Wise registry cleaner <https://www.wisecleaner.com>`_.
964 * Try a clean install. That is, uninstall calibre, delete :file:`C:\\Program Files\\Calibre2` (or wherever you previously chose to install calibre). Then re-install calibre. Note that uninstalling does not touch your books or settings.
965 * Try downloading the installer with an alternate browser. For example if you are using Microsoft Edge, try using Firefox or Chrome instead.
966 * If you get an error about a missing DLL on Windows, then most likely, the
967 permissions on your temporary folder are incorrect. Go to the folder
968 :file:`C:\\Users\\USERNAME\\AppData\\Local` in Windows Explorer and then
969 right click on the :file:`Temp` folder and select :guilabel:`Properties` and go to
970 the :guilabel:`Security` tab. Make sure that your user account has full control
971 for this folder.
972
973 If you still cannot get the installer to work and you are on Windows, you can use the :website:`calibre portable install <download_portable>`, which does not need an installer (it is just a ZIP file).
974
975 My antivirus program claims calibre is a virus/trojan?
976 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
977
978 The first thing to check is that you are downloading calibre from the
979 :website:`official website <download>`. Make sure you are clicking the
980 download links on the left, not the advertisements on the right. calibre is a
981 very popular program and unscrupulous people try to setup websites offering it
982 for download to fool the unwary.
983
984 If you have the official download and your antivirus program is still claiming
985 calibre is a virus, then, your antivirus program is wrong. Antivirus programs use
986 heuristics, patterns of code that "look suspicious" to detect viruses. It's
987 rather like racial profiling. calibre is a completely open source product. You
988 can actually browse the source code yourself (or hire someone to do it for you)
989 to verify that it is not a virus. Please report the false identification to
990 whatever company you buy your antivirus software from. If the antivirus program
991 is preventing you from downloading/installing calibre, disable it temporarily,
992 install calibre and then re-enable it.
993
994 How do I backup calibre?
995 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
996
997 The most important thing to backup is the calibre library folder, that contains all your books and metadata. This is the folder you chose for your calibre library when you ran calibre for the first time. You can get the path to the library folder by clicking the calibre icon on the main toolbar. You must backup this complete folder with all its files and sub-folders.
998
999 You can switch calibre to using a backed up library folder by simply clicking the calibre icon on the toolbar and choosing your backup library folder. A backed up library folder backs up your custom columns and saved searches as well as all your books and metadata.
1000
1001 If you want to backup the calibre configuration/plugins, you have to backup the config folder. You can find this config folder via :guilabel:`Preferences->Miscellaneous`. Note that restoring configuration folders is not officially supported, but should work in most cases. Just copy the contents of the backup folder into the current configuration folder to restore.
1002
1003 How do I use purchased EPUB books with calibre (or what do I do with .acsm files)?
1004 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1005 Most purchased EPUB books have :doc:`DRM <drm>`. This prevents calibre from opening them. You can still use calibre to store and transfer them to your e-book reader. First, you must authorize your reader on a Windows machine with Adobe Digital Editions. Once this is done, EPUB books transferred with calibre will work fine on your reader. When you purchase an epub book from a website, you will get an ".acsm" file. This file should be opened with Adobe Digital Editions, which will then download the actual ".epub" e-book. The e-book file will be stored in the folder "My Digital Editions", from where you can add it to calibre.
1006
1007 I am getting a "Permission Denied" error?
1008 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1009
1010 A permission denied error can occur because of many possible reasons, none of them having anything to do with calibre.
1011
1012 * You can get permission denied errors if you are using an SD card with write protect enabled.
1013 * On macOS if you get permission errors when connecting a device to calibre, you can
1014 fix that by looking under :guilabel:`System Preferences > Security and
1015 Privacy > Privacy > Files and Folders`.
1016 * If you, or some program you used changed the file permissions of the files in question to read only.
1017 * If there is a filesystem error on the device which caused your operating system to mount the filesystem in read only mode or mark a particular file as read only pending recovery.
1018 * If the files have their owner set to a user other than you.
1019 * If your file is open in another program.
1020 * If the file resides on a device, you may have reached the limit of a maximum of 256 files in the root of the device. In this case you need to reformat the device/sd card referred to in the error message with a FAT32 filesystem, or delete some files from the SD card/device memory.
1021
1022 You will need to fix the underlying cause of the permissions error before resuming to use calibre. Read the error message carefully, see what file it points to and fix the permissions on that file or its containing folders.
1023
1024 Can I have the comment metadata show up on my reader?
1025 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1026
1027 Most readers do not support this. You should complain to the manufacturer about it and hopefully if enough people complain, things will change. In the meantime, you can insert the metadata, including comments into a "Jacket page" at the start of the e-book, by using the option to "Insert metadata as page at start of book" during conversion. The option is found in the :guilabel:`Structure detection` section of the conversion settings. Note that for this to have effect you have to *convert* the book. If your book is already in a format that does not need conversion, you can convert from that format to the same format.
1028
1029 Another alternative is to create a catalog in e-book form containing a listing of all the books in your calibre library, with their metadata. Click-and-hold the :guilabel:`Convert` button to access the catalog creation tool. And before you ask, no you cannot have the catalog "link directly to" books on your reader.
1030
1031 How do I get calibre to use my HTTP proxy?
1032 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1033
1034 By default, calibre uses whatever proxy settings are set in your OS. Sometimes
1035 these are incorrect, for example, on Windows if you don't use Microsoft Edge
1036 then the proxy settings may not be up to date. You can tell calibre to use a
1037 particular proxy server by setting the ``http_proxy`` and ``https_proxy``
1038 environment variables. The format of the variable is:
1039 ``http://username:password@servername`` you should ask your network
1040 administrator to give you the correct value for this variable. Note that
1041 calibre only supports HTTP proxies not SOCKS proxies. You can see the current
1042 proxies used by calibre in Preferences->Miscellaneous.
1043
1044 I want some feature added to calibre. What can I do?
1045 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1046 You have two choices:
1047 1. Create a patch by hacking on calibre and send it to me for review and inclusion. See :website:`Development <get-involved>`.
1048 2. :website:`Open a bug requesting the feature <bugs>`. Remember that while you may think your feature request is extremely important/essential, calibre developers might not agree. Fortunately, calibre is open source, which means you always have the option of implementing your feature yourself, or hiring someone to do it for you. Furthermore, calibre has a comprehensive plugin architecture, so you might be able to develop your feature as a plugin, see :ref:`pluginstutorial`.
1049
1050 Why doesn't calibre have an automatic update?
1051 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1052
1053 For many reasons:
1054
1055 * *There is no need to update every week*. If you are happy with how calibre
1056 works turn off the update notification and be on your merry way. Check back
1057 to see if you want to update once a year or so. There is a check box to
1058 turn off the update notification, on the update notification itself.
1059
1060 * calibre downloads currently use :website_base:`about 150TB of bandwidth a month
1061 <dynamic/downloads>`. Implementing automatic
1062 updates would greatly increase that and end up costing thousands of dollars
1063 a month, which someone has to pay.
1064
1065 * If I implement a dialog that downloads the update and launches it, instead
1066 of going to the website as it does now, that would save the most ardent
1067 calibre updater, *at most five clicks a week*. There are far higher priority
1068 things to do in calibre development.
1069
1070 * If you really, really hate downloading calibre every week but still want to
1071 be up to the latest, I encourage you to run from source, which makes
1072 updating trivial. Instructions are :ref:`available here <develop>`.
1073
1074 * There are third party automatic updaters for calibre made by calibre users
1075 in the `calibre forum <https://www.mobileread.com/forums/forumdisplay.php?f=238>`_.
1076
1077 * There is a third party plugin called :guilabel:`calibre Auto-update` that you can
1078 install via :guilabel:`Preferences->Plugins->Get new plugins` for a more
1079 streamlined update experience.
1080
1081 * Additionally, some third-party updaters such as Norton or Avast may update
1082 software behind the user's back. If you find calibre has updated unexpectedly,
1083 check for the presence of one.
1084
1085 How is calibre licensed?
1086 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1087 calibre is licensed under the GNU General Public License v3 (an open source license). This means that you are free to redistribute calibre as long as you make the source code available. So if you want to put calibre on a CD with your product, you must also put the calibre source code on the CD. The source code is available `for download <https://download.calibre-ebook.com>`_. You are free to use the results of conversions from calibre however you want. You cannot use either code or libraries from calibre in your software without making your software open source. For details, see `The GNU GPL v3 <https://www.gnu.org/licenses/gpl.html>`_.
1088
1089 How do I run calibre from my USB stick?
1090 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1091
1092 A portable version of calibre is available :website:`here <download_portable>`.
1093
1094 How do I run parts of calibre like news download and the Content server on my own Linux server?
1095 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1096
1097 First, you must install calibre onto your Linux server. If your server is using
1098 a modern Linux distribution, you should have no problems installing calibre onto it.
1099
1100 .. note::
1101 calibre needs GLIBC >= 2.31 and libstdc++ >= 6.0.28. If you have an older
1102 server, you will either need to compile these from source, or use calibre
1103 3.48 which requires GLIBC >= 2.17 or 2.85.1 which requires GLIBC >= 2.13 or
1104 calibre 1.48 which requires only GLIBC >= 2.10. In addition, although the
1105 calibre command line utilities do not need a running X server, some of them
1106 do require the X server libraries to be installed on your system. This is
1107 because of Qt, which is used for various image processing tasks, and links
1108 against these libraries. If you get an ImportError about some Qt modules,
1109 you are likely missing some X libraries. Typical candidates are:
1110 ``libxcb-cursor0``, ``libxcb-xinerama0``, ``libegl1``, ``libopengl0``.
1111
1112 You can run the calibre server via the command::
1113
1114 /opt/calibre/calibre-server /path/to/the/library/you/want/to/share
1115
1116 You can download news and convert it into an e-book with the command::
1117
1118 /opt/calibre/ebook-convert "Title of news source.recipe" outputfile.epub
1119
1120 If you want to generate MOBI, use :file:`outputfile.mobi` instead and use ``--output-profile kindle``.
1121
1122 You can email downloaded news with the command::
1123
1124 /opt/calibre/calibre-smtp
1125
1126 I leave figuring out the exact command line as an exercise for the reader.
1127
1128 Finally, you can add downloaded news to the calibre library with::
1129
1130 /opt/calibre/calibredb add --with-library /path/to/library outfile.epub
1131
1132 Remember to read the :ref:`cli` section of the calibre User Manual to learn more about these, and other commands.