table of contents
- NAME
- ALGEMENE OPTIES
- LIST
- ADD
- REMOVE
- ADD_FORMAT
- REMOVE_FORMAT
- SHOW_METADATA
- SET_METADATA
- EXPORT
- CATALOG
- SAVED_SEARCHES
- ADD_CUSTOM_COLUMN
- CUSTOM_COLUMNS
- REMOVE_CUSTOM_COLUMN
- SET_CUSTOM
- RESTORE_DATABASE
- CHECK_LIBRARY
- LIST_CATEGORIES
- BACKUP_METADATA
- CLONE
- EMBED_METADATA
- SEARCH
- FTS_INDEX
- FTS_SEARCH
- NOTES
- ITEMS
- VIRTUAL_LIBRARIES
- ANNOTATIONS
- TRASH
- DATA_FILES
- Author
- Copyright
- trixie 8.5.0+ds-1+deb13u3
- trixie-backports 8.16.2+ds+~0.10.5-3~bpo13+1
- testing 9.18.0+ds+~1.1.2-1
- unstable 9.18.0+ds+~1.1.2-1
- العربية
- български
- català (ca)
- čeština
- dansk
- Deutsch
- Ελληνικά
- English
- español
- eesti
- euskara
- فارسی
- suomi
- français
- galego
- עברית
- hrvatski
- magyar
- íslenska
- italiano
- 日本語
- ಕನ್ನಡ
- 한국어
- lietuvių
- latviešu
- मराठी
- Melayu
- norsk bokmål
- Nederlands
- polski
- português (pt)
- português (pt-BR)
- română
- русский
- slovenčina
- slovenščina
- српски
- srpskohrvatski
- svenska
- Türkçe
- українська
- Tiếng Việt
- 中文 (zh-CN)
- 繁體中文 (zh-HK)
- 繁體中文 (zh-TW)
| CALIBREDB(1) | calibre | CALIBREDB(1) |
NAME¶
calibredb - calibredb
%prof commando [opties] [parameters]
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. Be careful though, because some browsers, primarily Firefox, allow arbitrary websites to also access local servers. If you use Firefox, it is better to setup username and password, as described below. Local Network Access restriction has still not been implemented as of Firefox v149.
- 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.
- ALGEMENE OPTIES
- list
- add
- •
- TOEVOEGEN VANUIT MAPPEN
- remove
- add_format
- remove_format
- show_metadata
- set_metadata
- export
- catalog
- •
- EPUB OPTIES
- saved_searches
- add_custom_column
- custom_columns
- remove_custom_column
- set_custom
- restore_database
- check_library
- list_categories
- backup_metadata
- clone
- embed_metadata
- search
- fts_index
- fts_search
- notes
- items
- virtual_libraries
- annotations
- trash
- data_files
ALGEMENE OPTIES¶
- --help, -h
- toon dit helpbericht en stop
- --library-path, --with-library
- Pad naar de Calibre-bibliotheek. Standaard wordt het pad gebruikt dat is opgeslagen in de instellingen. U kunt ook verbinding maken met een Calibre Content Server om acties uit te voeren op externe bibliotheken. Gebruik hiervoor een URL in de vorm: <http://hostname:port/#library_id> bijvoorbeeld <http://localhost:8080/#mylibrary>. library_id is de bibliotheek-id van de bibliotheek waarmee u verbinding wilt maken op de Content Server. U kunt de speciale library_id-waarde - gebruiken om een lijst met bibliotheek-id's te krijgen die beschikbaar zijn op de server. Zie <https://manual.calibre-ebook.com/nl/generated/nl/calibredb.html> voor meer informatie over het instellen van toegang via een inhoudsserver.
- --password
- Wachtwoord om te verbinden met een calibre Content server. Gebruik speciale waarde: <stdin> om het wachtwoord van de standaardinvoer te lezen. Om het wachtwoord van een bestand te lezen, gebruik: <f:/path/to/file> (d.w.z. <f: gevolgd door volledig pad naar bestand en een trailing>). De punthaken in het bovenstaande zijn vereist, onthoud om ze te escapen of gebruik aanhalingstekens voor uw shell.
- --timeout
- De time-out, in seconden, bij verbinden met een calibre bibliotheek over het netwerk. De standaard is twee minuten.
- --username
- Gebruikersnaam voor verbinden met een calibre Content server
- --version
- toon programmaversie en stop
LIST¶
calibredb list [opties]
Toon de beschikbare boeken in de calibre-database.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --ascending
- Sorteer resultaten in oplopende volgorde
- --fields, -f
- Velden te tonen bij het maken van boekenlijsten in de database. Moet een lijst met komma-gescheiden waarden zijn. Beschikbare velden: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Standaard: title,authors. Het speciale veld "alle" kan dienen om alle velden te selecteren. Naast de ingebouwde velden boven zijn ook aangepaste velden beschikbaar als *field_name, bijvoorbeeld, voor een aangepast veld #rating, gebruik de naam: *rating
- --for-machine
- Genereer uitvoer in JSON-formaat, dit is veel beter voor machine verificatie. Zorgt ervoor dat de lengte van lijnen en de afscheidings opties genegeerd zullen worden.
- --limit
- Het maximum aantal resultaten om weer te geven. Standaard: allen
- --line-width, -w
- De maximale breedte van een enkele regel in de uitvoer. Standaard is dit hetzelfde als de schermgrootte.
- --prefix
- De prefix voor mappaden. Standaard is het absolute pad naar de bibliotheekmap.
- --search, -s
- Filter de resultaten op de zoekoperatie. Voor het indeling van de zoekopdracht kunt u de zoek-gerelateerde documentatie in de gebruikershandleiding raadplegen. Standaard word er niet gefilterd.
- --separator
- De string gebruikt om velden van elkaar te scheiden. Standaard is dit een spatie.
- --sort-by
- Het veld waarop de resultaten moeten worden gesorteerd. U kunt meerdere velden opgeven door ze met komma's te scheiden. Beschikbare velden: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Standaard: id. Naast de bovenstaande ingebouwde velden zijn er ook aangepaste velden beschikbaar als *veldnaam. Gebruik bijvoorbeeld voor een aangepast veld #rating de naam: *rating
- --template
- De sjabloon die moet worden uitgevoerd als "template" in de veldenlijst staat. Houd er rekening mee dat sjablonen worden genegeerd tijdens het verbinden met een Calibre-server. Standaard: Geen
- --template_file, -t
- Pad naar een bestand met het sjabloon dat moet worden uitgevoerd als "template" in de veld-lijst staat. Standaard: Geen
- --template_heading
- Kop voor de sjabloonkolom. Standaard: stan%daard. Deze optie wordt genegeerd als de optie --for-machine is ingesteld
ADD¶
calibredb toevoegen [opties] bestand1 bestand2 bestand3 ...
Voeg de gespecificeerde bestanden als boeken toe aan de database. U kan ook mappen specificeren, kijk bij map gerelateerde opties beneden.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- Stel de auteur in voor toegevoegde boek(en)
- --automerge, -m
- Als boeken met vergelijkbare titels en auteurs worden gevonden, voegt u de binnenkomende formaten (bestanden) automatisch samen met bestaande boekrecords. De waarde "negeren" betekent dat dubbele formaten worden verwijderd. De waarde "overschrijven" betekent dat dubbele formaten in de bibliotheek worden overschreven door de nieuw toegevoegde bestanden. De waarde "new_record" betekent dat dubbele formaten in een nieuw boekrecord worden geplaatst.
- --cover, -c
- Pad naar de omslag voor het toegevoegde boek
- --duplicates, -d
- Voeg boeken toe aan de database, zelfs als ze al bestaan. Er wordt vergeleken op basis van boektitels en auteurs. Merk op dat de optie --automerge voorrang heeft.
- --empty, -e
- Voeg een leeg boek toe (een boek dat van geen enkel formaat gebruikt maakt)
- --identifier, -I
- Stel de identificatren voor dit boek in, bijvoorbeeld: -I asin:XXX -I isbn:YYY
- --isbn, -i
- Stel het ISBN-nummer in voor toegevoegde boek(en)
- --languages, -l
- Een door komma's gescheiden lijst van talen (het beste is om ISO639 taal codes te gebruiken, alhoewel sommige taal-namen ook herkend worden)
- --series, -s
- Stel de series in van toegevoegde boek(en)
- --series-index, -S
- Stel het nummer in de serie in voor toegevoegde boek(en)
- Stel labels in voor toegevoegde boek(en)
- --title, -t
- Stel de titel in voor toegevoegde boek(en)
TOEVOEGEN VANUIT MAPPEN¶
Opties voor beheer van boeken toevoegen vanuit mappen. Standaard enkel bestanden met extensies van gekende e-boek-bestandtypes.
- --add
- Een bestandsnaam (glob) patroon, bestanden die overeenkomen met dit patroon zullen worden toegevoegd bij het scannen van mappen voor bestanden, zelfs als ze geen bekend e-boek-bestandstype hebben. Kan meerdere keren worden opgegeven voor meerdere patronen.
- --ignore
- Een bestandsnaam (glob) patroon, bestanden die overeenkomen met dit patroon, worden genegeerd bij het scannen van mappen. Kan meerdere keren worden opgegeven voor meerdere patronen. Bijvoorbeeld: *.pdf zal alle pdf-bestanden negeren
- --one-book-per-directory, -1
- Neem aan dat elke map een enkel logisch boek heeft and dat alle bestanden erin verschillende e-boek formaten zijn van dat boek
- --recurse, -r
- Verwerk mappen recursief
REMOVE¶
calibredb verwijder ID's
Verwijder de boek indentificatoren van de database. ID's is een komma-gescheiden lijst van ID nummers (u kan ID nummers verkrijgen door het zoek commando te gebruiken). Bijvoorbeeld: 23,34,57-85 (bij opgave van een serie, wordt het laatste nummer niet opgenomen).
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --permanent
- Do not use the trash bin
ADD_FORMAT¶
calibredb add_format [opties] id ebook_file
Voeg het e-boek in ebook_file toe aan de beschikbare formaten voor het logische boek geïdentificeerd door id. U kunt id krijgen door de zoekopdracht te gebruiken. Als het formaat al bestaat, wordt het vervangen, tenzij de optie Niet vervangen is opgegeven.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --as-extra-data-file
- Voeg het bestand toe als een extra gegevensbestand aan het boek, niet als e-boekindeling
- --dont-replace
- Vervang het formaat niet als het al bestaat
REMOVE_FORMAT¶
calibredb remove_format [opties] id fmt
Verwijder het formaat fmt van het logische boek geïdentificeerd door id. U kunt het id met het zoek-commando vinden. fmt is een bestandsextensie zoals LRF, TXT of EPUB. Als het logische boek niet in dit formaat bestaat zal er niets gebeuren.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
SHOW_METADATA¶
calibredb show_metadata [opties] id
Toon de metagegevens die in de calibre database zijn opgeslagen voor het boek dat bij id hoort. id is een id nummer verkregen met het zoek-commando.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --as-opf
- Metagegevens in OPF-formaat (XML) afdrukken
SET_METADATA¶
calibredb set_metadata [options] book_id [/path/to/metagegevens.opf]
Stel de metagegevens in die zijn opgeslagen in de Calibre-database voor het boek geïdentificeerd door book_id uit het OPF-bestand metagegevens.opf. book_id is een boek-id-nummer van de zoekopdracht. U kunt snel een idee krijgen van het OPF-formaat door de --as-opf schakelt over naar de opdracht show_metadata. U kunt ook de metagegevens van individuele velden met de optie --field. Als u de optie --field gebruikt, is er het is niet nodig om een OPF-bestand op te geven.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --field, -f
- Het veld om te zetten. Formaat is veld_naam:waarde, bijvoorbeeld: --field labels:label1,label2. Gebruik --list-fields om een lijst van alle veld namen te krijgen. U kunt deze optie meermalen gebruiken om meerdere velden te zetten. Opgelet: Voor talen moet u de ISO639 taal codes gebruiken (b.v. en voor Engels, fr voor Frans enzovoort). Voor identificatoren, de syntaxis is --field identifiers:isbn:XXXX,doi:YYYYY. Voor booleaans (ja/nee) velden gebruik waar en niet waar of ja en nee.
- --list-fields, -l
- Toon de metagegevens veldnamen die kunnen worden gebruikt met de --field optie
EXPORT¶
calibredb export [opties] ids
Exporteer de boeken die zijn opgegeven door ids (een door komma's gescheiden lijst) naar het bestandssysteem. De exportbewerking slaat alle formaten van het boek, de omslag en metagegevens op (in een OPF-bestand). Alle extra gegevensbestanden die aan het boek zijn geassocieerd, worden ook opgeslagen. U kunt id-nummers ophalen via de zoekopdracht.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --all
- Exporteer alle boeken in de database, negeer de lijst met id's.
- --dont-asciiize
- Laat calibre alle niet-Latijnse karakters converteren naar Latijnse voor de bestandsnamen. Nuttig bij opslaan naar een verouderd bestandssysteem zonder volledige ondersteuning voor Unicode bestandsnamen. Als u dit opgeeft zal het gedrag uitgeschakeld worden.
- --dont-save-cover
- Normaal slaat calibre de omslag op in een apart bestand samen met de overige boekbestanden van het bijbehorende boek. Als u dit opgeeft zal het gedrag uitgeschakeld worden.
- --dont-save-extra-files
- Alle gegevensbestanden die bij het boek horen opslaan bij het opslaan van het boek Als u dit opgeeft zal het gedrag uitgeschakeld worden.
- --dont-update-metadata
- Normaal zal calibre de metagegevens in opgeslagen bestanden bijwerken met informatie in de calibre bibliotheek. Maakt opslaan op schijf langzamer. Als u dit opgeeft zal het gedrag uitgeschakeld worden.
- --dont-write-opf
- Normaal gesproken, zal calibre de metagegevens in een apart OPF-bestand opslaan, samen met de daadwerkelijke e-boek-bestanden. Als u dit opgeeft zal het gedrag uitgeschakeld worden.
- --formats
- Kommagescheiden lijst van opslagformaten voor elk boek. Standaard worden alle formaten bewaard.
- --progress
- Rapporteer voortgang
- --replace-whitespace
- Vervang witruimte door lage streepjes (_).
- --single-dir
- Exporteer alle boeken naar één enkele map
- --template
- De sjabloon waarmee de bestandsnaam en mapstructuur van de opgeslagen bestanden wordt gecontroleerd. Standaard is dit "{author_sort}/{title}/{title} - {authors}’" dat boeken per auteur in een submap plaatst met bestandsnamen met de naam van de auteur en de titel. Beschikbare opties zijn: {author_sort, authors, id, isbn, languages, last_modified, pages, pubdate, publisher, rating, series, series_index, tags, timestamp, title}
- --timefmt
- Het formaat om gegevens weer te geven. %d - dag, %b - maand, %m - maandnummer, %Y - jaar. Standaard is: %b, %Y
- --to-dir
- Exporteer boeken naar de gespecificeerde map. Standaard is .
- --to-lowercase
- Paden naar kleine letters omzetten.
CATALOG¶
calibredb catalog /path/to/destination.(csv|epub|mobi|xml...) [options]
Exporteer een catalogus in een formaat gespecificeerd door pad / naar / bestemmingsextensie. Opties bepalen hoe vermeldingen worden weergegeven in de gegenereerde catalogusuitvoer. Merk op dat verschillende catalogusformaten verschillende sets opties ondersteunen. Naar bekijk de verschillende opties, specificeer de naam van het outputbestand en dan de --help optie.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --ids, -i
- Kommagescheiden lijst met database-ID's om te catalogiseren. Indien gebruikt, zal --search genegeerd worden. Standaard: all
- --search, -s
- Filter de resultaten met de zoekopdracht. Voor het formaat van de zoekopdracht, zie de zoekfunctionaliteit in de gebruikershandleiding. Standaard: geen filter
- --verbose, -v
- Laat gedetailleerde uitvoerinformatie zien. Nuttig bij het opsporen van problemen
EPUB OPTIES¶
- --catalog-title
- Titel van gegenereerde catalogus gebruikt als titel in metagegevens. Standaard: 'My Books' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --cross-reference-authors
- Creëert kruis-referenties in Auteursonderdeel voor boeken met meerdere auteurs. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --debug-pipeline
- Sla de uitvoer van verschillende stadia in de omzettingspijplijn op in de gespecificeerde map. Nuttig wanneer u onzeker bent in welk stadium van het omzettingsproces een fout optreedt. Standaard: 'None' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --exclude-genre
- Regex die beschrijft welke labels uit te sluiten als genre's. Standaard: '[.+]|^+$' sluit labels in haken uit, b.v. '[Project Gutenberg]', en '+', de standaard voor gelezen boeken. Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --exclusion-rules
- Specificeert de regels gebruikt om boeken uit te sluiten van de aangemaakt catalogus. Het model voor een uitsluitregel is ofwel ('<rule name>','Tags','<comma-separated list of tags>') of ('<rule name>','<custom column>','<pattern>'). Bijvoorbeeld: (('Gearchiveerde boeken','#status','Gearchiveerd'),) zal een boek uitsluiten met de waarde 'Gearchiveerd' in de aangepaste kolom 'status'. Wanneer meerder kolommen zijn gedefinieerd, worden alle regels toegepast. Standaard: "(('Catalogs','Tags','Catalog'),)" Geldt voor AZW3, EPUB, MOBI uitvoerformaten
- --generate-authors
- Voeg 'Auteurs' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --generate-descriptions
- Voeg 'Beschrijvingen' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --generate-genres
- Voeg 'Genres' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --generate-recently-added
- Voeg 'Onlangs toegevoegd' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --generate-series
- Voeg 'Series' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --generate-titles
- Voeg 'Titels' onderdeel toe aan catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --genre-source-field
- Bronveld voor Genres onderdeel. Standaard: 'Labels' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --header-note-source-field
- Aangepast veld met in de Beschrijving koptekst in te voegen notitie tekst. Standaard: '' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
- --merge-comments-rule
- #<custom field>:[voor|na]:[Waar|Onwaar] specificerend: <custom field> Aangepast veld met nota's samen te voegen met commentaar [voor|na] Plaatsing van nota's ten opzichte van commentaar [Waar|Onwaar] - Een horizontale regel wordt ingevoegd tussen nota's en commentaar Standaard: '::' Geldt voor: AZW3, EPUB, MOBI outvoerformaten
- --output-profile
- Specificeert het uitvoerprofiel. In sommige gevallen is een uitvoerprofiel vereist om de catalogus te optimaliseren voor het toestel. Bijvoorbeeld 'kindle' of 'kindle_dx' creëert een gestructureerde Inhoudsopgave met Onderdelen en Artikelen Standaard: 'None' Geldt voor AZW3, EPUB, MOBI uitvoerformaten
- --prefix-rules
- Specificeert de regels gebruikt voor het insluiten van voorvoegsels die gelezen boeken aanduiden, wenslijst items en andere gebruiker gespecificeerde voorvoegsels. Het model voor een voorvoegsel regel is ('<rule name>','<source field>','<pattern>','<prefix>'). Wanneer meerdere regels gedefinieerd zijn, wordt de eerste regel gebruikt. Standaard: "(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))" Geldt voor AZW3, EPUB, MOBI uitvoerformaten
- --preset
- Gebruik een benoemde voorinstelling gemaakt met de GUI catalogus bouwer. Een voorinstelling specificeert alle instellingen om een catalogus te maken. Standaard: 'None' Van toepassing op AZW3, EPUB, MOBI uitvoerformaten
- --thumb-width
- Formaattip (in inches) voor boekomslagen in catalogus. Bereik: 1.0 - 2.0 Standaard: '1.0' Van toepassing op: AZW3-, EPUB-, MOBI-uitvoerformaten
- --use-existing-cover
- Vervang bestaande omslag bij genereren van de catalogus. Standaard: 'False' Van toepassing op: AZW3, EPUB, MOBI uitvoerformaten
SAVED_SEARCHES¶
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 listing, the default action:
calibredb saved_searches list
Syntax for adding:
calibredb saved_searches add search_name search_expression
Syntax for removing:
calibredb saved_searches remove search_name
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
ADD_CUSTOM_COLUMN¶
calibredb add_custom_column [opties] label naam gegevenstype
- Creëer een zelf gedefinieerde kolom. label is de machine vriendelijke naam van de kolom. Dit label
- mag geen spaties of dubbele punten bevatten, naam is de mens vriendelijke naam van de kolom.
gegevenstype is één van: bool, comments, composite, datetime, enumeration, float, int, rating, series, text
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --display
- Een woordenboek van opties voor het aanpassen van hoe de gegevens in deze kolom worden geïnterpreteerd. Dit is een JSON string. Voor kolommen met opsommingen gebruik --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" Er bestaan vele opties voor de weergave variabele. De opties per kolomtype zijn: samenstelling: composite_template, composite_sort, make_category,contains_html, use_decorations datum/tijd: date_format opsomming: enum_values, enum_colors, use_decorations int, float: number_format tekst: is_names, use_decorations De beste manier om geldige combinaties te vinden is door het maken van een aangepaste kolom van het juiste type in de GUI en daarna in de back-up OPF zoeken naar een boek (verzeker u ervan dat er een nieuw OPF is aangemaakt nadat de kolom is toegevoegd). U zult de JSON zien voor de "weergave" van de nieuwe kolom in de OPF.
- --is-multiple
- Deze kolom slaat label like data op (i.e. waarden gescheiden door komma's). Enkel van toepassing als data tekst is.
CUSTOM_COLUMNS¶
calibredb custom_columns [options]
Lijst van beschikbare aangepaste kolommen. Geeft kolommen en ID's weer.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --details, -d
- Toon details voor iedere kolom.
REMOVE_CUSTOM_COLUMN¶
calibredb remove_custom_column [options] label
Verwijder de door het label geïdentificeerde aangepaste kolom. U kan de beschikbare kolommen bekijken door het custom_columns commando te gebruiken.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --force, -f
- Niet om bevestiging vragen
SET_CUSTOM¶
calibredb set_custom [options] column id value
Stel de waarde van de aangepaste kolom in voor het boek, die geïdentificeerd is op ID. U kunt een lijst van ids krijgen met behulp van het zoek commando. U kunt een lijst met aangepaste kolomnamen krijgen met behulp van het custom_columns commando.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --append, -a
- Als de kolom meerde waardes bevat, voeg dan de opgegeven waarden aan de bestaande toe, in plaats van ze te vervangen.
RESTORE_DATABASE¶
calibredb restore_database [options]
Restore this database from the metadata stored in OPF files in each folder of the calibre library. This is useful if your metadata.db file has been corrupted.
WARNING: This command completely regenerates your database. You will lose all saved searches, user categories, plugboards, stored per-book conversion settings, and custom recipes. Restored metadata will only be as accurate as what is found in the OPF files.
The exit status is 0 if the restore succeeded, 1 if it failed completely and 2 if the database was restored but some books or other data could not be.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --really-do-it, -r
- Het herstel echt uitvoeren. Het commando zal niet uitgevoerd worden tenzij deze optie ingesteld is.
CHECK_LIBRARY¶
calibredb check_library [opties]
Voer controles uit op het bestandssysteem van de bibliotheek. Rapporten zijn invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, malformed_formats, malformed_paths, failed_folders
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --csv, -c
- Uitvoer naar CSV
- --ignore_extensions, -e
- Kommagescheiden lijst van te negeren extensies. Standaard: all
- --ignore_names, -n
- Kommagescheiden lijst van te negeren namen. Standaard: all
- --report, -r
- Kommagescheiden lijst van rapporten. Standaard: all
- --vacuum-fts-db
- Leeg de volledige tekstzoek database. Dit kan erg traag en geheugenintensief zijn, afhankelijk van de grootte van de database.
LIST_CATEGORIES¶
calibredb list_categories [opties]
Maak een rapport van de categorie-informatie in de database. De informatie is het equivalent van wat wordt weergegeven in de Labelbrowser.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --categories, -r
- Kommagescheiden lijst van categorie-opzoeknamen. Standaard: alle
- --csv, -c
- Uitvoer naar CSV
- --dialect
- Het type CSV bestand te maken. Keuzes excel, excel-tab, unix
- --item_count, -i
- Toon alleen het aantal items in een categorie in plaats van de aantallen per item in de categorie
- --width, -w
- De maximale breedte van een enkele regel in de uitvoer. Standaard is dit hetzelfde als de schermgrootte.
BACKUP_METADATA¶
calibredb backup_metadata [opties]
- Maak een back-up van de metagegevens uit de database in individuele OPF bestanden
- in elke boek map. Dit gebeurt normaal automatisch maar u kan dit commando
uitvoeren om een vernieuwing van de OPF af te dwingen met de --all optie.
NB: Dit is normaal niet nodig omdat er van de OPF-bestanden automatisch een back-up wordt gemaakt elke keer metagegevens is veranderd.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --all
- Normaal werkt dit commando enkel op boeken met verouderde OPF-bestanden. Deze optie zorgt dat het op alle boeken werkt.
CLONE¶
calibredb kloon pad/naar/nieuw/bibliotheek
Maak een kloon van de huidige bibliotheek. Hierdoor wordt een nieuwe, lege bibliotheek gemaakt met dezelfde aangepaste kolommen, Virtuele bibliotheken en andere instellingen als de huidige bibliotheek.
De gekloonde bibliotheek bevat geen boeken. Als u een volledig duplicaat wilt maken, inclusief alle boeken, gebruik dan gewoon uw bestandssysteemtools om de bibliotheekmap te kopiëren.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
EMBED_METADATA¶
calibredb ingevoegde_metadata [opties] boek_id
Update de metagegevens in het eigenlijke boek file opgeslagen in calibre bibliotheek vanuit de metagegevens in de calibre database. Normaal worden metagegevens enkel geüpdatet wanneer files uit calibre worden geëxporteerd, dit commando is nuttig indien u wilt dat de bestanden worden geüpdatet ter plaatse. Opgelet dat verschillende formaten verschillende hoeveelheden metagegevens ondersteunen. U kan de speciale waarde "all" gebruiken in plaats van boek_id om de metagegevens van alle boeken aan te passen. U kan ook verschillende boek id's meegeven gescheiden door spaties en id reeksen gescheiden door koppeltekens. Bijvoorbeeld: calibredb ingevoegde_metadata 1 2 10-15 23
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --only-formats, -f
- Update alleen de metagegevens in specifieke bestands types. Gebruik dit meerdere keren om verschillende formaten aan te passen. Standaard worden alle formaten aangepast.
SEARCH¶
calibredb search [opties] zoekexpressie
Doorzoek de bibliotheek voor de specifieke zoekterm, geeft een komma-gescheiden lijst van boek IDs terug overeenkomend met de zoekuitdrukking. Het uitvoerformaat is nuttig om andere commando's uit te voeren die een lijst van IDs aanvaarden als invoer
De zoekexpressie kan eerder wat zijn uit calibre's krachtige zoek querytaal bijvoorbeeld: %p rog search author:asimov 'title:"i robot"'
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --limit, -l
- Het maximum aantal weer te geven resultaten. Standaard is alle resultaten.
FTS_INDEX¶
calibredb fts_index [options] enable/disable/status/reindex
Controleer het Volledige tekst doorzoeken indexeren proces.
- enable
- Schakelt FTS indexeren in voor deze bibliotheek
- disable
- Schakelt FTS indexeren uit voor deze bibliotheek
- status
- Toont de huidige indexeringsstatus
- reindex
- Kan gebruikt worden om bepaalde boeken te re-indexeren of de hele bibliotheek. Om bepaalde boeken te re-indexeren specificeer de boek IDs als extra argumenten na de reindex opdracht. Als geen boek IDs gespecificeerd werden, wordt de hele bibliotheek geherindexeerd.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --indexing-speed
- Indexeersnelheid. Gebruik snel voor snel indexeren met alle kracht van uw pc en traag voor minder intensief indexeren. Merk op dat de snelheid terug op traag wordt gezet na elk gebruik.
- --wait-for-completion
- Wacht tot alle boeken geïndexeerd zijn, indexeringsvoortgang wordt regelmatig getoond
FTS_SEARCH¶
calibredb fts_search [options] zoekexpressie
Doe een volledige tekstopzoeking op de gehele bibliotheek of een onderdeel ervan.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --do-not-match-on-related-words
- Match alleen op exacte woorden, niet op verwante woorden. Correctie komt dus niet overeen met corrigeren.
- --include-snippets
- Voeg fragmenten toe van de tekst rond elke overeenkomst. Merk op dat dit het zoeken veel langzamer maakt.
- --indexing-threshold
- Hoeveel procent van de bibliotheek moet worden geïndexeerd voordat zoeken is toegestaan. Standaard ingesteld op 90
- --match-end-marker
- De markering die wordt gebruikt om het einde van een overeenkomend woord in een fragment aan te geven
- --match-start-marker
- De markering die wordt gebruikt om het begin van een overeenkomend woord in een fragment aan te geven
- --output-format
- De indeling waarin de zoekresultaten moeten worden uitgevoerd. Ofwel 'tekst' voor platte tekst of 'json' voor JSON-uitvoer.
- --restrict-to
- Beperk de doorzochte boeken, ofwel met een zoekexpressie ofwel met IDs. Bijvoorbeeld: IDs: 1,2,3 om te beperken op ID of search:tag:foo om te beperken tot boeken met label foo.
NOTES¶
calibredb notes [options] [list|search|show|set|remove]
Manage the notes attached to items such as authors, series, tags and publishers. FIELD is the lookup name of the field, for example: authors, series, tags, publisher or #mycolumn. ITEM is the name of the item, for example the name of an author. Items are matched case insensitively.
List the items that have notes, optionally only those in the specified field. This is the default action:
calibredb notes list [FIELD]
Search the text of notes using the same SQLite full text search syntax as the Browse notes tool in calibre. Print the field, item name and an excerpt for each match. Use --field to search only the notes in a particular field:
calibredb notes search "search expression" calibredb notes search --field authors "search expression"
Print the note for an item as Markdown formatted text, or with --as-html as an HTML document with any images embedded, suitable for use with set:
calibredb notes show FIELD ITEM
Replace the note for an item with the contents of an HTML file. Use - to read the HTML from standard input. Images embedded as base64-encoded data: URLs are added to the note for both local and remote libraries. When using a local library and reading from a file, images referenced by paths relative to the file are added as well:
calibredb notes set FIELD ITEM FILE
Remove the note for an item:
calibredb notes remove FIELD ITEM
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --as-html
- When showing a note, output it as HTML instead of Markdown formatted text
- --field
- When searching notes, restrict the search to this field, for example: authors, tags or #mycolumn
ITEMS¶
calibredb items [options] (rename|remove) FIELD ITEM ...
Rename or remove items such as authors, tags, series and publishers in all books, the same as the Manage authors, tags, etc. actions in the calibre interface. FIELD is the lookup name of the field, for example: authors, tags, series, publisher or #mycolumn. Items are matched case insensitively.
Rename an item. If an item named NEW_NAME already exists, the two items are merged. For fields that contain multiple values, NEW_NAME can contain more than one value, separated by the separator for the field, for example a comma for tags. The item is then replaced by all the values:
calibredb items rename FIELD ITEM NEW_NAME
Remove one or more items from all books. Authors cannot be removed:
calibredb items remove FIELD ITEM [ITEM ...]
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --search, -s
- Only change books that match the specified search expression, for example: tags:"=Fiction"
VIRTUAL_LIBRARIES¶
calibredb virtual_libraries [options] [list|add|rename|remove]
Manage the Virtual libraries of this library. A Virtual library is a search that behaves as though the library contains only the books it matches. To list or search the books in a Virtual library, use: calibredb search 'vl:"name"'
List the Virtual libraries, with their searches and number of books. This is the default action:
calibredb virtual_libraries list
Create a Virtual library from a search:
calibredb virtual_libraries add name search_expression
Rename a Virtual library:
calibredb virtual_libraries rename name new_name
Remove Virtual libraries, the books in them are not changed:
calibredb virtual_libraries remove name ...
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --for-machine
- Generate output in JSON format, which is more suitable for machine parsing
- --replace
- Replace the search of an existing Virtual library with the same name when adding
ANNOTATIONS¶
calibredb annotations [options] [list|search|export|import|remove]
Manage the annotations, that is the highlights and bookmarks, of books, as created in the calibre E-book viewer or synced from other applications.
List the annotations, with their ids. This is the default action:
calibredb annotations list
Search highlighted text, annotation notes and bookmark titles using the same SQLite full text search syntax as the Browse annotations tool. Results are ordered by relevance and include annotation ids, book titles and matching excerpts. Use --search to restrict the books, --type to restrict the annotation type, --user-type and --annotation-user to restrict the user, --no-stemming to match exact word forms, or --format json for a JSON array of results including the annotation data and excerpts:
calibredb annotations search "search expression"
Export the annotations as plain text, Markdown or JSON, grouped by book. The JSON is the same calibre annotation collection as created by the Export button in the Browse annotations tool:
calibredb annotations export
Import a calibre annotation collection exported as JSON by this command or the Browse annotations tool. The collection must contain annotations from only one book. BOOK_ID is the destination book id, not the id stored in the file. Only the annotations of the format FORMAT are imported, annotations of other formats are skipped. FORMAT must exist in the destination book. Use the same edition of the book so positions match:
calibredb annotations import BOOK_ID FORMAT FILE
Use - for FILE to read from standard input. The entire collection is validated before importing. Annotations are merged with existing ones using the viewer's rules: highlights are matched by UUID and bookmarks by title, and the newer timestamp wins. Repeated imports do not create duplicates. Unrelated annotations and reading positions are preserved.
By default annotations are imported into those of the calibre E-book viewer. Use --user-type web --annotation-user USER to import them into those of a Content server user instead. Exported collections record the user the annotations belong to, and if a collection contains annotations of more than one user, it is rejected. Use the --user-type and --annotation-user options when exporting, to export the annotations of a single user.
Permanently remove the annotations with the specified ids, as shown by list:
calibredb annotations remove ID ...
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --annotation-user
- Only list, search or export the annotations of the specified user. For import, the Content server user to import the annotations for, required with --user-type web. Note that this can be any user, not just the one used to connect to a remote library.
- --format, -f
- The export format, one of: text, markdown, json. For search, text or json. Default is: text
- --no-stemming
- For search, match exact word forms instead of word stems
- --search, -s
- Only list, search or export the annotations of books matching the specified book search query, for example: --search "series:Foundation"
- --type, -t
- Only list, search or export annotations of the specified type, one of: highlight, bookmark
- --user-type
- Only list, search or export the annotations of the specified type of user. For import, the type of user to import the annotations for, the calibre E-book viewer (local) or a Content server user (web). Default for import is local.
TRASH¶
calibredb trash [options] (list|restore|delete|empty) [ids]
Manage the books and formats that have been removed and placed in the trash bin. Entries in the trash bin are permanently deleted automatically after some days. ids is a comma separated list of book ids, as for the remove command, for example: 23,34,57-85 (when specifying a range, the last number in the range is not included).
List the removed books and formats, most recently removed first, with the times they were removed in local time. Removed formats of books that no longer exist are marked as not restorable, they can only be deleted. With --for-machine, the times are in UTC:
calibredb trash list
Restore removed books, or with --formats, the removed formats of books:
calibredb trash restore ids
Permanently delete entries from the trash bin:
calibredb trash delete ids
Permanently delete everything in the trash bin:
calibredb trash empty
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --for-machine
- Generate output for the list action in JSON format, which is more suitable for machine parsing
- --formats
- Act on the removed formats of the specified books, instead of on removed books
DATA_FILES¶
calibredb data_files [options] (list|add|get|rename|remove) BOOK_ID ...
Manage the extra data files associated with a book, in local or remote libraries. Names are relative to the book's data directory. Use / for subdirectories, is also accepted. Files whose names contain a are listed, but cannot otherwise be managed. E-book formats, covers and metadata.opf cannot be accessed with this command. Remote libraries require an account with write access, as for other management commands, and do not support accounts with per-library search restrictions.
List file names, sizes in bytes and modification times (seconds since the Unix epoch). Use --for-machine for JSON output:
calibredb data_files list BOOK_ID
Add a file, using its basename, or --name to specify a name or subdirectory. Existing files are not replaced unless --replace is specified. This is also available through add_format --as-extra-data-file:
calibredb data_files add BOOK_ID FILE
Save one data file to --output on the local machine. Existing output files are not replaced unless --replace is specified:
calibredb data_files get BOOK_ID NAME --output FILE
Rename a file. Existing destinations are not replaced unless --replace is set:
calibredb data_files rename BOOK_ID NAME NEW_NAME
Remove a file to the operating system's recycle bin. With --permanent, delete it permanently instead. For remote libraries this happens on the server:
calibredb data_files remove BOOK_ID NAME
Directories left empty by rename and remove are deleted. With remote libraries, each file is transferred in a single request, so very large files need enough memory on both the client and the server, and uploads are limited by the maximum request size of the server.
Als u aan calibredb parameters met spaties mee wilt geven, moet u deze met aanhalingstekens omsluiten. Bv.: "/some path/with spaces"
- --for-machine
- Output the list of files as JSON
- --name
- Name to use for the added file, relative to the data directory
- --output
- Local destination for the get action
- --permanent
- Permanently delete the data file instead of using the recycle bin
- --replace
- Allow replacing existing files when adding, getting or renaming
Author¶
Kovid Goyal
Copyright¶
Kovid Goyal
| November 6, 2026 | 9.18.0 |