Arch manual pages

CALIBREDB(1) calibre CALIBREDB(1)

calibredb - calibredb

calibredb agindua [aukera] [argumentuak]


calibredb is the command line interface to the calibre database. It has several sub-commands, documented below.

calibredb can be used to manipulate either a calibre database specified by path or a calibre Content server running either on the local machine or over the internet. You can start a calibre Content server using either the calibre-server program or in the main calibre program click Connect/share  →  Start Content server. Since calibredb can make changes to your calibre libraries, you must setup authentication on the server first. There are two ways to do that:

  • If you plan to connect only to a server running on the same computer, you can simply use the --enable-local-write option of the content server, to allow any program, including calibredb, running on the local computer to make changes to your calibre data. When running the server from the main calibre program, this option is in Preferences → Sharing over the net → Advanced.
  • If you want to enable access over the internet, then you should setup user accounts on the server and use the --username and --password options to calibredb to give it access. You can setup user authentication for calibre-server by using the --enable-auth option and using --manage-users to create the user accounts. If you are running the server from the main calibre program, use Preferences → Sharing over the net → Require username/password.



To connect to a running Content server, pass the URL of the server to the --with-library option, see the documentation of that option for details and examples.

  • AUKERA GLOBALAK
  • list
  • add
ADDING FROM DIRECTORIES

  • remove
  • add_format
  • remove_format
  • show_metadata
  • set_metadata
  • export
  • catalog
EPUB OPTIONS

  • saved_searches
  • add_custom_column
  • custom_columns
  • remove_custom_column
  • set_custom
  • restore_database
  • check_library
  • list_categories
  • backup_metadata
  • clone
  • embed_metadata
  • search

--help, -h
Erakutsi laguntza mezu hau eta irten

--library-path, --with-library
Path to the calibre library. Default is to use the path stored in the settings. You can also connect to a calibre Content server to perform actions on remote libraries. To do so use a URL of the form: http://hostname:port/#library_id for example, http://localhost:8080/#mylibrary. library_id is the library id of the library you want to connect to on the Content server. You can use the special library_id value of - to get a list of library ids available on the server. For details on how to setup access via a Content server, see https://manual.calibre-ebook.com/generated/en/calibredb.html.

--password
Password for connecting to a calibre Content server. To read the password from standard input, use the special value: <stdin>. To read the password from a file, use: <f:/path/to/file> (i.e. <f: followed by the full path to the file and a trailing >). The angle brackets in the above are required, remember to escape them or use quotes for your shell.

--username
Username for connecting to a calibre Content server

--version
Erakutsi programaren bertsioa zein den eta irten

calibredb list [aukerak]



calibre datu basean eskuragarri dauden liburuen zerrenda.

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

--ascending
Ordenatu emaitzak goranzka

--fields, -f
The fields to display when listing books in the database. Should be a comma separated list of fields. Available fields: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid Default: title,authors. The special field "all" can be used to select all fields. In addition to the builtin fields above, custom fields are also available as *field_name, for example, for a custom field #rating, use the name: *rating

--for-machine
Generate output in JSON format, which is more suitable for machine parsing. Causes the line width and separator options to be ignored.

--limit
Erakusteko gehienezko emaitza kopurua. Lehenetsita: denak

--line-width, -w
Lerro sinple baten zabalera maximoa. Lehenetsitako balioa: pantailaren tamaina detektatzea.

--prefix
Fitxategi bide guztietarako aurrizkia. Lehenetsia: liburutegiko karpetarako bide hutsa.

--search, -s
Bilaketa galderaren arabera iragazten ditu emaitzak. Galdetzen denaren formaturako, mesedez begiratu bilaketari buruzko dokumentazioa Erabiltzailearen eskuliburua. Lehenetsita: ez egin inolako iragazpenik.

--separator
Eremuak bereizteko erabiltzen den testua. Lehenetsia: espazio bat.

--sort-by
The field by which to sort the results. Available fields: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid Default: id

calibredb add [aukerak] fitxategi1 fitxategi2 fitxategi3 ...



Gehitu zehaztutako fitxategiak datu basera. Direktorioak ere zehaztu daitezke, ikus itzazu direktorioei buruzko aukerak beherago.

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

--authors, -a
Ezarri gehitutako liburu(ar)en egile izena

