CINXE.COM
calibre User Manual — calibre 7.26.0 documentation
<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>calibre User Manual — calibre 7.26.0 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> <link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f6a572b4" /> <link rel="stylesheet" type="text/css" href="_static/custom.css?v=9c7a92a5" /> <script src="_static/documentation_options.js?v=208d39be"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within calibre 7.26.0 documentation" href="_static/opensearch.xml"/> <link rel="icon" href="_static/favicon.ico"/> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="The Graphical User Interface" href="gui.html" /> <!-- Global site tag (gtag.js) - Google Analytics --> <script async src="https://www.googletagmanager.com/gtag/js?id=G-YMW4X5CSKP"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-YMW4X5CSKP'); </script> <!-- InMobi Choice. Consent Manager Tag v3.0 (for TCF 2.2) --> <script type="text/javascript" async=true> (function() { var host = window.location.hostname; var element = document.createElement('script'); var firstScript = document.getElementsByTagName('script')[0]; var url = 'https://cmp.inmobi.com' .concat('/choice/', '593Yp13RM2k2D', '/', host, '/choice.js?tag_version=V3'); var uspTries = 0; var uspTriesLimit = 3; element.async = true; element.type = 'text/javascript'; element.src = url; firstScript.parentNode.insertBefore(element, firstScript); function makeStub() { var TCF_LOCATOR_NAME = '__tcfapiLocator'; var queue = []; var win = window; var cmpFrame; function addFrame() { var doc = win.document; var otherCMP = !!(win.frames[TCF_LOCATOR_NAME]); if (!otherCMP) { if (doc.body) { var iframe = doc.createElement('iframe'); iframe.style.cssText = 'display:none'; iframe.name = TCF_LOCATOR_NAME; doc.body.appendChild(iframe); } else { setTimeout(addFrame, 5); } } return !otherCMP; } function tcfAPIHandler() { var gdprApplies; var args = arguments; if (!args.length) { return queue; } else if (args[0] === 'setGdprApplies') { if ( args.length > 3 && args[2] === 2 && typeof args[3] === 'boolean' ) { gdprApplies = args[3]; if (typeof args[2] === 'function') { args[2]('set', true); } } } else if (args[0] === 'ping') { var retr = { gdprApplies: gdprApplies, cmpLoaded: false, cmpStatus: 'stub' }; if (typeof args[2] === 'function') { args[2](retr); } } else { if(args[0] === 'init' && typeof args[3] === 'object') { args[3] = Object.assign(args[3], { tag_version: 'V3' }); } queue.push(args); } } function postMessageEventHandler(event) { var msgIsString = typeof event.data === 'string'; var json = {}; try { if (msgIsString) { json = JSON.parse(event.data); } else { json = event.data; } } catch (ignore) {} var payload = json.__tcfapiCall; if (payload) { window.__tcfapi( payload.command, payload.version, function(retValue, success) { var returnMsg = { __tcfapiReturn: { returnValue: retValue, success: success, callId: payload.callId } }; if (msgIsString) { returnMsg = JSON.stringify(returnMsg); } if (event && event.source && event.source.postMessage) { event.source.postMessage(returnMsg, '*'); } }, payload.parameter ); } } while (win) { try { if (win.frames[TCF_LOCATOR_NAME]) { cmpFrame = win; break; } } catch (ignore) {} if (win === window.top) { break; } win = win.parent; } if (!cmpFrame) { addFrame(); win.__tcfapi = tcfAPIHandler; win.addEventListener('message', postMessageEventHandler, false); } }; makeStub(); function makeGppStub() { const CMP_ID = 10; const SUPPORTED_APIS = [ '2:tcfeuv2', '6:uspv1', '7:usnatv1', '8:usca', '9:usvav1', '10:uscov1', '11:usutv1', '12:usctv1' ]; window.__gpp_addFrame = function (n) { if (!window.frames[n]) { if (document.body) { var i = document.createElement("iframe"); i.style.cssText = "display:none"; i.name = n; document.body.appendChild(i); } else { window.setTimeout(window.__gpp_addFrame, 10, n); } } }; window.__gpp_stub = function () { var b = arguments; __gpp.queue = __gpp.queue || []; __gpp.events = __gpp.events || []; if (!b.length || (b.length == 1 && b[0] == "queue")) { return __gpp.queue; } if (b.length == 1 && b[0] == "events") { return __gpp.events; } var cmd = b[0]; var clb = b.length > 1 ? b[1] : null; var par = b.length > 2 ? b[2] : null; if (cmd === "ping") { clb( { gppVersion: "1.1", // must be “Version.Subversion”, current: “1.1” cmpStatus: "stub", // possible values: stub, loading, loaded, error cmpDisplayStatus: "hidden", // possible values: hidden, visible, disabled signalStatus: "not ready", // possible values: not ready, ready supportedAPIs: SUPPORTED_APIS, // list of supported APIs cmpId: CMP_ID, // IAB assigned CMP ID, may be 0 during stub/loading sectionList: [], applicableSections: [-1], gppString: "", parsedSections: {}, }, true ); } else if (cmd === "addEventListener") { if (!("lastId" in __gpp)) { __gpp.lastId = 0; } __gpp.lastId++; var lnr = __gpp.lastId; __gpp.events.push({ id: lnr, callback: clb, parameter: par, }); clb( { eventName: "listenerRegistered", listenerId: lnr, // Registered ID of the listener data: true, // positive signal pingData: { gppVersion: "1.1", // must be “Version.Subversion”, current: “1.1” cmpStatus: "stub", // possible values: stub, loading, loaded, error cmpDisplayStatus: "hidden", // possible values: hidden, visible, disabled signalStatus: "not ready", // possible values: not ready, ready supportedAPIs: SUPPORTED_APIS, // list of supported APIs cmpId: CMP_ID, // list of supported APIs sectionList: [], applicableSections: [-1], gppString: "", parsedSections: {}, }, }, true ); } else if (cmd === "removeEventListener") { var success = false; for (var i = 0; i < __gpp.events.length; i++) { if (__gpp.events[i].id == par) { __gpp.events.splice(i, 1); success = true; break; } } clb( { eventName: "listenerRemoved", listenerId: par, // Registered ID of the listener data: success, // status info pingData: { gppVersion: "1.1", // must be “Version.Subversion”, current: “1.1” cmpStatus: "stub", // possible values: stub, loading, loaded, error cmpDisplayStatus: "hidden", // possible values: hidden, visible, disabled signalStatus: "not ready", // possible values: not ready, ready supportedAPIs: SUPPORTED_APIS, // list of supported APIs cmpId: CMP_ID, // CMP ID sectionList: [], applicableSections: [-1], gppString: "", parsedSections: {}, }, }, true ); } else if (cmd === "hasSection") { clb(false, true); } else if (cmd === "getSection" || cmd === "getField") { clb(null, true); } //queue all other commands else { __gpp.queue.push([].slice.apply(b)); } }; window.__gpp_msghandler = function (event) { var msgIsString = typeof event.data === "string"; try { var json = msgIsString ? JSON.parse(event.data) : event.data; } catch (e) { var json = null; } if (typeof json === "object" && json !== null && "__gppCall" in json) { var i = json.__gppCall; window.__gpp( i.command, function (retValue, success) { var returnMsg = { __gppReturn: { returnValue: retValue, success: success, callId: i.callId, }, }; event.source.postMessage(msgIsString ? JSON.stringify(returnMsg) : returnMsg, "*"); }, "parameter" in i ? i.parameter : null, "version" in i ? i.version : "1.1" ); } }; if (!("__gpp" in window) || typeof window.__gpp !== "function") { window.__gpp = window.__gpp_stub; window.addEventListener("message", window.__gpp_msghandler, false); window.__gpp_addFrame("__gppLocator"); } }; makeGppStub(); var uspStubFunction = function() { var arg = arguments; if (typeof window.__uspapi !== uspStubFunction) { setTimeout(function() { if (typeof window.__uspapi !== 'undefined') { window.__uspapi.apply(window.__uspapi, arg); } }, 500); } }; var checkIfUspIsReady = function() { uspTries++; if (window.__uspapi === uspStubFunction && uspTries < uspTriesLimit) { console.warn('USP is not accessible'); } else { clearInterval(uspInterval); } }; if (typeof window.__uspapi === 'undefined') { window.__uspapi = uspStubFunction; var uspInterval = setInterval(checkIfUspIsReady, 6000); } })(); </script> <!-- End InMobi Choice. Consent Manager Tag v3.0 (for TCF 2.2) --> <script data-cfasync="false" type="text/javascript"> var freestar = freestar || {}; freestar.hitTime = Date.now(); freestar.queue = freestar.queue || []; freestar.config = freestar.config || {}; freestar.debug = window.location.search.indexOf('fsdebug') === -1 ? false : true; freestar.config.enabled_slots = []; !function(a,b){var c=b.getElementsByTagName("script")[0],d=b.createElement("script"),e="https://a.pub.network/manual-calibre-ebook-com";e+=freestar.debug?"/qa/pubfig.min.js":"/pubfig.min.js",d.async=!0,d.src=e,c.parentNode.insertBefore(d,c)}(window,document); freestar.initCallback = function () { (freestar.config.enabled_slots.length === 0) ? freestar.initCallbackCalled = false : freestar.newAdSlots(freestar.config.enabled_slots) } </script> <style type="text/css"> @media screen and (max-width: 875px) { body { padding-top: 0; padding-bottom: 0; } div.related { display: none; } ul { margin-left: 0.75em; } /* fix bullets being displayed outside container */ } @media screen and (min-width: 876px) { body { display: grid; grid-template-rows: [top] 3.5ex [r] auto; grid-template-columns: [left] 220px [c] auto; height: 100vh; width: 100vw; max-height: 100vh; max-width: 100vw; } div.related { height: 3.5ex; display: flex; align-items: center; box-sizing: border-box; grid-row-start: top; grid-row-end: span 1; grid-column-start: left; grid-column-end: span 2; } div.documentwrapper { grid-row-start: r; grid-row-end: span 1; grid-column-start: c; grid-column-end: span 1; overflow: auto; } div.related > ul { flex-grow: 10; } div.sphinxsidebar { overflow-y: auto; grid-row-start: r; grid-row-end: span 1; grid-column-start: left; grid-column-end: span 2; position: static; } div.document { margin-top: 0; } } div.document, div.footer { width: auto; /* fix horizontal scrollbar if screen is less that 940px */ } </style> </head><body> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="py-modindex.html" title="Python Module Index" >modules</a></li> <li class="right" > <a href="gui.html" title="The Graphical User Interface" accesskey="N">next</a> |</li> <li class="nav-item nav-item-0"><a href="#">Start</a> »</li> <li class="nav-item nav-item-this"><a href="">calibre User Manual</a></li> </ul> </div> <div class="sphinxsidebar" role="navigation" aria-label="Main"> <div class="sphinxsidebarwrapper"><script type="text/javascript"> function toggle_languages_menu() { var m = document.getElementById('languages-menu'); if (m.style.display === "block") m.style.display = "none"; else m.style.display = "block"; } </script> <div style="text-align: center"> <a href="https://calibre-ebook.com" title="calibre homepage" id="calibre-homepage-logo"><img src="_static/logo.png" /></a> <br/> <form id="donate_form" action="https://www.paypal.com/cgi-bin/webscr" method="post" title="Contribute to support calibre development"> <style> #donate_form input[type=submit] { border-radius: 6px; box-shadow: rgb(255, 246, 175) 0px 1px 0px 0px; background: linear-gradient(rgb(255, 236, 100) 5%, rgb(255, 171, 35) 100%) rgb(255, 236, 100); border: 1px solid rgb(255, 170, 34); display: inline-block; cursor: pointer; color: rgb(51, 51, 51); font-family: Arial; font-size: 15px; font-weight: bold; padding: 6px 24px; text-decoration: none; text-shadow: rgb(255, 238, 102) 0px 1px 0px; } #donate_form input[type=submit]:hover { background: linear-gradient(rgb(255, 171, 35) 5%, rgb(255, 236, 100) 100%) rgb(255, 171, 35); } #donate_form input[type=submit]:focus { outline: 0; } </style> <input type="hidden" name="cmd" value="_s-xclick" /> <input type="hidden" name="hosted_button_id" value="AF4H3B8QVDG6N" /> <input type="submit" name="submit" alt="Contribute to support calibre development" value="Support calibre" /> <img alt="" border="0" src="https://www.paypalobjects.com/en_GB/i/scr/pixel.gif" width="1" height="1" /> </form> </div> <div style="margin-top: 1.5ex"><a href="#" onclick="toggle_languages_menu(); return false;"><img src="_static/languages.svg" style="width: 1.2em"/> Change language</a></div> <ul id="languages-menu" style="display:none"> <li><a href="/pt_BR/index.html">Brazilian Portuguese</a></li> <li><a href="/cs/index.html">Czech</a></li> <li><a href="/nl/index.html">Dutch</a></li> <li><a href="/et/index.html">Estonian</a></li> <li><a href="/fr/index.html">French</a></li> <li><a href="/de/index.html">German</a></li> <li><a href="/it/index.html">Italian</a></li> <li><a href="/ja/index.html">Japanese</a></li> <li><a href="/pl/index.html">Polish</a></li> <li><a href="/pt/index.html">Portuguese</a></li> <li><a href="/ru/index.html">Russian</a></li> <li><a href="/zh_CN/index.html">Simplified Chinese</a></li> <li><a href="/es/index.html">Spanish</a></li> <li><a href="/sv/index.html">Swedish</a></li> <li><a href="/tr/index.html">Turkish</a></li> <li><a href="/uk/index.html">Ukrainian</a></li> </ul> <div id="searchbox" role="search"> <form class="search" action="search.html" method="get"> <div style="display: flex"> <input type="text" name="q" placeholder="Search" /> <input type="submit" title="Search" value="🔍" /> </div> </form> </div> <style> ul#sidebar-collapsible-toc li { list-style: none; margin-left: 0; padding-left: 0.2em; text-indent: -0.7em; } ul#sidebar-collapsible-toc li.leaf-node { text-indent: 0; } ul#sidebar-collapsible-toc li input[type=checkbox] { display: none; } ul#sidebar-collapsible-toc li > label { cursor: pointer; } ul#sidebar-collapsible-toc li > input[type=checkbox] ~ ul > li { display: none; } ul#sidebar-collapsible-toc li > input[type=checkbox]:checked ~ ul > li { display: block; } ul#sidebar-collapsible-toc li > input[type=checkbox]:checked + label:before { content: "\025bf"; } ul#sidebar-collapsible-toc li > input[type=checkbox]:not(:checked) + label:before { content: "\025b8"; } </style><ul id="sidebar-collapsible-toc"> <li class="leaf-node"><a class="reference internal" href="#the-main-calibre-user-interface">The main calibre user interface</a></li> <li class="leaf-node"><a class="reference internal" href="#adding-your-favorite-news-website-to-calibre">Adding your favorite news website to calibre</a></li> <li class="leaf-node"><a class="reference internal" href="#the-calibre-e-book-viewer">The calibre E-book viewer</a></li> <li class="leaf-node"><a class="reference internal" href="#customizing-calibre-s-e-book-conversion">Customizing calibre’s e-book conversion</a></li> <li class="leaf-node"><a class="reference internal" href="#editing-e-books">Editing e-books</a></li> <li class="leaf-node"><a class="reference internal" href="#the-calibre-content-server">The calibre Content server</a></li> <li class="leaf-node"><a class="reference internal" href="#comparing-e-books">Comparing e-books</a></li> <li class="leaf-node"><a class="reference internal" href="#editing-e-book-metadata">Editing e-book metadata</a></li> <li class="leaf-node"><a class="reference internal" href="#frequently-asked-questions">Frequently Asked Questions</a></li> <li class="leaf-node"><a class="reference internal" href="#tutorials">Tutorials</a></li> <li class="leaf-node"><a class="reference internal" href="#customizing-calibre">Customizing calibre</a></li> <li class="leaf-node"><a class="reference internal" href="#the-command-line-interface">The Command Line Interface</a></li> <li class="leaf-node"><a class="reference internal" href="#setting-up-a-calibre-development-environment">Setting up a calibre development environment</a></li> </ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="#">Documentation overview</a><ul> <li>Next: <a href="gui.html" title="next chapter">The Graphical User Interface</a></li> </ul></li> </ul> </div> </div> </div> <div class="documentwrapper"> <div class="body" role="main"> <div id="ad-container" style="text-align:center"> <div align="center" data-freestar-ad="__970x90 __336x280" id="manualcalibre-ebook_leaderboard_atf"> <script data-cfasync="false" type="text/javascript"> freestar.config.enabled_slots.push({ placementName: "manualcalibre-ebook_leaderboard_atf", slotId: "manualcalibre-ebook_leaderboard_atf" }); </script> </div> </div> <section id="calibre-user-manual"> <h1>calibre User Manual<a class="headerlink" href="#calibre-user-manual" title="Link to this heading">¶</a></h1> <p>calibre is an e-book library manager. It can view, convert and catalog e-books in most of the major e-book formats. It can also talk to many e-book reader devices. It can go out to the Internet and fetch metadata for your books. It can download newspapers and convert them into e-books for convenient reading. It is cross platform, running on Linux, Windows and macOS.</p> <p>You’ve just started calibre. What do you do now? Before calibre can do anything with your e-books, it first has to know about them. Drag and drop a few e-book files into calibre, or click the “Add books” button and browse for the e-books you want to work with. Once you’ve added the books, they will show up in the main view looking something like this:</p> <img alt="_images/added_books.png" src="_images/added_books.png" /> <p>Once you’ve admired the list of books you just added to your heart’s content, you’ll probably want to read one. In order to do that you’ll have to convert the book to a format your reader understands. When first running calibre, the <span class="guilabel">Welcome wizard</span> starts and will set up calibre for your reader device. Conversion is a breeze. Just select the book you want to convert then click the “Convert books” button. Ignore all the options for now and click “OK”. The little icon in the bottom right corner will start spinning. Once it’s finished spinning, your converted book is ready. Click the “View” button to read the book.</p> <p>If you want to read the book on your reader, connect the reader to the computer, wait till calibre detects it (10-20 seconds) and then click the “Send to device” button. Once the icon stops spinning again, disconnect your reader and read away! If you didn’t convert the book in the previous step, calibre will auto convert it to the format your reader device understands.</p> <p>To get started with more advanced usage, you should read about <a class="reference internal" href="gui.html"><span class="doc">The Graphical User Interface</span></a>. For even more power and versatility, learn the <a class="reference internal" href="generated/en/cli-index.html"><span class="doc">Command Line Interface</span></a>. You will find the list of <a class="reference internal" href="faq.html"><span class="doc">Frequently Asked Questions</span></a> useful as well.</p> <p>If you have more questions, or want to discuss calibre with other users or ask for help with specific things, there are <a class="extlink-website reference external" href="https://calibre-ebook.com/help">forums and other help resources available</a>.</p> <p><strong>An e-book version of this User Manual is available in</strong> <a class="reference external" href="calibre.epub">EPUB format</a>, <a class="reference external" href="calibre.azw3">AZW3 (Kindle) format</a> and <a class="reference external" href="calibre.pdf">PDF format</a>.</p> <p class="rubric">Sections</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="gui.html">The Graphical User Interface</a></li> <li class="toctree-l1"><a class="reference internal" href="news.html">Adding your favorite news website</a></li> <li class="toctree-l1"><a class="reference internal" href="viewer.html">The E-book viewer</a></li> <li class="toctree-l1"><a class="reference internal" href="conversion.html">E-book conversion</a></li> <li class="toctree-l1"><a class="reference internal" href="edit.html">Editing e-books</a></li> <li class="toctree-l1"><a class="reference internal" href="server.html">The calibre Content server</a></li> <li class="toctree-l1"><a class="reference internal" href="diff.html">Comparing e-books</a></li> <li class="toctree-l1"><a class="reference internal" href="metadata.html">Editing e-book metadata</a></li> <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li> <li class="toctree-l1"><a class="reference internal" href="url_scheme.html">The calibre:// URL scheme</a></li> <li class="toctree-l1"><a class="reference internal" href="customize.html">Customizing calibre</a></li> <li class="toctree-l1"><a class="reference internal" href="generated/en/cli-index.html">Command Line Interface</a></li> <li class="toctree-l1"><a class="reference internal" href="develop.html">Setting up a calibre development environment</a></li> <li class="toctree-l1"><a class="reference internal" href="drm.html">Digital Rights Management (DRM)</a></li> <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li> </ul> </div> <section id="the-main-calibre-user-interface"> <h2>The main calibre user interface<a class="headerlink" href="#the-main-calibre-user-interface" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="gui.html">The Graphical User Interface</a><ul> <li class="toctree-l2"><a class="reference internal" href="gui.html#actions">Actions</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#preferences">Preferences</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#catalogs">Catalogs</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#search-sort">Search & sort</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#the-search-interface">The search interface</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#saving-searches">Saving searches</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#searching-the-full-text-of-all-books">Searching the full text of all books</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#virtual-libraries">Virtual libraries</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#temporarily-marking-books">Temporarily marking books</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#guessing-metadata-from-file-names">Guessing metadata from file names</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#book-details">Book details</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#tag-browser">Tag browser</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#cover-grid">Cover grid</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#cover-browser">Cover browser</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#adding-notes-for-authors-series-etc">Adding notes for authors, series, etc.</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#quickview">Quickview</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#jobs">Jobs</a></li> <li class="toctree-l2"><a class="reference internal" href="gui.html#keyboard-shortcuts">Keyboard shortcuts</a></li> </ul> </li> </ul> </div> </section> <section id="adding-your-favorite-news-website-to-calibre"> <h2>Adding your favorite news website to calibre<a class="headerlink" href="#adding-your-favorite-news-website-to-calibre" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="news.html">Adding your favorite news website</a><ul> <li class="toctree-l2"><a class="reference internal" href="news.html#completely-automatic-fetching">Completely automatic fetching</a></li> <li class="toctree-l2"><a class="reference internal" href="news.html#customizing-the-fetch-process">Customizing the fetch process</a></li> <li class="toctree-l2"><a class="reference internal" href="news.html#tips-for-developing-new-recipes">Tips for developing new recipes</a></li> <li class="toctree-l2"><a class="reference internal" href="news.html#further-reading">Further reading</a></li> <li class="toctree-l2"><a class="reference internal" href="news.html#api-documentation">API documentation</a></li> </ul> </li> </ul> </div> </section> <section id="the-calibre-e-book-viewer"> <h2>The calibre E-book viewer<a class="headerlink" href="#the-calibre-e-book-viewer" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="viewer.html">The E-book viewer</a><ul> <li class="toctree-l2"><a class="reference internal" href="viewer.html#starting-the-e-book-viewer">Starting the E-book viewer</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#navigating-around-an-e-book">Navigating around an e-book</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#highlighting-text">Highlighting text</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#read-aloud">Read aloud</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#searching-the-text">Searching the text</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#following-links-using-only-the-keyboard">Following links using only the keyboard</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#customizing-the-look-and-feel-of-your-reading-experience">Customizing the look and feel of your reading experience</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#dictionary-lookup">Dictionary lookup</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#copying-text-and-images">Copying text and images</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#zooming-in-on-images">Zooming in on images</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#syncing-with-a-paper-edition-of-the-current-book">Syncing with a paper edition of the current book</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#keyboard-shortcuts">Keyboard shortcuts</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#non-re-flowable-content">Non re-flowable content</a></li> <li class="toctree-l2"><a class="reference internal" href="viewer.html#designing-your-book-to-work-well-with-the-calibre-e-book-viewer">Designing your book to work well with the calibre E-book viewer</a></li> </ul> </li> </ul> </div> </section> <section id="customizing-calibre-s-e-book-conversion"> <h2>Customizing calibre’s e-book conversion<a class="headerlink" href="#customizing-calibre-s-e-book-conversion" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="conversion.html">E-book conversion</a><ul> <li class="toctree-l2"><a class="reference internal" href="conversion.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#look-feel">Look & feel</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#page-setup">Page setup</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#heuristic-processing">Heuristic processing</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#search-replace">Search & replace</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#structure-detection">Structure detection</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#table-of-contents">Table of Contents</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#using-images-as-chapter-titles-when-converting-html-input-documents">Using images as chapter titles when converting HTML input documents</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#using-tag-attributes-to-supply-the-text-for-entries-in-the-table-of-contents">Using tag attributes to supply the text for entries in the Table of Contents</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#how-options-are-set-saved-for-conversion">How options are set/saved for conversion</a></li> <li class="toctree-l2"><a class="reference internal" href="conversion.html#format-specific-tips">Format specific tips</a></li> </ul> </li> </ul> </div> </section> <section id="editing-e-books"> <h2>Editing e-books<a class="headerlink" href="#editing-e-books" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="edit.html">Editing e-books</a><ul> <li class="toctree-l2"><a class="reference internal" href="edit.html#basic-workflow">Basic workflow</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#the-file-browser">The File browser</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#search-replace">Search & replace</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#automated-tools">Automated tools</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#checkpoints">Checkpoints</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#the-live-preview-panel">The Live preview panel</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#the-live-css-panel">The Live CSS panel</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#miscellaneous-tools">Miscellaneous tools</a></li> <li class="toctree-l2"><a class="reference internal" href="edit.html#special-features-in-the-code-editor">Special features in the code editor</a></li> </ul> </li> </ul> </div> </section> <section id="the-calibre-content-server"> <h2>The calibre Content server<a class="headerlink" href="#the-calibre-content-server" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="server.html">The calibre Content server</a><ul> <li class="toctree-l2"><a class="reference internal" href="server.html#accessing-the-content-server-from-other-devices">Accessing the Content server from other devices</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#the-server-interface">The server interface</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#browser-support">Browser support</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#enabling-offline-support">Enabling offline support</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#managing-user-accounts-from-the-command-line-only">Managing user accounts from the command-line only</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#integrating-the-calibre-content-server-into-other-servers">Integrating the calibre Content server into other servers</a></li> <li class="toctree-l2"><a class="reference internal" href="server.html#creating-a-service-for-the-calibre-server-on-a-modern-linux-system">Creating a service for the calibre server on a modern Linux system</a></li> </ul> </li> </ul> </div> </section> <section id="comparing-e-books"> <h2>Comparing e-books<a class="headerlink" href="#comparing-e-books" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="diff.html">Comparing e-books</a><ul> <li class="toctree-l2"><a class="reference internal" href="diff.html#understanding-the-comparison-view">Understanding the comparison view</a></li> <li class="toctree-l2"><a class="reference internal" href="diff.html#launching-the-comparison-tool">Launching the comparison tool</a></li> </ul> </li> </ul> </div> </section> <section id="editing-e-book-metadata"> <h2>Editing e-book metadata<a class="headerlink" href="#editing-e-book-metadata" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="metadata.html">Editing e-book metadata</a><ul> <li class="toctree-l2"><a class="reference internal" href="metadata.html#editing-the-metadata-of-one-book-at-a-time">Editing the metadata of one book at a time</a></li> <li class="toctree-l2"><a class="reference internal" href="metadata.html#editing-the-metadata-of-many-books-at-a-time">Editing the metadata of many books at a time</a></li> <li class="toctree-l2"><a class="reference internal" href="metadata.html#adding-extra-data-files-to-a-book">Adding extra data files to a book</a></li> </ul> </li> </ul> </div> </section> <section id="frequently-asked-questions"> <h2>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a><ul> <li class="toctree-l2"><a class="reference internal" href="faq.html#e-book-format-conversion">E-book format conversion</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#device-integration">Device integration</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#library-management">Library management</a></li> <li class="toctree-l2"><a class="reference internal" href="faq.html#miscellaneous">Miscellaneous</a></li> </ul> </li> </ul> </div> </section> <section id="tutorials"> <h2>Tutorials<a class="headerlink" href="#tutorials" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul> <li class="toctree-l2"><a class="reference internal" href="news.html">Adding your favorite news website</a></li> <li class="toctree-l2"><a class="reference internal" href="sub_groups.html">Managing subgroups of books, for example “genre”</a></li> <li class="toctree-l2"><a class="reference internal" href="xpath.html">XPath tutorial</a></li> <li class="toctree-l2"><a class="reference internal" href="template_lang.html">The calibre template language</a></li> <li class="toctree-l2"><a class="reference internal" href="regexp.html">All about using regular expressions in calibre</a></li> <li class="toctree-l2"><a class="reference internal" href="creating_plugins.html">Writing your own plugins to extend calibre’s functionality</a></li> <li class="toctree-l2"><a class="reference internal" href="typesetting_math.html">Typesetting mathematics in e-books</a></li> <li class="toctree-l2"><a class="reference internal" href="catalogs.html">Creating AZW3 • EPUB • MOBI catalogs</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual_libraries.html">Virtual libraries</a></li> </ul> </li> </ul> </div> </section> <section id="customizing-calibre"> <h2>Customizing calibre<a class="headerlink" href="#customizing-calibre" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="customize.html">Customizing calibre</a><ul> <li class="toctree-l2"><a class="reference internal" href="customize.html#environment-variables">Environment variables</a></li> <li class="toctree-l2"><a class="reference internal" href="customize.html#tweaks">Tweaks</a></li> <li class="toctree-l2"><a class="reference internal" href="customize.html#overriding-icons-templates-et-cetera">Overriding icons, templates, et cetera</a></li> <li class="toctree-l2"><a class="reference internal" href="customize.html#creating-your-own-icon-theme-for-calibre">Creating your own icon theme for calibre</a></li> <li class="toctree-l2"><a class="reference internal" href="customize.html#customizing-calibre-with-plugins">Customizing calibre with plugins</a></li> </ul> </li> </ul> </div> </section> <section id="the-command-line-interface"> <h2>The Command Line Interface<a class="headerlink" href="#the-command-line-interface" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="generated/en/cli-index.html">Command Line Interface</a><ul> <li class="toctree-l2"><a class="reference internal" href="generated/en/cli-index.html#documented-commands">Documented commands</a></li> <li class="toctree-l2"><a class="reference internal" href="generated/en/cli-index.html#undocumented-commands">Undocumented commands</a></li> </ul> </li> </ul> </div> </section> <section id="setting-up-a-calibre-development-environment"> <h2>Setting up a calibre development environment<a class="headerlink" href="#setting-up-a-calibre-development-environment" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="develop.html">Setting up a calibre development environment</a><ul> <li class="toctree-l2"><a class="reference internal" href="develop.html#design-philosophy">Design philosophy</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#getting-the-code">Getting the code</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#windows-development-environment">Windows development environment</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#macos-development-environment">macOS development environment</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#linux-development-environment">Linux development environment</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#having-separate-normal-and-development-calibre-installs-on-the-same-computer">Having separate “normal” and “development” calibre installs on the same computer</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#debugging-tips">Debugging tips</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#using-calibre-in-your-projects">Using calibre in your projects</a></li> <li class="toctree-l2"><a class="reference internal" href="develop.html#api-documentation-for-various-parts-of-calibre">API documentation for various parts of calibre</a></li> </ul> </li> </ul> </div> </section> </section> <div class="footer" role="contentinfo"> © Copyright Kovid Goyal. Last updated on Feb 14, 2025. </div> <!-- end content-footer --> </div> <!-- end class="body" --> </div> <!-- end documentwrapper --> </body> </html>