Arch manual pages

CALIBREDB(1) calibre CALIBREDB(1)

calibredb - calibredb
calibredb command [options] [arguments]

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.

  • OPSI GLOBAL
  • list
  • add
MENAMBAHKAN DARI DIREKTORI
  • remove
  • add_format
  • remove_format
  • show_metadata
  • set_metadata
  • export
  • catalog
OPSI EPUB
  • 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
tampilkan pesan bantuan ini dan keluar
--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
Nama pengguna untuk menyambung ke server Konten calibre
--version
tampilkan versi program dan keluar

calibredb list [options]

List the books available in the calibre database.

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

--ascending
Urutkan hasil dalam urutan menaik
--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
The maximum number of results to display. Default: all
--line-width, -w
The maximum width of a single line in the output. Defaults to detecting screen size.
--prefix
The prefix for all file paths. Default is the absolute path to the library folder.
--search, -s
Filter the results by the search query. For the format of the search query, please see the search related documentation in the User Manual. Default is to do no filtering.
--separator
The string used to separate fields. Default is a space.
--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 [opsi] berkas1 berkas2 berkas3 ...

Menambahkan berkas-berkas yang dinyatakan sebagai buku ke basis data. Anda juga dapat menyatakan direktori, lihat opsi terkait direktori di bawah.

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
Tata pengarang buku yang ditambahkan
--cover, -c
Path ke sampul yang akan dipakai untuk buku yang ditambahkan
--duplicates, -d
Tambahkan buku ke basis data meskipun sudah ada. Perbandingan dilakukan berdasarkan judul buku.
--empty, -e
Menambahkan sebuah buku kosong (buku tanpa format)
--identifier, -I
Tata identifier untuk buku ini, mis. -I asin:XXX -I isbn:YYY
--isbn, -i
Tata ISBN buku yang ditambahkan
--languages, -l
Daftar bahasa yang dipisah koma (paling baik memakai kode bahasa ISO639, walaupun beberapa nama bahasa mungkin juga dikenali)
--series, -s
Tata seri buku yang ditambahkan
--series-index, -S
Tata nomor seri buku yang ditambahkan
--tags, -T
Tata tag buku yang ditambahkan
--title, -t
Tata judul buku yang ditambahkan

Pilihan untuk mengontrol penambahan buku dari direktori. Secara baku hanya berkas-berkas yang memiliki ekstensi berupa tipe berkas e-book yang dikenal yang ditambahkan.
--add
Sebuah pola (glob) nama berkas, berkas yang sesuai dengan pola ini akan ditambahkan ketika memindai direktori untuk berkas, bahkan jika mereka bukan dari jenis berkas e-book yang dikenal. Dapat ditentukan beberapa kali untuk beberapa pola.
--ignore
Sebuah pola (glob) nama berkas, berkas yang sesuai dengan pola ini akan diabaikan ketika memindai direktori untuk berkas. Dapat ditentukan beberapa kali untuk beberapa pola. Misalnya: *.pdf akan mengabaikan semua berkas pdf
--one-book-per-directory, -1
Mengasumsikan bahwa setiap direktori hanya memiliki satu buku logis dan bahwa semua berkas di dalamnya adalah format e-book yang berbeda dari buku itu
--recurse, -r
Memroses direktori secara rekursif

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
Jangan gunakan tong sampah

calibredb add_format [opsi] id berkas_ebook

Tambahkan e-book di berkas_ebook ke format yang tersedia untuk buku logis yang diidentifikasi dengan id. Anda bisa mendapatkan id dengan menggunakan perintah pencarian. Jika format sudah ada, itu akan diganti, kecuali jika opsi jangan mengganti dinyatakan.

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
Jangan menimpa format jika sudah ada

calibredb remove_format [pilihan] id fmt

Hapus format fmt dari buku logis diidentifikasi dengan id. Anda bisa mendapatkan id dengan menggunakan perintah pencarian. fmt harus menjadi ekstensi berkas seperti LRF atau TXT atau EPUB. Jika buku logis tidak memiliki fmt tersebut, tidak melakukan apa-apa.

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 [pilihan] id

Menampilkan metadata yang tersimpan dalam basis data calibre untuk buku yang diidentifikasi oleh id. id adalah nomor id dari perintah pencarian.

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
Print metadata in OPF form (XML)

calibredb set_metadata [pilihan] id [/path/ke/metadata.opf]