--cover, -c
Liburu-azaleko lasterbidea gehitutako liburuan erabiltzeko

--duplicates, -d
Gehitu liburuak datu-basera, nahiz eta dagoeneko bertan izan. Erkaketa liburuen izenburuetan oinarrituko da.

--empty, -e
Gehitu liburu huts bat (formaturik gabeko liburu bat)

--identifier, -I
Set the identifiers for this book, for e.g. -I asin:XXX -I isbn:YYY

--isbn, -i
Ezarri gehitutako liburu(ar)en ISSNa

--languages, -l
A comma separated list of languages (best to use ISO639 language codes, though some language names may also be recognized)

--series, -s
Ezarri gehitutako liburu(ar)en serieak

--series-index, -S
Ezarri gehitutako liburu(ar)en serie zenbakia

--tags, -T
Ezarri gehitutako liburu(ar)en etiketak

--title, -t
Ezarri gehitutako liburu(ar)en izenburua

Options to control the adding of books from directories. By default only files that have extensions of known e-book file types are added.
--add
A filename (glob) pattern, files matching this pattern will be added when scanning directories for files, even if they are not of a known e-book file type. Can be specified multiple times for multiple patterns.

--ignore
A filename (glob) pattern, files matching this pattern will be ignored when scanning directories for files. Can be specified multiple times for multiple patterns. For e.g.: *.pdf will ignore all pdf files

--one-book-per-directory, -1
Onartu direktorio bakoitzak liburu bakarra daukala loturik eta beraz karpetako fitxategi guztiak liburu beraren formatu desberdinak direla

--recurse, -r
Prozesatu direktorioak modu errekurtsiboan

calibredb remove ids



Remove the books identified by ids from the database. ids should be a comma separated list of id numbers (you can get id numbers by using the search command). For example, 23,34,57-85 (when specifying a range, the last number in the range is not included).

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

--permanent
Do not use the recycle bin

calibredb add_format [options] id ebook_file



Add the e-book in ebook_file to the available formats for the logical book identified by id. You can get id by using the search command. If the format already exists, it is replaced, unless the do not replace option is specified.

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

--dont-replace
Ez ordeztu formatua dagoeneko existitu existitzen bada

calibredb remove_format [options] id fmt



Remove the format fmt from the logical book identified by id. You can get id by using the search command. fmt should be a file extension like LRF or TXT or EPUB. If the logical book does not have fmt available, do nothing.

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

calibredb show_metadata [options] id



Show the metadata stored in the calibre database for the book identified by id. id is an id number from the search command.

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

--as-opf
Inprima itzazu metadatuak OPF formatuarekin (XML)

calibredb set_metadata [options] id [/path/to/metadata.opf]



Set the metadata stored in the calibre database for the book identified by id from the OPF file metadata.opf. id is an id number from the search command. You can get a quick feel for the OPF format by using the --as-opf switch to the show_metadata command. You can also set the metadata of individual fields with the --field option. If you use the --field option, there is no need to specify an OPF file.

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

--field, -f
Ezarri beharreko eremua. Formatua honako hau da: eremuaren_izena:balioa, adibidez: --field etiketak:etiketa1,etiketa2. --list-fields erabili eremu izen guztien zerrenda lortzeko. Eremu bat baino gehiago ezartzeko aukera hau behin baino gehiagotan zehaztu. Oharra: hizkuntzak erabiltzeko ISO639 arauan zehazten diren hizkuntza-kodeak erabili beharko dituzu (adibidez, 'eu' euskararako, 'es' gaztelerarako, 'en' ingeleserako...). For identifiers, the syntax is --field identifiers:isbn:XXXX,doi:YYYYY. For boolean (yes/no) fields use true and false or yes and no.

--list-fields, -l
--field aukerarekin batera erabil daitezkeen metadatuen eremuen izenen zerrenda

calibredb export [options] ids



Export the books specified by ids (a comma separated list) to the filesystem. The export operation saves all formats of the book, its cover and metadata (in an opf file). You can get id numbers from the search command.

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

--all
Esportatu data-baseko liburu guztiak, ID zerrendari ez ikusiarena eginez.

