Provided by: calibre_3.21.0+dfsg-1build1_all
NAME
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. • グローバルオプション • list • add • ディレクトリから追加 • remove • add_format • remove_format • show_metadata • set_metadata • export • catalog • 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 このヘルプメッセージを表示して終了 --library-path, --with-library Calibreライブラリへのpath。デフォルトでは設定画面で指定されたpathが使用されます。リモートライブラリに対して操作を行うためにCalibreコンテンツサーバに接続することも可能です。コンテンツサーバに接続するには、‐ http://hostname:port/#library_id の形式のURLを指定します。例えば http://localhost:8080/#mylibrary のように指定します。library_id はコンテンツサーバ 上の接続したいライブラリのIDです。特殊な library_id として - を指定すると、そのサー バ上で利用可能なライブラリの一覧を表示できます。コンテンツサーバ経由でのアクセスを 設定する方法について詳しくは https://manual.calibre-ebook.com/generated/en/calibredb.html を参照してください。 --password Calibreコンテンツサーバ接続用パスワード。標準入力からパスワードを読み取るには、特殊 文字 <stdin> を使ってください。パスワードをファイルから読み込むには <f:/path/to/file> を使ってください。 (例えば先頭の <f: に続けてファイルへのフルパス を記述し、最後に > で閉じます。) カギ括弧は必須です。使用するシェルによっては、必要 に応じてエスケープしたり引用符で囲ってください。 --username Calibreコンテンツサーバ接続用ユーザ名 --version プログラムのバージョン番号を表示して終了
LIST
calibredb list [options] Calibreデータベースに存在する本のリスト スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --ascending 昇順に並び替え --fields, -f データベース中の本の一覧を表示するときに表示するフィールド。フィールドをカンマ区切 りで指定します。 指定可能なフィールド: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid デフォルト: title,authors 特殊フィールド名 "all" を指定するとすべてのフィールドを選択します。上記のビルトイン フィールドの他、カスタムフィールドも *field_name として指定可能です。たとえば、カス タムフィールド #rating を表示させたいときには *rating と指定してください。 --for-machine JSONフォーマットで出力します。JSONはコンピュータでの処理により適した形式です。この オプションを指定すると行幅とセパレーターオプションは無視されます。 --limit 表示する最大結果数。デフォルトはすべて --line-width, -w 出力ファイル中の、1行の最大の長さ。デフォルトは画面サイズから判別。 --prefix すべてのファイルパスのプレフィックス。デフォルトはライブラリフォルダへの絶対パス。 --search, -s 検索文字列で結果を絞り込む。検索文字列のフォーマットについては、ユーザマニュアルの 検索関連のドキュメントを参照してください。デフォルトでは絞り込みを行いません。 --separator 区切り文字(デフォルトは半角スペース) --sort-by 整列に使用するフィールド 使用可能フィールド: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid デフォルト: id
ADD
calibredb add [options] file1 file2 file3 ... 指定したファイルをデータベースに追加する。ディレクトリを追加することもできます。下のディレ クトリ関連オプションも参照してください。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --authors, -a 追加する本の著者を設定 --cover, -c 追加する本の表紙をパスで指定 --duplicates, -d 本がすでにデータベースに存在する場合でも追加します。本のタイトルに基づいて比較しま す。 --empty, -e 空の本を追加する(フォーマットが1つも無い本) --identifier, -I 追加する本の識別子を設定、例: -I asin:XXX -I isbn:YYY --isbn, -i 追加する本のISBNを設定 --languages, -l カンマ区切りの言語のリスト(ISO639言語コードで指定するのが確実ですが、それ以外のいく つかの言語名も認識します) --series, -s 追加する本のシリーズを設定 --series-index, -S 追加する本のシリーズ番号を設定 --tags, -T 追加する本のタグを設定 --title, -t 追加する本のタイトルを設定 ディレクトリから追加 ディレクトリからの本の追加方法を設定します。デフォルトでは既知の電子書籍ファイルタイプの拡 張子のファイルのみ追加します。 --add ファイル名のglobパターンを指定し、ディレクトリからファイルを読み込むときに、指定パ ターンに一致したファイルは既知の電子書籍のファイルタイプでなくても追加します。複数 のパターンを指定するために、複数回指定可能です。 --ignore ファイル名のglobパターンを指定し、パターンに一致したファイルはディレクトリからファ イルを読み込むときに無視します。複数のパターンを指定するために複数回指定可能で す。たちとえば、*.pdf と指定するとすべてのPDFファイルを無視します。 --one-book-per-directory, -1 各ディレクトリには1つの本しかなく、すべてのファイルは、その本の違ったフォーマットで ある、と仮定します。 --recurse, -r ディレクトリを再帰的に処理する
REMOVE
calibredb remove ids idsに指定された本をデータベースから削除。idsには数字をカンマ区切りで指定します (本 のIDはsearchコマンドで取得できます)。例: 23,34,57-85 (範囲で指定した場合、範囲の終端は含ま れません) スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --permanent ゴミ箱を使用しない
ADD_FORMAT
calibredb add_format [options] id ebook_file ebook_file で指定する電子書籍ファイルを、id で指定された本の利用可能なフォーマットとして追 加します。idはsearch コマンドで取得できます。フォーマットがすでに存在する場合は、置換しな いオプションを有効にした場合をのぞいて、置換されます。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --dont-replace フォーマットがすでに存在する場合に置換しない
REMOVE_FORMAT
calibredb remove_format [options] id fmt fmt で指定したフォーマットを id で指定した本から削除します。id は search コマンドで取得で きます。fmt はLRF, TXT, EPUB のようにファイルの拡張子で指定してください。本に指定した フォーマットがない場合、なにもしません。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces"
SHOW_METADATA
calibredb show_metadata [options] id id で指定された本の、Calibreのデータベースに保存された書誌情報を表示します。id はsearch コ マンドで取得できるID番号です。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --as-opf OPFフォーマット(XML)で書誌情報を表示
SET_METADATA
calibredb set_metadata [options] id [/path/to/metadata.opf] id で指定された本のCalibreのデータベースに保存された書誌情報に metadata.opf で指定したOPFファイルの内容を設定します。 id はsearch コマンドで取得でき るID番号です。 OPF ファイルについて簡単に知りたい場合は、show_metadata コマンドの --as-opfオプションを使用してみてください。 --field オプションを使用する場合は OPFファイル を指定する必要は ありません。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --field, -f フィールドに設定する値。field_name:value の形式で指定してください。例: --field tags:tag1,tag2。使用可能なフィールド名のリストを得るには --list-fields を使用してく ださい。複数のフィールドの値を設定するためには、このオプションを複数指定してくださ い。注意: 言語を指定する場合は ISO639言語コードを使用してください(英語は en、フラン ス語は fr 等)。識別子は以下の書式で指定してください --field identifiers:isbn:XXXX,doi:YYYYY。Boolean型(yes/no)のフィールドは、true, false また はyes, no で指定してください。 --list-fields, -l --field オプションで使用可能な書誌情報フィールド名のリストを表示
EXPORT
calibredb export [options] ids 指定したID(カンマ区切りリスト)の本をファイルシステムにエクスポートします。 エクスポート処 理では、すべてのフォーマットと表紙と書誌情報(OPFファイル)を 保存します。 ID番号は search コマンドで取得できます。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --all IDのリストを無視してデータベースからすべての本をエクスポートします。 --dont-asciiize Calibreは、通常のファイル名にすべての非アルファベット文字を、英語に相当するものへ変 換します。注意: これをOFFにした場合、ファイルシステムがどの程度ユニコードをサポート しているかによって、保存時にエラーが発生することがあります。 このスイッチ指定する と、この挙動をOFFにできます。 --dont-save-cover 通常、Calibreは表紙を電子書籍ファイルとは別のファイルに保存します。 このスイッチ指 定すると、この挙動をOFFにできます。 --dont-update-metadata 通常、Calibreはライブラリ内のファイルの書誌情報をアップデートしますが、これはディス クへの保存を遅くします。 このスイッチ指定すると、この挙動をOFFにできます。 --dont-write-opf 通常、Calibreは電子書籍ファイル本体に付随する別個のOPFファイルに書誌情報を書き込み ます。 このスイッチ指定すると、この挙動をOFFにできます。 --formats 各本を保存する時のカンマ区切りのフォーマットのリスト。デフォルトではすべての存在す るフォーマットが保存されます。 --progress 進捗状況を表示 --replace-whitespace 空白をアンダースコアに置換 --single-dir ディレクトリにすべての本をエクスポート --template 保存されるファイルの、ファイル名とディレクトリ構造を指定するテンプレート。デフォル トは"{author_sort}/{title}/{title} - {authors}"で、これは本を著者別のディレクトリに 入れ、タイトルと著者名のファイル名をつけます。使用可能な操作は:{author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title} --timefmt 日付表示時のフォーマット。 %d - 日, %b - 月(の名前), %m - 月の番号, %Y - 年. デフォ ルト: %b, %Y --to-dir 本を指定したディレクトリにエクスポートします。デフォルト: . --to-lowercase パスを小文字に変換
CATALOG
calibredb catalog /path/to/destination.(csv|epub|mobi|xml...) [options] path/to/destination の拡張子で指定されるフォーマットでカタログをエクスポートします。 出力 されたカタログに表示するエントリはoptionsで制御します。 カタログのフォーマットにより、サ ポートするオプションが異なるので注意してください。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --ids, -i カタログに対するカンマ区切りのデータベースID。 宣言する場合は、:option: ` --search`は無視されます。 デフォルト: all --search, -s 結果を検索文字列で絞り込みします。検索文字列のフォーマットについては、ユーザマニュ アルの検索関連ドキュメントを参照してください。 デフォルト: 絞り込みなし --verbose, -v 詳細な出力情報を表示します。デバッグに便利です。 EPUB オプション --catalog-title 書誌情報のタイトルとして使われる、生成されたカタログのタイトル。 デフォルト: 'My Books' 適用: AZW3, EPUB, MOBI出力形式 --cross-reference-authors 複数の著者のいる本の著者セクション用にクロスリファレンスを作成。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --debug-pipeline 指定したディレクトリに変換パイプライン中の異なるステージのアウトプットを保存。変換 プロセスのどこでバグが発生しているのかわからないときに有用です。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI出力形式 --exclude-genre ジャンルとして除外するタグを表す正規表現。 デフォルト: '[.+]|^+$' はブラケットで囲 まれたタグを除外します。例: '[Project Gutenberg]' と '+' は本を読むデフォルトのタ グ。 適用: AZW3, EPUB, MOBI出力形式 --exclusion-rules 生成したカタログから除外する本を指定するルール。 除外ルールはだいたい次のいずれかの ようになります。 ('<rule name>','Tags','<comma-separated list of tags>') または ('<rule name>','<custom column>','<pattern>'). 使用例: (('Archived books','#status','Archived'),) 上記例では、カスタム列 'status' の値が 'Archived' の 本を除外します。 ルールが複数指定されている場合には、すべて適用されます。 デフォル ト: "(('Catalogs','Tags','Catalog'),)" 適用: AZW3, EPUB, MOBI出力形式 --generate-authors カタログに 'Authors' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --generate-descriptions カタログに 'Description' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --generate-genres カタログに 'Genres' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --generate-recently-added カタログに 'Recently Added' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --generate-series カタログにシリーズセクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出 力形式 --generate-titles カタログに 'Titles' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式 --genre-source-field 'Genre' セクション用のソースフィールド。 デフォルト: 'タグ' 適用: AZW3, EPUB, MOBI出力形式 --header-note-source-field Descriptionヘッダに挿入するノートを格納したカスタムフィールド。 デフォルト: '' 適 用: AZW3, EPUB, MOBI出力形式 --merge-comments-rule #<custom field>:[before|after]:[True|False] の形式で指定。 <custom field> コメント にマージするノートを含むカスタムフィールド [before|after] コメントに関するノートの 位置 [True|False] ノートとコメントの間に水平線を挿入するかどうか デフォルト: '::' 適用: AZW3, EPUB, MOBI出力形式 --output-profile 出力プロファイルを指定。場合により、デバイスに合わせてカタログをオプティマイズする 際に出力プロファイルが必要になります。例えば、'kindle' または 'kindle_dx' は、セク ションと記事からなる構造化された目次を精製します。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI出力形式 --prefix-rules 既読本を示すプリフィックスや、ウィッシュリスト、その他ユーザ指定のプリフィックスを 含めるために使用するルールを指定。 プリフィックスルールは ('<rule name>','<source field>','<pattern>','<prefix>') のように指定します。 複数のルールが指定されている場 合には、最初に一致したルールが使用されます。 デフォルト: '(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))' 適用: AZW3, EPUB, MOBI出力形式 --preset GUIカタログビルだーで作成された名前つきプリセットを使用。 カタログ作成のすべての設 定を指定するためのプリセットです。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI出力形 式 --thumb-width カタログ中の本の表紙のサイズのヒント (インチ指定) 範囲: 1.0 - 2.0 デフォルト: '1.0' 適用: AZW3, EPUB, MOBI出力形式 --use-existing-cover カタログ生成時に既存の表紙を上書き。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力 形式
SAVED_SEARCHES
calibredb saved_searches [options] (list|add|remove) データベースに格納された保存済み検索条件の管理。 既存の名称で検索条件を保存しようとした場 合には、上書きされます。 追加の構文: calibredb saved_searches add search_name search_expression 削除の構文: calibredb saved_searches remove search_name スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces"
ADD_CUSTOM_COLUMN
calibredb add_custom_column [options] label name datatype カスタム列を作成。labelはマシン・フレンドリな列の名前。スペースやコロンを含めません。 nameは人間に読みやすい列の名前。 datatypeは以下のいずれか: bool, comments, composite, datetime, enumeration, float, int, rating, series, text スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --display 列のデータがどのように翻訳されるかをカスタマイズする辞書を指定するオプションで す。JSON文字列で指定します。列挙型の列の場合、以下を使用してくださ い:option:--display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" 。 値の表示方法に は、様々なオプションがあります。列の型ごとのオプションは以下の通りです。 合成型: composite_template, composite_sort, make_category,contains_html, use_decorations 日 付: date_format 列挙型: enum_values, enum_colors, use_decorations 整数、浮動小数点 数: number_format テキスト: is_names, use_decorations 型とオプションの正しい組み合 わせを知るには、GUIから適切な型のカスタム列を作成して、出力されるバックアップ のOPFファイルを見てみるのが一番よい方法です(列を追加して以降にOPFが再生成されている ことを確認してください)。OPFの新しい列に "display" というJSONが見つかるでしょう。 --is-multiple この列はタグ状のデータ(例: 複数のカンマ区切りの値)を保持します。datatypeがtextの 時のみ有効です。
CUSTOM_COLUMNS
calibredb custom_columns [options] 利用可能なカスタム列の一覧を表示。列ラベルとIDを表示します。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --details, -d 各列の詳細を表示
REMOVE_CUSTOM_COLUMN
calibredb remove_custom_column [options] label labelで指定されるカスタム列を削除。 custom_columns コマンドで存在するカスタム列を見ること ができます。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --force, -f 確認を表示しない
SET_CUSTOM
calibredb set_custom [options] column id value idで指定された本のカスタム列の値を設定します。 search コマンドでIDのリストが取得できます。 custom_columns コマンドでカスタム列の名前のリストが取得できます。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --append, -a もし列に複数の値を設定できる場合、値を指定した値に入れ替えるのではなく、すでにある 値に付け加えます。
RESTORE_DATABASE
calibredb restore_database [options] Calibreライブラリの各ディレクトリに保存されているOPFファイルから書誌情報を読み取り、データ ベースをリストアします。 これはmetadata.dbファイルが壊れてしまった時に有用です。 注意: このコマンドを実行すると、データベースを完全に再生成します。すべての保存済み検索条 件、ユーザカテゴリ、書誌情報変換ルール、書誌ごとの変換設定、カスタムレシピは失われます。リ ストアされる書誌情報は、OPFファイルの内容と同等となります。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --really-do-it, -r 実際にリカバリーを行います。このコマンドはこのオプションを指定しなければ実行されま せん。
CHECK_LIBRARY
calibredb check_library [options] ライブラリのあるファイルシステムをチェックします。レポート:invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, failed_folders スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --csv, -c CSVで出力 --ignore_extensions, -e 無視する拡張子(カンマ区切りのリスト) デフォルト: all --ignore_names, -n 無視する名前のカンマ区切りのリスト デフォルト: all --report, -r カンマ区切りのレポートのリスト デフォルト: all
LIST_CATEGORIES
calibredb list_categories [options] データベース中のカテゴリ情報のレポートを作成します。情報はタグブラウザに表示されるものと同 等です。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --categories, -r カンマ区切りのカテゴリの検索名リスト。デフォルト: all --csv, -c CSVで出力 --dialect DSVファイルのタイプ。選択肢: excel, excel-tab --item_count, -i カテゴリ内のアイテムのカウント番号ではなく、カテゴリ内のアイテム番号のみを出力しま す。 --width, -w 出力ファイル中の、1行の最大の長さ。デフォルトは画面サイズから判別。
BACKUP_METADATA
calibredb backup_metadata [options] データベースに保存された書誌情報のバックアップを、それぞれの本の ディレクトリに個別 のOPFファイルとして保存します。 通常この処理は自動的に行われますが、--allオプションを つけ て実行すると、強制的にOPFファイルの再生成が実行できます。 通常は書誌情報を更新する毎にOPFファイルへのバックアップが自動的に 行われるため、このコマン ドを実行する必要はありません。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --all 通常このコマンドは、古くなったOPFファイルに対してのみ実行されます。このオプションを 指定すると、すべての本に対して実行されます。
CLONE
calibredb clone path/to/new/library 現在のライブラリの複製を作成します。現在のライブラリと 列、仮想ライブラリ、その他の設定が 同じである、新しい空の ライブラリが作成されます。 複製されたライブラリに本は含まれません。すべての本を含む複製を 作成したい場合には、単にラ イブラリのフォルダをコピーしてください。 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces"
EMBED_METADATA
calibredb embed_metadata [options] book_id Calibreライブラリ内に保存されている電子書籍ファイルの書誌情報を Calibreデータベースの書誌 情報で更新します。 通常、電子書籍ファイルの書誌情報の更新は、エクスポート時のみ 行われます が、このコマンドはすぐに更新を行いたい場合に便利です。 ファイルフォーマット毎にサポートす る書誌情報のフィールドが 異なることに留意ください。 book_id に特別な値 'all' を指定する と、すべての本が更新されます。 また、スペース区切りで複数のidを指定すること、ハイフン区切 りで 範囲を指定することができます。 例: calibredb embed_metadata 1 2 10-15 23 スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --only-formats, -f 指定したフォーマットのファイルのみ書誌情報を更新します。複数のフォーマットを指定す る場合は、オプションを複数回指定してください。デフォルトでは、すべてのフォーマット が更新されます。
SEARCH
calibredb search [options] search expression 検索条件を指定してライブラリを検索し、結果を本のIDのカンマ区切りリストで返します。 出力さ れた結果は、本のIDを引数にとる他のコマンドの入力として 使用するのに便利です。 以下のようにCalibreの強力な検索用言語が使用できます。例: author:asimov title:robot スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってくださ い。例: "/some path/with spaces" --limit, -l 返却する最大結果数。デフォルトはすべての結果。
AUTHOR
Kovid Goyal
COPYRIGHT
Kovid Goyal