Man page - calibredb(1)

Packages contains this manual

Available languages:

en fr mr pt_BR is es kn it ca pl vi nb sl lv pt eo ms ko fa eu et nl ar da cs gl tr zh_HK sk hu bg sv hr ja he lt uk fi ru ro zh_TW sr ka el zh_CN de

Manual

CALIBREDB

NAME
全 局 选 项
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
FTS_INDEX
FTS_SEARCH
AUTHOR
COPYRIGHT

NAME

calibredb - calibredb

calibredb command [options] [arguments]

calibredb 是 calibre数 据 库 的 命 令 行 接 口 。 它 有 几 个 子 命 令 ， 记 录 如 下 。

calibredb 可 以 用 来 操 作 一 个 calibre 数 据 库 由 运 行 在 上 的 calibre 或 calibre“内 容 服 务 器 ”指 定 本 地 机 器 或 通 过 互 联 网 。 你 可 以 运 行 一 个 calibre “内 容 服 务 器 ”使 用 ： calibre-server`程 序 或 在 主 calibre 程 序 中 单 击 “连 接 /共 享 -> 启 动 内 容 服 务 器 ”。 因 为 `calibredb 可 以 更 改 calibre 书 库 ， 必 须 首 先 在 服 务 器 上 设 置 身 份 验 证 。 这 里 有 两 种 方 法 ：

•

如 果 您 计 划 只 连 接 到 运 行 在 同 一 台 计 算 机 上 的 服 务 器 ， 则 只 需 使 用 内 容 服 务 器 的 --enable-local-write 选 项 ， 允 许 本 地 计 算 机 上 运 行 的 任 何 程 序 ， 包 括 calibredb， 对 calibre 数 据 进 行 更 改 。 从 主 calibre 程 序 运 行 服 务 器 时 ， 此 选 项 位 于 “首 选 项 ->通 过 网 络 共 享 ->高 级 ”。

•

如 果 要 启 用 通 过 互 联 网 的 访 问 ， 则 应 在 服 务 器 上 设 置 用 户 帐 户 ， 并 使 用 ： 选 项 ： --username 和 ： 选 项 ： --password ， 命 令 ： calibredb 选 项 授 予 访 问 权 限 。 您 可 以 为 命 令 ： calibre-server 设 置 用 户 身 份 验 证 ， 方 法 是 使 用 --enable-auth 选 项 并 使 用

--manage-users 创 建 用 户 帐 户 。 如 果 从 主 calibre 程 序 运 行 服 务 器 ， 请 使 用 ：

“首 选 项 ->通 过 网 络 共 享 ->需 要 用 户 名 /密 码 ”。

要 连 接 到 正 在 运 行 的 内 容 服 务 器 ， 请 将 服 务 器 的 URL传 递 给 ： --with-library 选 项 ， 有 关 详 细 信 息 和 示 例 ， 请 参 阅 该 选 项 的 文 档 。

•

全 局 选 项

•

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

•

fts_index

•

fts_search

全 局 选 项

--help, -h

显 示 此 帮 助 信 息 并 退 出

--library-path, --with-library

calibre 书 库 的 路 径 。 默 认 是 使 用 存 储 在 设 置 中 的 路 径 。 您 还 可 以 连 接 到 calibre 内 容 服 务 器 ， 以 便 在 远 程 书 库 上 执 行 操 作 。 为 此 使 用 此 格 式 的 URL： - http://hostname:port/#library_id 。 例 如 ， - http://localhost:8080/#mylibrary 。 library_id是 要 在 内 容 服 务 器 上 连 接 的 书 库 的 书 库 id。 您 可 以 使 用 特 殊 的 library_id值 - 来 获 得 服 务 器 上 可 用 书 库 id的 列 表 。 有 关 如 何 通 过 内 容 服 务 器 设 置 访 问 的 详 情 ， 请 参 阅 https://manual.calibre-ebook.com/generated/en/calibredb.html。

--password

连 接 到 calibre 内 容 服 务 器 的 密 码 。 若 要 从 标 准 输 入 读 取 密 码 ， 请 使 用 特 殊 值 ： <stdin>。 若 要 从 文 件 读 取 密 码 ， 请 使 用 <f:/path/to/file>（ 即 <f:后 跟 文 件 的 完 整 路 径 和 尾 随 >） 。 上 面 的 角 括 号 是 必 需 的 ， 记 住 要 转 义 它 们 ， 或 者 使 用 引 号 。