Mengatur metadata yang tersimpan dalam basis data calibre untuk buku yang diidentifikasi oleh id dari berkas OPF metadata.opf. id adalah nomor id dari perintah pencarian. Anda bisa mendapatkan gambaran cepat untuk format OPF dengan menggunakan switch --as-opf ke perintah show_metadata. Anda juga dapat mengatur metadata dari masing-masing ruas dengan opsi --field. Jika Anda menggunakan opsi --field, tidak perlu menyatakan berkas OPF.

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
The field to set. Format is field_name:value, for example: --field tags:tag1,tag2. Use --list-fields to get a list of all field names. You can specify this option multiple times to set multiple fields. Note: For languages you must use the ISO639 language codes (e.g. en for English, fr for French and so on). 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
List the metadata field names that can be used with the --field option

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
Ekspor semua buku dalam basis data, mengabaikan daftar id.
--dont-asciiize
Have calibre convert all non English characters into English equivalents for the file names. This is useful if saving to a legacy filesystem without full support for Unicode filenames. Menentukan saklar ini akan menonaktifkan perilaku ini.
--dont-save-cover
Normally, calibre will save the cover in a separate file along with the actual e-book files. Menentukan saklar ini akan menonaktifkan perilaku ini.
--dont-update-metadata
Normally, calibre will update the metadata in the saved files from what is in the calibre library. Makes saving to disk slower. Menentukan saklar ini akan menonaktifkan perilaku ini.
--dont-write-opf
Normally, calibre will write the metadata into a separate OPF file along with the actual e-book files. Menentukan saklar ini akan menonaktifkan perilaku ini.
--formats
Comma separated list of formats to save for each book. By default all available formats are saved.
--progress
Laporkan kemajuan
--replace-whitespace
Replace whitespace with underscores.
--single-dir
Ekspor semua buku ke dalam satu direktori
--template
The template to control the filename and directory structure of the saved files. Default is "{author_sort}/{title}/{title} - {authors}" which will save books into a per-author subdirectory with filenames containing title and author. Available controls are: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}
--timefmt
The format in which to display dates. %d - day, %b - month, %m - month number, %Y - year. Default is: %b, %Y
--to-dir
Ekspor buku ke direktori yang ditentukan. Baku adalah .
--to-lowercase
Convert paths to lowercase.

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. To see the different options, specify the name of the output file and then the --help option.

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
Comma-separated list of database IDs to catalog. If declared, --search is ignored. Default: all
--search, -s
Filter the results by the search query. For the format of the search query, please see the search-related documentation in the User Manual. Default: no filtering
--verbose, -v
Tampilkan informasi luaran rinci. Berguna untuk pengawakutuan

--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: 'Tags' 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 [opsi] label nama tipedata

Membuat kolom ubahan. label adalah nama kolom ramah mesin. Tidak boleh mengandung spasi atau titik dua. nama adalah nama kolom ramah manusia. tipedata adalah salah satu dari: 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
Sebuah kamus pilihan untuk menyesuaikan bagaimana data dalam kolom ini akan ditafsirkan. Ini adalah string JSON. Untuk enumerasi kolom, gunakan --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" Ada banyak pilihan yang bisa masuk ke variabel tampilan. Pilihan dengan jenis kolom adalah: komposit: composite_template, composite_sort, make_category, contains_html, use_decorations datetime: date_format enumerasi: enum_values, enum_colors, use_decorations int, float: number_format teks: is_names, use_decorations Cara terbaik untuk menemukan kombinasi yang legal adalah dengan membuat kolom ubahan dari jenis yang sesuai di GUI kemudian melihat OPF cadangan untuk sebuah buku (memastikan bahwa OPF baru telah dibuat sejak kolom ditambahkan). Anda akan melihat JSON untuk "display" untuk kolom baru di OPF.
--is-multiple
Kolom ini menyimpan tag seperti data (yaitu beberapa nilai yang dipisahkan koma). Hanya berlaku jika tipedata adalah teks.

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
Tampilkan rincian untuk setiap kolom.

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
Jangan tanyakan konfirmasi

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
If the column stores multiple values, append the specified values to the existing ones, instead of replacing them.

calibredb restore_database [options]

Restore this database from the metadata stored in OPF files in each directory 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.

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
Really do the recovery. The command will not run unless this option is specified.

calibredb check_library [options]

Perform some checks on the filesystem representing a library. Reports are 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
Luaran dalam CSV
--ignore_extensions, -e
Daftar ekstensi untuk diabaikan yang dipisah koma. Baku: semua
--ignore_names, -n
Daftar nama untuk diabaikan yang dipisah koma. Baku: semua
--report, -r
Daftar laporan yang dipisahkan koma. Baku: semua

calibredb list_categories [options]

Produce a report of the category information in the database. The information is the equivalent of what is shown in the Tag browser.

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
Luaran dalam CSV
--dialect
The type of CSV file to produce. Choices: excel, excel-tab, unix
--item_count, -i
Output only the number of items in a category instead of the counts per item within the category
--width, -w
The maximum width of a single line in the output. Defaults to detecting screen size.

calibredb backup_metadata [pilihan]

Membuat cadangan metadata yang disimpan dalam basis data ke masing-masing berkas OPF di setiap direktori buku. Hal ini biasanya terjadi secara otomatis, tetapi Anda dapat menjalankan perintah untuk memaksa kembali pembuatan berkas OPF, dengan opsi --all.

Perhatikan bahwa biasanya tidak perlu melakukan ini, karena berkas OPF dicadangkan secara otomatis, setiap saat metadata berubah.

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

--all
Biasanya, perintah ini hanya beroperasi pada buku yang memiliki berkas OPF kedaluwarsa. Opsi ini membuatnya beroperasi pada semua buku.

calibredb clone path/to/new/library

Create a clone of the current library. This creates a new, empty library that has all the same custom columns, Virtual libraries and other settings as the current library.

The cloned library will contain no books. If you want to create a full duplicate, including all books, then simply use your filesystem tools to copy the library folder.

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 [pilihan] id_buku

Memperbarui metadata dalam berkas buku aktual yang disimpan di pustakaan calibre dari metadata dalam basis data calibre. Biasanya, metadata diperbarui hanya ketika mengekspor berkas dari calibre, perintah ini berguna jika Anda ingin berkas Diperbarui di tempat. Perhatikan bahwa format berkas yang berbeda mendukung banyaknya metadata yang berbeda. Anda dapat menggunakan nilai khusus ‘all’ bagi id_buku untuk memperbarui metadata dalam semua buku. Anda juga dapat menentukan banyak id buku yang dipisahkan oleh spasi dan rentang id dipisahkan oleh tanda hubung. Misalnya: 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: calibredb search author:asimov 'title:"i 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
November 13, 2020 5.5.0