--dont-asciiize
Normalean, fitxategi izenetan, calibrek ingelesez erabiltzen ez diren karaktere guztiak ingelesezko haien ordainetara bihurtuko ditu. KONTUZ: aukera hau erabiltzen ez baduzu, agian akatsak izango dituzu gordetzerakoan. Akatsak izateko aukera gordetzen ari zaren fitxategi-sistemak zelan jasaten duen unicode araberakoa izango da. Aldaketa hau zehaztuz jokabide hau bertan behera geratuko da.

--dont-save-cover
Normally, calibre will save the cover in a separate file along with the actual e-book files. Aldaketa hau zehaztuz jokabide hau bertan behera geratuko da.

--dont-update-metadata
Normalean, calibrek metadatuak eguneratuko ditu gordetako fitxategietan, calibreren liburutegian dauden edukiei esker. Eguneratze honek diskoan gordetze prozesua moteltzen du. Aldaketa hau zehaztuz jokabide hau bertan behera geratuko da.

--dont-write-opf
Normalean, calibrek metadatuak bereiziriko OPF fitxategi batean idatziko ditu, oraingo liburu elektronikoen fitxategiekin batera. Aldaketa hau zehaztuz jokabide hau bertan behera geratuko da.

--formats
Liburu bakoitzaren komen bidez bereizitako formatuen zerrenda gordetzeko. Lehenetsita: eskuragarri dauden formatu guztiak gordeko dira.

--progress
Report progress

--replace-whitespace
Ordeztu espazio zuriak azpiko marrekin.

--single-dir
Esportatu liburu guztiak direktorio sinple batera

--template
Gordetako fitxategien izena eta direktorioaren egitura kontrolatzeko erabiltzen den txantiloia. Lehenetsita: "{author_sort}/{title}/{title} - {authors}". Honekin, liburuak egileen araberako azpi-direktorioan antolatuko dira izenburua eta egilea dituzten fitxategi-izenekin. Eskuragarri dauden kontrolak: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}

--timefmt
Datak erakusteko formatua. %Y - urtea, %b - hilabetea, %m - hilabeteko eguna, %d - eguna. Lehenetsita: %b, %Y

--to-dir
Esportatu liburua zehaztutako direktoriora. Lehenetsita hauxe: .

--to-lowercase
Bihurtu bideak minuskuletara, letra xeheetara.

calibredb catalog /path/to/destination.(csv|epub|mobi|xml...) [options]



Export a catalog in format specified by path/to/destination extension. Options control how entries are displayed in the generated catalog output. Note that different catalog formats support different sets of options.

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

--ids, -i
Komen bidez bereiziriko IDen datu base zerrenda katalogatzeko. Adierazten bada, --search hori baztertu egingo da. Lehenetsita: dena

--search, -s
Bilaketa galderaren arabera iragazten ditu emaitzak. Bilaketa galderaren formatua hautatzeko, mesedez, ikus bilaketari buruzko dokumentazioa Erabiltzailearen eskuliburuan. Lehenetsita: irazkirik ez

--verbose, -v
Erakutsi output informazioa, irteera informazioa, ondo zehaztuta. Akatsgabetzeko erabilgarria

--catalog-title
Title of generated catalog used as title in metadata. Default: 'My Books' Applies to: AZW3, EPUB, MOBI output formats

--cross-reference-authors
Create cross-references in Authors section for books with multiple authors. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--debug-pipeline
Save the output from different stages of the conversion pipeline to the specified directory. Useful if you are unsure at which stage of the conversion process a bug is occurring. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--exclude-genre
Regex describing tags to exclude as genres. Default: '[.+]|^+$' excludes bracketed tags, e.g. '[Project Gutenberg]', and '+', the default tag for read books. Applies to: AZW3, EPUB, MOBI output formats

--exclusion-rules
Specifies the rules used to exclude books from the generated catalog. The model for an exclusion rule is either ('<rule name>','Tags','<comma-separated list of tags>') or ('<rule name>','<custom column>','<pattern>'). For example: (('Archived books','#status','Archived'),) will exclude a book with a value of 'Archived' in the custom column 'status'. When multiple rules are defined, all rules will be applied. Default: "(('Catalogs','Tags','Catalog'),)" Applies to: AZW3, EPUB, MOBI output formats