--timeout

通 过 网 络 连 接 到 calibre书 库 时 的 超 时 时 间 ， 以 秒 为 单 位 。 默 认 值 为 两 分 钟 。

--username

用 于 连 接 到 内 容 服 务 器 的 用 户 名

--version

显 示 程 序 版 本 号 并 退 出

LIST

calibredb list [options]

列 出 calibre 数 据 库 中 可 用 书 籍 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/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, template, timestamp, title, uuid 默 认 值 ： title,authors。 特 殊 字 段 “all”可 用 于 选 择 所 有 字 段 。 除 了 上 述 内 置 字 段 之 外 ， 还 可 以 通 过 *field_name (检 索 名 )选 择 自 定 义 字 段 ， 例 如 ， 对 于 自 定 义 字 段 #rating， 使 用 名 称 ： *rating

--for-machine

以 JSON 格 式 输 出 ， 更 适 合 机 器 解 析 。 会 导 致 忽 略 每 行 长 度 和 分 隔 符 选 项 。

--limit

显 示 的 最 大 结 果 数 。 默 认 ： 全 部

--line-width, -w

输 出 中 的 单 行 宽 度 最 大 值 。 默 认 为 检 测 到 的 屏 幕 大 小 。

--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, template, timestamp, title, uuid 默 认 值 ： id

--template

字 段 列 表 中 出 现 " template " 时 要 运 行 的 模 板 。 请 注 意 ， 在 连 接 到 calibre 服 务 器 时 ， 模 板 将 被 忽 略 。 默 认 值 ： 无

--template_file, -t

如 果 " template " 在 字 段 列 表 中 ， 则 包 含 要 运 行 的 模 板 的 文 件 的 路 径 。 默 认 值 ： 无

--template_heading

模 板 栏 的 标 题 。 默 认 值 template. 如 果 设 置 了 选 项 :option: --for-machine ， 则 忽 略 此 选 项

ADD

calibredb add [选 项 ] file1 file2 file3 ...

将 指 定 文 件 当 做 书 籍 添 加 到 数 据 库 。 你 可 以 指 定 目 录 ， 请 查 看 下 面 目 录 相 关 选 项 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--authors, -a

设 置 已 添 加 书 籍 的 作 者

--automerge, -m

如 果 找 到 具 有 类 似 书 名 和 作 者 的 书 籍 ， 自 动 将 输 入 格 式 (文 件 )合 并 到 现 有 书 籍 记 录 中 。 值 “Ignore”表 示 丢 弃 重 复 的 格 式 。 值 “overwrite”表 示 书 库 中 的 重 复 格 式 将 被 新 添 加 的 文 件 覆 盖 。 值 “new_record”表 示 将 重 复 的 格 式 放 入 新 的 书 籍 记 录 中 。

--cover, -c

设 置 已 添 加 书 籍 的 封 面 路 径

--duplicates, -d

即 使 已 经 存 在 ， 也 添 加 书 籍 到 数 据 库 中 。 根 据 书 名 和 作 者 进 行 比 较 。 请 注 意 ， :option:
`
--automerge`选 项 优 先 。

--empty, -e

添 加 空 白 书 籍 (无 格 式 书 籍 )

--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

假 设 每 个 文 件 夹 只 有 一 本 逻 辑 书 籍 ， 并 且 其 中 的 所 有 文 件 都 是 该 书 籍 的 不 同 格 式

--recurse, -r

递 归 处 理 文 件 夹

REMOVE

calibredb remove ids

从 数 据 库 删 除 指 定 id的 书 籍 。 id为 以 逗 号 分 隔 的 id 号 列 表 （ 你 可 以 使 用 搜 索 命 令 来 获 得 id 号 ） 。 例 如 ， 23,34,57-85（ 如 果 指 定 一 个 区 间 ， 该 区 间 的 最 后 一 个 数 字 不 会 被 包 括 在 内 ） 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--permanent

不 要 使 用 回 收 站

ADD_FORMAT

calibredb add_format [options] id ebook_file

将 ebook_file中 的 电 子 书 添 加 到 由 id标 识 的 书 籍 的 可 用 格 式 中 。 您 可 以 使 用 搜 索 命 令 获 取 id。 如 果 格 式 已 经 存 在 ， 则 替 换 它 ， 除 非 指 定 了 不 替 换 选 项 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--as-extra-data-file

