Ubuntu Manpages

calibre-debug

calibre-debug

Add a simple plugin (i.e. a plugin that consists of only a .py file), by specifying the path to the py file containing the plugin code.

Run Python code.

Debug device detection

(Un)register calibre from Windows Default Programs. --default-programs = (register|unregister)

Run the calibre diff tool. For example: calibre-debug --diff file1 file2

Launch the calibre "Edit book" tool in debug mode. As with -g use -- to pass command line arguments.

Run the Python code in file.

Explode the book into the specified folder. Usage: -x file.epub output_dir Exports the book as a collection of HTML files and metadata, which you can edit using standard HTML editing tools. Works with EPUB, AZW3, HTMLZ and DOCX files.

Export all calibre data (books/settings/plugins). Normally, you will be asked for the export folder and the libraries to export. You can also specify them as command line arguments to skip the questions. Use absolute paths for the export folder and libraries. The special keyword "all" can be used to export all libraries. Examples: calibre-debug --export-all-calibre-data # for interactive use calibre-debug --export-all-calibre-data /path/to/empty/export/folder /path/to/library/folder1 /path/to/library2 calibre-debug --export-all-calibre-data /export/folder all # export all known libraries

Run the GUI with debugging enabled. Debug output is printed to stdout and stderr. To pass command line arguments use -- followed by the arguments, for example: calibre-debug -g -- /path/to/ebook

Run the GUI with a debug console, logging to the specified path. For internal use only, use the -g option to run the GUI in debug mode

show this help message and exit

Implode a previously exploded book. Usage: -i output_dir file.epub Imports the book from the files in output_dir which must have been created by a previous call to --explode-book. Be sure to specify the same file type as was used when exploding.

Import previously exported calibre data

Inspect the MOBI file(s) at the specified path(s)

Convert the specified EPUB file to KEPUB without doing a full conversion. This is what the Kobo driver does when sending files to the device.

Output the paths necessary to setup the calibre environment

Run a plugin that provides a command line interface. For example: calibre-debug -r "Plugin name" -- file1 --option1 Everything after the -- will be passed to the plugin as arguments.

Run the named test(s). Use the special value "all" to run all tests. If the test name starts with a period it is assumed to be a module name. If the test name starts with @ it is assumed to be a category name.

Don't run with the DEBUG flag set

Cause a running calibre instance, if any, to be shutdown. Note that if there are running jobs, they will be silently aborted, so use with care.

Subset the specified font. Use -- after this option to pass option to the font subsetting program.

Test binary modules in build

Convert the specified KEPUB file to EPUB without doing a full conversion. This is what the Kobo driver does when importing files from the device.

show program's version number and exit

Run the E-book viewer in debug mode. As with -g use -- to pass command line arguments.

Kovid Goyal

Kovid Goyal