### Install Calibre to system locations

Source: https://github.com/kovidgoyal/calibre/blob/master/INSTALL.rst

This command installs Calibre into the system, placing binaries in <prefix>/bin, modules in <prefix>/lib/calibre, and resources in <prefix>/share/calibre. Use with sudo for system-wide installation.

```bash
sudo python setup.py install
```

--------------------------------

### Install Readability Library

Source: https://github.com/kovidgoyal/calibre/blob/master/src/calibre/ebooks/readability/README.txt

Use easy_install or pip to install the readability-lxml library.

```bash
easy_install readability-lxml
```

```bash
pip install readability-lxml
```

--------------------------------

### Enable Calibre Server to Start at Boot

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/server.rst

Command to configure the calibre-server service to automatically start when the system boots up.

```bash
sudo systemctl enable calibre-server
```

--------------------------------

### Start Calibre Content Server

Source: https://context7.com/kovidgoyal/calibre/llms.txt

Command-line options for starting the `calibre-server`. Includes basic start, authentication, custom ports, and user management.

```bash
# Basic start (serves all libraries)
calibre-server

# With authentication
calibre-server --userdb /srv/calibre/users.sqlite --enable-auth

# With URL prefix and specific listen address
calibre-server --url-prefix /calibre --port 8080 --listen-on 127.0.0.1

# Manage user accounts
calibre-server --userdb /srv/calibre/users.sqlite --manage-users

# Run as a systemd service: /etc/systemd/system/calibre-server.service
# [Unit]
# Description=calibre Content server
# After=network.target
# [Service]
# Type=simple
# User=mylinuxuser
# ExecStart=/opt/calibre/calibre-server "/path/to/calibre library"
# [Install]
# WantedBy=multi-user.target
```

--------------------------------

### EPUB Conversion Command Example

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/conversion.rst

An example command for converting a ZIP file to an EPUB using calibre's ebook-convert tool, demonstrating various options for metadata and formatting.

```bash
ebook-convert demo.zip .epub -vv --authors "Kovid Goyal" --language en --level1-toc '//*[@class="title"]' --disable-font-rescaling --page-breaks-before / --no-default-epub-cover
```

--------------------------------

### Launch normal Calibre version on Windows

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

Example .bat script to launch the release version of Calibre with a specified library path. Useful for maintaining separate normal and development installs.

```batch
calibre.exe "--with-library=C:\path\to\everyday\library folder"
```

--------------------------------

### Start Calibre Server Service

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/server.rst

Command to start the calibre-server service immediately after creating the systemd service file.

```bash
sudo systemctl start calibre-server
```

--------------------------------

### Start Calibre E-book Editor

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

Launch the E-book editor for a specific file using calibre-debug.

```bash
calibre-debug --edit-book /path/to/be/edited
```

--------------------------------

### Start Calibre E-book Viewer

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

Launch the E-book viewer with a specific file using calibre-debug.

```bash
calibre-debug -w /path/to/file/to/be/viewed
```

--------------------------------

### Import Calibre in Source Install

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

When using a source install on Linux, import init_calibre before other calibre modules to set up the interpreter environment. Then import calibre to access its functionalities.

```python
import init_calibre
import calibre

print(calibre.__version__)
```

--------------------------------

### Command-Line Usage Example

Source: https://github.com/kovidgoyal/calibre/blob/master/src/calibre/ebooks/readability/README.txt

Use the readability module from the command line to process a given URL.

```bash
python -m readability.readability -u http://pypi.python.org/pypi/readability-lxml
```

--------------------------------

### Install Calibre for development

Source: https://github.com/kovidgoyal/calibre/blob/master/INSTALL.rst

This command installs Calibre in a way that allows you to run it directly from your source directory, facilitating development and hacking. Binaries are placed in /usr/bin, but code is read from your source tree.

```bash
sudo python setup.py develop
```

--------------------------------

### MOBI TBS Starting Record with Two Section Transitions

Source: https://github.com/kovidgoyal/calibre/blob/master/src/calibre/ebooks/mobi/tbs_periodicals.rst

Example of a TBS byte sequence for a starting record with two section transitions, indicating multiple complete and starting index entries.

```plaintext
TBS bytes: 86 80 2 c0 b8 c4 3
    Complete:
        Index Entry: 1 (Parent index: 0, Depth: 1, Offset: 564, Size: 375) [Ars Technica]
        Index Entry: 5 (Parent index: 1, Depth: 2, Offset: 572, Size: 367) [Week in gaming: 3DS review, Crysis 2, George Hotz]
        Index Entry: 6 (Parent index: 2, Depth: 2, Offset: 947, Size: 1014) [Max and the Magic Marker for iPad: Review]
        Index Entry: 7 (Parent index: 2, Depth: 2, Offset: 1961, Size: 1077) [iPad 2 steers itself into home console gaming territory with Real Racing 2 HD]
    Starts:
        Index Entry: 0 (Parent index: -1, Depth: 0, Offset: 215, Size: 35372) [j_x's Google reader]
        Index Entry: 2 (Parent index: 0, Depth: 1, Offset: 939, Size: 10368) [Neowin.net]
        Index Entry: 8 (Parent index: 2, Depth: 2, Offset: 3038, Size: 1082) [Microsoft's Joe Belfiore still working on upcoming Zune hardware]
    TBS Type: 110 (6)
    Outer Index entry: 0
    Unknown (vwi: always 0?): 0
    Unknown (byte: always 2?): 2
    Article index at start of record or first article index, relative to parent section (fvwi): 4 [5 absolute]
    Remaining bytes: b8 c4 3
```