将 文 件 作 为 额 外 的 数 据 文 件 而 不 是 电 子 书 格 式 添 加 到 书 籍 中

--dont-replace

如 果 格 式 已 经 存 在 不 要 替 换 它

REMOVE_FORMAT

calibredb remove_format [options] id fmt

从 ID标 识 的 逻 辑 书 籍 中 删 除 特 定 格 式 - fmt。 你 可 以 通 过 使 用 搜 索 命 令 获 取 id。 fmt 应 该 是 形 如 LRF或 TXT或 EPUB的 一 个 文 件 扩 展 名 。 如 果 逻 辑 书 籍 没 有 fmt 可 用 则 什 么 也 不 做 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

SHOW_METADATA

calibredb show_metadata [options] id

显 示 在 calibre 数 据 库 中 存 储 的 指 定 id的 书 籍 的 元 数 据 。 id是 来 自 搜 索 命 令 的 id号 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--as-opf

以 OPF格 式 (XML)打 印 元 数 据

SET_METADATA

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

根 据 OPF 文 件 --metadata.opf 设 置 存 储 在 calibre 数 据 库 中 的 以 book_id 标 识 的 书 籍 的 元 数 据 。 book_id 是 来 自 搜 索 命 令 的 id 号 。 您 可 以 通 过 使 用 --as-opf 切 换 到 show_metadata 命 令 来 快 速 了 解 OPF 格 式 。 还 可 以 用 --field 选 项 设 置 各 个 字 段 的 元 数 据 。 如 果 使 用 --field 选 项 则 不 需 要 指 定 OPF 文 件 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--field, -f

设 置 字 段 。 格 式 是 field_name:value， 例 如 ： --field tags:tag1,tag2。 使 用 :option: --list-fields`来 获 取 所 有 字 段 名 称 的 列 表 。 你 可 以 多 次 指 定 此 选 项 来 设 置 多 个 字 段 。 注 意 ： 对 于 语 言 ， 你 必 须 使 用 ISO639语 言 代 码 （ 例 如 en代 表 英 文 ， fr代 表 法 语 等 ） 。 对 于 书 籍 标 识 符 ， 语 法 是 :option: --field` identifiers:isbn:XXXX,doi:YYYYY。 对 于 布 尔 (是 /否 )字 段 使 用 true 和 false 或 者 yes 和 no。

--list-fields, -l

列 出 可 用 于 --field 选 项 的 元 数 据 字 段 名 称

EXPORT

calibredb export [options] ids

导 出 指 定 id(以 逗 号 分 隔 的 列 表 )的 书 籍 至 文 件 系 统 。 导 出 操 作 将 保 存 书 籍 的 所 有 格 式 ， 以 及 其 封 面 和 元 数 据 (保 存 至 一 个 opf文 件 )。 也 会 保 存 与 书 籍 相 关 联 的 任 何 额 外 的 数 据 文 件 。 你 可 以 使 用 搜 索 命 令 来 获 得 id。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

--all

导 出 数 据 库 中 所 有 的 书 籍 ， 忽 略 列 表 中 的 id。

--dont-asciiize

让 calibre将 文 件 名 中 的 所 有 非 英 文 字 符 转 换 成 英 文 对 应 字 符 。 如 果 保 存 到 不 完 全 支 持 Unicode文 件 名 的 旧 文 件 系 统 中 ， 这 将 非 常 有 用 。 设 定 此 项 将 关 闭 此 操 作 。

--dont-save-cover

通 常 ， calibre将 把 封 面 保 存 为 单 独 文 件 ， 和 电 子 书 文 件 一 起 生 成 。 设 定 此 项 将 关 闭 此 操 作 。

--dont-save-extra-files

保 存 书 籍 时 保 存 与 书 籍 关 联 的 所 有 数 据 文 件 设 定 此 项 将 关 闭 此 操 作 。

--dont-update-metadata

通 常 ， calibre将 根 据 calibre书 库 中 的 信 息 更 新 保 存 的 文 件 的 元 数 据 。 这 会 使 保 存 到 硬 盘 变 慢 一 些 。 设 定 此 项 将 关 闭 此 操 作 。

--dont-write-opf