--generate-authors
Include 'Authors' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-descriptions
Include 'Descriptions' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-genres
Include 'Genres' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-recently-added
Include 'Recently Added' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-series
Include 'Series' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-titles
Include 'Titles' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--genre-source-field
Source field for 'Genres' section. Default: 'Etiketak' Applies to: AZW3, EPUB, MOBI output formats

--header-note-source-field
Custom field containing note text to insert in Description header. Default: '' Applies to: AZW3, EPUB, MOBI output formats

--merge-comments-rule
#<custom field>:[before|after]:[True|False] specifying: <custom field> Custom field containing notes to merge with Comments [before|after] Placement of notes with respect to Comments [True|False] - A horizontal rule is inserted between notes and Comments Default: '::' Applies to: AZW3, EPUB, MOBI output formats

--output-profile
Specifies the output profile. In some cases, an output profile is required to optimize the catalog for the device. For example, 'kindle' or 'kindle_dx' creates a structured Table of Contents with Sections and Articles. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--prefix-rules
Specifies the rules used to include prefixes indicating read books, wishlist items and other user-specified prefixes. The model for a prefix rule is ('<rule name>','<source field>','<pattern>','<prefix>'). When multiple rules are defined, the first matching rule will be used. Default: "(('Read books','tags','+',''),('Wishlist item','tags','Wishlist','×'))" Applies to: AZW3, EPUB, MOBI output formats

--preset
Use a named preset created with the GUI catalog builder. A preset specifies all settings for building a catalog. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--thumb-width
Size hint (in inches) for book covers in catalog. Range: 1.0 - 2.0 Default: '1.0' Applies to: AZW3, EPUB, MOBI output formats

--use-existing-cover
Replace existing cover when generating the catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

calibredb saved_searches [options] (list|add|remove)



Manage the saved searches stored in this database. If you try to add a query with a name that already exists, it will be replaced.

Syntax for adding:

calibredb saved_searches add search_name search_expression

Syntax for removing:

calibredb saved_searches remove search_name

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

calibredb add_custom_column [aukerak] etiketa izena data-mota



Sortu pertsonalizaturiko zutabe bat. "Etiketa" zutabearen goitizena da. Ez luke espaziorik edo bi puntuko ikurrik eduki behar. "Izena" zutabearen goitizena da. datu-mota hauetako bat da: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

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

--display
Zutabe honetako datuen interpretazioa pertsonalizatzeko aukerak azaltzen dituen hiztegia. JSON kate bat da. Zerrenda motako zutabeentzat --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]} erabili. 'Display' aldagaian hainbat aukera joan daitezke. Zutabe motaren araberako aukerak hauek dira: composite: composite_template, composite_sort, make_category,contains_html, use_decorations datetime: date_format enumeration: enum_values, enum_colors, use_decorations int, float: number_format text: is_names, use_decorations Konbinazio jatorrak lortzeko aukerarik hoberena, zutabe pertsonalizatua Erabiltzailearen Interfaze Grafikoa (GUI) erabiliz sortzea eta ostean liburuen OPF babeskopia begiratzea (zutabea gehitu eta gero OPF fitxategi berria sortu dela ziurtatu lehenago). Bertan agertuko zaizu zutabe berriaren 'display'erako erabili beharreko JSONa.

--is-multiple
Zutabe honek datu itxurako etiketak gordetzen ditu (adibidez koma anitzekin bereiziriko balioak). Aplikatuko da datu-tipoa testua baldin bada, besterik ez.

calibredb custom_columns [options]



List available custom columns. Shows column labels and ids.

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

--details, -d
Erakutsi zehaztasunak zutabe bakoitzean.

calibredb remove_custom_column [options] label



Remove the custom column identified by label. You can see available columns with the custom_columns command.

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

--force, -f
Ez eskatu baieztapenik

calibredb set_custom [options] column id value



Set the value of a custom column for the book identified by id. You can get a list of ids using the search command. You can get a list of custom column names using the custom_columns command.

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

--append, -a
Zutabeak balio anitz gordetzen baditu, erantsi zehaztutako balioak lehenagotik zeuden balioetara, ordeztu beharrean.

calibredb restore_database [options]



Berrezarri datu base hau OPF fitxategietan gordetako metadatuetatik calibre liburutegian dagoen direktorio bakoitzetik abiatuz. Erabilgarria zure metadata.db fitxategia hondatu bada.

