.. _ebook-meta-en:

.. raw:: html

    <style>code {font-size: 1em; background-color: transparent; font-family: sans-serif }</style>

``ebook-meta``
===================================================================

.. code-block:: none

    ebook-meta ebook_file [options]


Read/Write metadata from/to e-book files.

Supported formats for reading metadata: azw, azw1, azw3, azw4, cb7, cbc, cbr, cbz, chm, docx, epub, fb2, fbz, html, htmlz, imp, lit, lrf, lrx, mobi, odt, oebzip, opf, pdb, pdf, pml, pmlz, pobi, prc, rar, rb, rtf, snb, tpz, txt, txtz, updb, zip

Supported formats for writing metadata: azw, azw1, azw3, azw4, docx, epub, fb2, fbz, htmlz, lrf, mobi, odt, pdb, pdf, prc, rtf, tpz, txtz

Different file types support different kinds of metadata. If you try to set
some metadata on a file type that does not support it, the metadata will be
silently ignored.


Whenever you pass arguments to :command:`ebook-meta` that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

[options]
----------------------------------------

.. program:: ebook-meta

.. option:: --author-sort

    String to be used when sorting by author. If unspecified, and the author(s) are specified, it will be auto-generated from the author(s).

.. option:: --authors, -a

    Set the authors. Multiple authors should be separated by the & character. Author names should be in the order Firstname Lastname.

.. option:: --book-producer, -k

    Set the book producer.

.. option:: --category

    Set the book category.

.. option:: --comments, -c

    Set the e-book description.

.. option:: --cover

    Set the cover to the specified file.

.. option:: --date, -d

    Set the published date.

.. option:: --from-opf

    Read metadata from the specified OPF file and use it to set metadata in the e-book. Metadata specified on the command line will override metadata read from the OPF file

.. option:: --get-cover

    Get the cover from the e-book and save it at as the specified file.

.. option:: --help, -h

    show this help message and exit

.. option:: --identifier

    Set the identifiers for the book, can be specified multiple times. For example: :option:`--identifier` uri:https://acme.com :option:`--identifier` isbn:12345 To remove an identifier, specify no value, :option:`--identifier` isbn: Note that for EPUB files, an identifier marked as the package identifier cannot be removed.

.. option:: --index, -i

    Set the index of the book in this series.

.. option:: --isbn

    Set the ISBN of the book.

.. option:: --language, -l

    Set the language.

.. option:: --lrf-bookid

    Set the BookID in LRF files

.. option:: --publisher, -p

    Set the e-book publisher.

.. option:: --rating, -r

    Set the rating. Should be a number between 1 and 5.

.. option:: --series, -s

    Set the series this e-book belongs to.

.. option:: --tags

    Set the tags for the book. Should be a comma separated list.

.. option:: --title, -t

    Set the title.

.. option:: --title-sort

    The version of the title to be used for sorting. If unspecified, and the title is specified, it will be auto-generated from the title.

.. option:: --to-opf

    Specify the name of an OPF file. The metadata will be written to the OPF file.

.. option:: --version

    show program\ ``'``\ s version number and exit