通 常 ， calibre 将 会 把 元 数 据 写 入 单 独 的 OPF 文 件 ， 和 电 子 书 文 件 一 起 生 成 。 设 定 此 项 将 关 闭 此 操 作 。

--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 extension 指 定 的 格 式 导 出 书 目 。 选 项 控 制 项 目 在 生 成 的 书 目 中 的 显 示 方 式 。 请 注 意 ， 不 同 的 书 目 格 式 支 持 不 同 的 选 项 。 要 查 看 不 同 的 选 项 ， 请 指 定 输 出 文 件 的 名 称 ， 然 后 指 定 --help选 项 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--ids, -i

要 编 目 的 逗 号 分 割 的 数 据 库 ID 列 表 。 一 旦 声 明 ， 则 忽 略 --search 选 项 默 认 值 ： all

--search, -s

按 搜 索 查 询 筛 选 结 果 。 搜 索 查 询 格 式 请 参 见 用 户 手 册 中 搜 索 相 关 内 容 。 默 认 ： no filtering

--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> ' , ' 标 签 ' , ' <comma-separated list of tags> ' ) 或 ( ' <rule name> ' , ' <custom column> ' , ' <pattern> ' )。 例 如 ： (( ' 存 档 的 书 籍 ' , ' #status '' , ' 已 存 档 ' ),) 将 在 自 定 义 栏 目 “status ' ”中 排 除 值 为 “已 存 档 ”的 书 籍 。 定 义 多 个 规 则 时 ， 将 应 用 所 有 规 则 。 默 认 : " (( ' Catalogs ' , ' Tags ' , ' Catalog ' ),) " 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-authors

书 目 中 包 括 “作 者 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-descriptions

书 目 中 包 括 “描 述 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-genres

书 目 中 包 括 “类 型 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-recently-added

书 目 中 包 括 “入 库 日 期 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-series

书 目 中 包 括 “丛 书 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--generate-titles

书 目 中 包 括 “书 名 ”部 分 。 默 认 值 ： ' False ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--genre-source-field

“类 型 ”部 分 的 源 字 段 。 默 认 值 ： ' 标 签 ' 适 用 于 ： AZW3, EPUB, MOBI 输 出 格 式

--header-note-source-field

包 含 要 插 入 到 描 述 的 头 部 位 置 的 批 注 文 本 的 自 定 义 字 段 。 默 认 值 : '' 适 用 于 : 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

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

ADD_CUSTOM_COLUMN

calibredb add_custom_column [options] label name datatype

创 建 一 个 自 定 义 栏 目 ， 栏 目 名 为 你 自 定 义 的 名 称 ， 不 能 包 含 空 格 或 冒 号 。 数 据 类 型 可 为 ： bool, comments, composite, datetime, enumeration, float, int, rating, series, text

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--display

用 于 自 定 义 如 何 解 释 此 栏 目 中 的 数 据 的 选 项 的 字 典 。 这 是 一 个 JSON 字 符 串 。 对 于 枚 举 栏 目 ， 使 用 --display " {\ " enum_values\ " :[\ " val1\ " , \ " val2\ " ]} " 有 许 多 选 项 可 以 进 入 显 示 变 量 ， 按 栏 目 类 型 的 选 项 是 ： 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 找 到 适 当 组 合 的 最 好 方 法 是 在 图 形 界 面 中 创 建 适 当 类 型 的 自 定 义 栏 目 ， 然 后 查 看 书 籍 的 备 份 OPF（ 确 保 自 从 添 加 该 栏 目 以 后 已 经 创 建 了 新 的 OPF） 。 在 OPF 中 的 新 栏 目 中 ， 你 将 看 到 JSON 的 “显 示 ”。

--is-multiple

此 栏 目 存 储 类 似 标 签 的 数 据 (例 如 ， 多 个 逗 号 分 隔 的 值 )。 仅 当 数 据 类 型 为 文 本 时 才 适 用 。

CUSTOM_COLUMNS

calibredb custom_columns [options]

列 出 可 用 的 自 定 义 栏 目 。 显 示 栏 目 标 签 和 id。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--details, -d

显 示 每 个 栏 目 的 详 情 。

REMOVE_CUSTOM_COLUMN

calibredb remove_custom_column [options] label

删 除 由 标 签 标 识 的 自 定 义 栏 目 。 可 以 使 用 custom_columns command命 令 查 看 可 用 栏 目 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--force, -f

无 需 确 认

SET_CUSTOM