--------------------------------

### List available setup.py functions

Source: https://github.com/kovidgoyal/calibre/blob/master/INSTALL.rst

Use this command to see all available functions for the setup.py script. This helps in understanding the build and installation options.

```bash
python setup.py -h
```

--------------------------------

### Get help for a specific setup.py function

Source: https://github.com/kovidgoyal/calibre/blob/master/INSTALL.rst

To understand the usage and options of a particular setup.py function, append '-h' after the function name. This provides detailed help for that specific command.

```bash
python setup.py <function> -h
```

--------------------------------

### GPM Nested Function Example

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/template_lang.rst

This GPM template shows nested functions, similar to the TPM example, but uses explicit function calls for 'uppercase' and 'substr' with 'field('series')' to get the value.

```template
program: uppercase(substr(field('series'), 0,5))
```

--------------------------------

### Python Usage Example

Source: https://github.com/kovidgoyal/calibre/blob/master/src/calibre/ebooks/readability/README.txt

Import the Document class and use it to parse HTML from a URL to get the article summary and title.

```python
from readability.readability import Document
import urllib
html = urllib.urlopen(url).read()
readable_article = Document(html).summary()
readable_title = Document(html).short_title()
```

--------------------------------

### GPM Template Example

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/template_lang.rst

The equivalent of the SFM template in GPM. It uses the 'program:' prefix and explicitly calls the 'field' function to get the series value.

```template
program: ifempty(field('series'), 'no series')
```

--------------------------------

### Test Development Setup with Calibredb

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

After setting the CALIBRE_DEVELOP_FROM environment variable, run 'calibredb' to verify that your changes are loaded. The output should include the print statement added to src\calibre\__init__.py.

```bash
print("Hello, world!")
```

--------------------------------

### Start Calibre Server with URL Prefix

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/server.rst

Run the Calibre server with the --url-prefix option to serve all content under a specific URL path. This allows integration into an existing site without a dedicated virtual host.

```bash
calibre-server --url-prefix /calibre --port 8080
```

--------------------------------

### Complete HTML file with mathematics

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/typesetting_math.rst

A full HTML file example demonstrating inline and block mathematics using TeX notation, suitable for conversion to EPUB.

```html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>MathJax Example</title>
<script type="text/x-mathjax-config"></script>
<script type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
<style>
  body {
    font-family: "Helvetica", "Arial", sans-serif;
  }
  h1 {
    text-align: center;
  }
  p {
    font-size: 1.2em;
  }
  .equation {
    text-align: center;
    font-size: 1.5em;
    margin: 1em 0;
  }
</style>
</head>
<body>

<h1>Mathematics in E-books</h1>

<p>
This is an example of an e-book with mathematics. We use the MathJax library to render
mathematics. You can write mathematics inline or in display blocks.
</p>

<h2>Inline Mathematics</h2>

<p>
Here is some inline mathematics: \( E = mc^2 \). Notice how it is embedded directly
in the text. You can also use commands like \( \sum_{i=1}^n i = \frac{n(n+1)}{2} \).
</p>

<h2>Display Mathematics</h2>

<p>
Here is a display equation:
</p>

<p class="equation">
\begin{equation}
  \int_0^\infty \frac{x^3}{e^x - 1} dx = \frac{\pi^4}{15}
\end{equation}
</p>

<h2>The Lorenz Equations</h2>

<p class="equation">
\begin{align}
  \dot{x} &amp; = \sigma(y-x) \\
  \dot{y} &amp; = \rho x - y - xz \\
  \dot{z} &amp; = -\beta z + xy
\end{align}
</p>

<p>
This is the end of the example. You can convert this HTML file to EPUB using
calibre.
</p>

</body>
</html>

```

--------------------------------

### Start Interactive Python Session

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

Insert these lines to start an interactive Python session with access to local variables and tab completion.

```python
from calibre import ipython
ipython(locals())
```

--------------------------------

### Build Calibre Windows Installers

Source: https://github.com/kovidgoyal/calibre/blob/master/bypy/README.rst

Generates the Calibre Windows installers (.exe) after dependencies have been built. The --dont-sign flag can be used to skip signing.

```bash
./setup.py win64 --dont-sign
```

--------------------------------

### Get Help for ebook-convert Command

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/faq.rst

Use the -h flag with the ebook-convert command to get detailed help on individual conversion features directly from the terminal.

```bash
ebook-convert dummy.html .epub -h
```

--------------------------------

### Calibre Server Startup with URL Prefix

Source: https://context7.com/kovidgoyal/calibre/llms.txt

Start the calibre server with a specified URL prefix, port, and authentication settings. This command is often used in conjunction with reverse proxy configurations.

```bash
calibre-server --url-prefix /calibre --port 8080 --listen-on 127.0.0.1 \
  --userdb /srv/calibre/users.sqlite --enable-auth --auth-mode=basic \
  "/path/to/Calibre Library"
```

--------------------------------

### Get Current Editor Container Object

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/polish.rst

In a plugin for the E-book editor, get the container for the currently opened book. Handle the case where no book is open.

```python
from calibre.gui2.tweak_book import current_container
container = current_container()
if container is None:
    report_error # No book has been opened yet
```

--------------------------------

### Setup Local Calibre Fork with Git

Source: https://github.com/kovidgoyal/calibre/blob/master/manual/develop.rst

Clone your Calibre fork and set up the upstream remote for future updates. Replace <username> with your GitHub username.

```bash
git clone git@github.com:<username>/calibre.git
git remote add upstream https://github.com/kovidgoyal/calibre.git
```