KONTUZ: Agindu honek zure datu basea goitik behera berreraikiko du. Galduko dituzu gordetako guztiak: bilaketak, erabiltzaile kategoriak, konexio-taulak, liburu bihurketak ezarpenak eta errezetak. 'Berrezarri metadatuak' aginduak izango duen zehaztasuna OPF fitxategietan (OPEN Process Framework) topatzen denaren menpe geratuko da.

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

--really-do-it, -r
Berreskuratzea egin, bai. Agindua ez da martxan hasiko aukera hau zehaztu arte.

calibredb aztertu_liburutegia [options]



Egin itzazu liburutegia osatzen duen fitxategi sisteman azterketa eta egiaztapen batzuk . Txostenak hauek dira: invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, failed_folders

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

--csv, -c
Helburua CSV (Comma Separated Values) horretan

--ignore_extensions, -e
Komaz bereizitako luzapenen zerrenda kasurik ez egiteko. Lehenetsita: dena

--ignore_names, -n
Komaz bereizitako izenen zerrenda kasurik ez egiteko. Lehenetsita: dena

--report, -r
Txostenak komaz bereizitako zerrenda. Lehenetsita: dena

calibredb list_categories [options]



Txostena sortzen du kategorien informazioaren gainean datu basean. Hori informazio hori etiketen erakusleihoan erakusten denaren baliokidea da.

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

--categories, -r
Comma-separated list of category lookup names. Default: all

--csv, -c
Helburua CSV (Comma Separated Values) horretan

--dialect
The type of CSV file to produce. Choices: excel, excel-tab

--item_count, -i
Erakutsi bakarrik zenbat gai dagoen kategoria bakoitzeko eta ez zenbat aldiz zenbatu den gai bakoitzeko kategoria bakoitzean

--width, -w
Lerro sinple baten zabalera maximoa. Lehenetsitako balioa: pantailaren tamaina detektatzea.

calibredb backup_metadata [options]



Datu-basean gordeta dauden metadatuen babeskopia egin liburu bakoitzeko direktorioetan gordeko diren OPF fitxategietan. Orokorrean, babeskopia hauek automatikoki egiten dira, baina komando hau erabili dezakezu OPF fitxategiak berriro sortu daitezen behartzeko. '--all' aukera erabili horretarako.

Kontuan izan normalean ez dela zertan egin behar hau, metadatuak aldatzen diren bakoitzeko OPF fitxategien babeskopia egiten baita automatikoki.

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

--all
Normalean, komando honek OPF fitxategi zaharkituak duten liburuetan baino ez du eraginik. Aukera honekin liburu guztietan eragitea ahalbidetzen duzu.

calibredb clone path/to/new/library



Uneko liburutegia klonatu. Honekin, erabiltzen zauden liburutegiaren zutabe pertsonalizatuak, liburutegi birtualak eta beste ezarpenak berdin-berdin dituen liburutegi berri, hutsa sortuko duzu.

Kontuan izan liburutegi klonatu honek ez duela libururik izango. Liburuak ere badituen kopia oso bat baldin bada sortu nahi duzuna, nahikoa duzu ordenagailuko sistema eragileko lanabesak erabiltzea liburutegiaren karpetan kopia bat egiteko.

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

calibredb embed_metadata [options] book_id



Update the metadata in the actual book files stored in the calibre library from the metadata in the calibre database. Normally, metadata is updated only when exporting files from calibre, this command is useful if you want the files to be updated in place. Note that different file formats support different amounts of metadata. You can use the special value 'all' for book_id to update metadata in all books. You can also specify many book ids separated by spaces and id ranges separated by hyphens. For example: calibredb embed_metadata 1 2 10-15 23

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

--only-formats, -f
Only update metadata in files of the specified format. Specify it multiple times for multiple formats. By default, all formats are updated.

calibredb search [options] search expression



Search the library for the specified search term, returning a comma separated list of book ids matching the search expression. The output format is useful to feed into other commands that accept a list of ids as input.

The search expression can be anything from calibre's powerful search query language, for example: author:asimov title:robot

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

--limit, -l
The maximum number of results to return. Default is all results.

Kovid Goyal

Kovid Goyal
urria 08, 2019 4.1.0