calibredb set_custom [options] column id value

为 id 标 识 的 书 籍 设 置 自 定 义 栏 目 的 值 。 您 可 以 使 用 搜 索 命 令 获 取 id列 表 。 您 可 以 使 用 custom_columns 命 令 获 取 自 定 义 栏 目 名 的 列 表 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--append, -a

如 果 栏 目 可 以 有 多 个 值 ， 将 指 定 值 添 加 到 已 有 值 之 后 ， 而 非 覆 盖 已 有 值 。

RESTORE_DATABASE

calibredb restore_database [options]

从 calibre书 库 每 个 文 件 夹 中 的 OPF文 件 含 有 的 元 数 据 恢 复 此 数 据 库 ， 如 果 你 的 metadata.db文 件 已 损 坏 ， 此 方 法 很 有 用 。

警 告 ： 此 命 令 会 完 全 重 新 生 成 数 据 库 。 你 会 丢 失 所 有 搜 索 记 录 ， 自 定 义 分 类 ， 元 数 据 处 理 规 则 ， 已 保 存 的 每 本 书 的 转 换 设 置 和 自 定 义 的 新 闻 获 取 规 则 。 恢 复 的 元 数 据 和 OPF文 件 中 的 一 样 准 确 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/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

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--csv, -c

以 CSV 输 出

--ignore_extensions, -e

逗 号 分 隔 的 将 被 忽 略 的 扩 展 名 列 表 。 默 认 值 ： all

--ignore_names, -n

逗 号 分 隔 的 将 被 忽 略 的 名 称 列 表 。 默 认 值 ： all

--report, -r

逗 号 分 隔 的 报 告 列 表 。 默 认 值 : all

--vacuum-fts-db

清 空 全 文 搜 索 数 据 库 。 根 据 数 据 库 的 大 小 ， 这 可 能 会 非 常 慢 并 且 占 用 大 量 内 存 。

LIST_CATEGORIES

calibredb list_categories [options]

在 数 据 库 中 生 成 一 个 类 别 信 息 的 报 告 。 该 信 息 与 分 类 浏 览 器 中 显 示 的 信 息 相 同 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--categories, -r

逗 号 分 隔 类 别 列 表 检 索 名 。 默 认 值 ： 全 部

--csv, -c

以 CSV 输 出

--dialect

产 生 CSV文 件 的 类 型 。 选 择 ： excel, excel-tab, unix

--item_count, -i

只 输 出 每 个 类 别 中 的 项 (标 签 、 作 者 等 )的 数 目 ， 而 不 是 类 别 内 的 每 项 包 含 的 书 籍 数

--width, -w

输 出 中 的 单 行 宽 度 最 大 值 。 默 认 为 检 测 到 的 屏 幕 大 小 。

BACKUP_METADATA

calibredb backup_metadata [options]

将 存 储 在 数 据 库 中 的 元 数 据 备 份 到 每 个 书 籍 文 件 夹 中 的 单 个 OPF 文 件 中 。 这 通 常 是 自 动 的 ， 但 是 您 可 以 运 行 此 命 令 来 强 制 重 新 生 成 OPF 文 件 ， 并 使 用 --all 选 项 。

请 注 意 ， 通 常 不 需 要 这 样 做 ， 因 为 每 次 元 数 据 更 改 时 ， OPF 文 件 都 会 自 动 备 份 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

--all

通 常 ， 此 命 令 只 对 OPF文 件 过 期 的 书 籍 有 效 。 这 个 选 项 使 它 在 所 有 的 书 籍 上 运 行 。

CLONE

calibredb clone path/to/new/library

创 建 当 前 书 库 的 副 本 。 这 将 创 建 一 个 新 的 、 空 的 书 库 ， 它 所 有 的 自 定 义 栏 目 、 虚 拟 书 库 和 其 他 设 置 与 当 前 书 库 相 同 。

副 本 书 库 将 没 有 任 何 书 籍 。 如 果 您 想 要 创 建 一 个 完 整 的 副 本 书 库 ， 包 括 所 有 的 书 籍 ， 那 么 只 需 使 用 您 的 文 件 系 统 工 具 来 复 制 书 库 文 件 夹 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"

EMBED_METADATA

calibredb embed_metadata [options] book_id

通 过 calibre 数 据 库 中 的 元 数 据 更 新 存 储 在 calibre 书 库 中 的 实 际 书 籍 文 件 中 的 元 数 据 。 通 常 ， 只 有 从 calibre 导 出 文 件 时 才 更 新 元 数 据 ， 如 果 希 望 文 件 就 地 更 新 ， 则 此 命 令 很 有 用 。 请 注 意 ， 不 同 的 文 件 格 式 支 持 不 同 数 量 的 元 数 据 。 你 可 以 使 用 book_id 的 特 殊 值 “all”来 更 新 所 有 书 籍 中 的 元 数 据 。 还 可 以 指 定 许 多 由 空 格 分 隔 的 书 籍 id 和 由 连 字 符 分 隔 的 ID区 间 。 例 如 ： calibredb embed_metadata 1 2 10-15 23

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--only-formats, -f

只 更 新 指 定 格 式 的 文 件 中 的 元 数 据 。 可 为 多 种 格 式 指 定 多 次 。 默 认 情 况 下 ， 所 有 格 式 都 会 更 新 。

SEARCH

calibredb search [options] search expression

搜 索 书 库 中 指 定 的 搜 索 项 ， 返 回 与 搜 索 表 达 式 匹 配 的 以 逗 号 分 隔 的 书 籍 id列 表 。 输 出 格 式 对 于 输 入 接 受 id列 表 的 其 他 命 令 非 常 有 用 。 搜 索 表 达 式 可 以 是 来 自 calibre强 大 的 搜 索 查 询 语 言 中 的 任 何 内 容 ， 例 如 ： calibredb searchauthor:asimov 'title:"i robot"'

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--limit, -l

返 回 的 最 大 结 果 数 。 默 认 是 所 有 结 果 。

FTS_INDEX

calibredb fts_index [options] enable/disable/status/reindex

控 制 全 文 搜 索 索 引 进 程 。

enable

启 用 此 书 库 的 全 文 索 引

disable

关 闭 此 书 库 的 全 文 索 引

status

显 示 当 前 索 引 的 状 态

reindex

可 用 于 重 新 索 引 特 定 书 籍 或 整 个 书 库 。 要 重 新 索 引 特 定 书 籍 请 在 reindex命 令 后 将 书 籍 id指 定 为

附 加 参 数 。 如 果 未 指 定 书 籍 id， 则 会 重 新

索 引 整 个 书 库 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--indexing-speed

索 引 的 速 度 。 使 用 fast可 使 用 所 有 计 算 机 资 源 进 行 快 速 索 引 ， 使 用 slow可 使 用 较 少 的 资 源 进 行 索 引 。 请 注 意 ， 每 次 调 用 索 引 后 ， 索 引 速 度 都 会 重 置 为 slow。

--wait-for-completion

等 待 所 有 书 籍 都 编 入 索 引 ， 定 期 显 示 索 引 进 度

FTS_SEARCH

calibredb fts_search [options] search expression

对 整 个 书 库 或 其 子 集 进 行 全 文 搜 索 。

每 当 您 将 包 含 空 格 的 参 数 传 递 给 %p程 序 时 ， 请 将 参 数 放 在 引 号 中 。 例 如 : "/some path/with spaces"
--do-not-match-on-related-words

只 匹 配 精 确 的 字 词 而 不 是 相 关 的 字 词 。 因 此 ， correction将 与 orrecting不 匹 配 。

--include-snippets

包 括 每 个 匹 配 项 相 关 的 文 本 片 段 。 请 注 意 ， 这 会 使 搜 索 速 度 慢 得 多 。

--indexing-threshold

允 许 搜 索 前 必 须 索 引 多 少 书 库 ， 以 百 分 比 表 示 。 默 认 为 90

--match-end-marker

用 于 标 示 文 本 段 内 匹 配 单 词 的 结 尾 的 标 记

--match-start-marker

用 于 标 示 文 本 段 内 匹 配 单 词 的 开 头 的 标 记

--output-format

输 出 搜 索 结 果 的 格 式 。 纯 文 本 为 “text”， JSON输 出 为 “json”。

--restrict-to

使 用 搜 索 表 达 式 或 id限 制 搜 索 的 书 籍 。 例 如 ： ids:1,2,3表 示 按 id限 制 ， 或 search:tag:foo表 示 限 制 具 有 标 签 foo的 书 籍 。

AUTHOR

Kovid Goyal

COPYRIGHT

Kovid Goyal