Manpages

名 前

install-docs - オ ン ラ イ ン Debian ド キ ュ メ ン ト の 管 理

書 式

 install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]
 install-docs [options] -I,--install-all | -C,--install-changed | -R,--remove-all
 install-docs [options] -s,--status docid [ docid ... ]
 install-docs [options] --dump-db dbname
 install-docs -h,--help | -V,--version

説 明

install-docs は 、 Debian の パ ッ ケ ー ジ メ ン テ ナ が さ ま ざ ま な ド キ ュ メ ン テ ー シ ョ ン シ ス テ ム に 、 ド キ ュ メ ン ト を 登 録 で き る よ う に す る ツ ー ル で す 。 現 在 、 dhelp, dwww, doc-central, scrollkeeper と い っ た ブ ラ ウ ザ を サ ポ ー ト し て い ま す 。 こ の マ ニ ュ ア ル ペ ー ジ で は 、 install-docs を 使 う 上 で の 、 簡 単 な 書 式 を 提 供 し て い ま す 。 コ ン ト ロ ー ル フ ァ イ ル の 構 文 や 文 法 に 説 明 と い っ た 、 完 全 な 文 書 は ド キ ュ メ ン ト に あ り ま す 。

オ プ シ ョ ン

-v, --verbose 饒 舌 に 動 作 し ま す 。
-d, --debug デ バ ッ グ 情 報 を 表 示 し ま す 。
--no-update-menus

dwww-build-menu(8), dhelp_parse(8), scrollkeeper-update(8) の 実 行 を 抑 制 し ま す 。

--rootdir dir ル ー ト デ ィ レ ク ト リ を 、 ’/’ で は な く dir に 設 定 し ま す 。 --check ア ク シ ョ ン と 共 に 使 用 し た と き の み 、 有 効 で 意 味 が あ り ま す 。

ア ク シ ョ ン

以 下 に install-docs が 扱 え る 、 有 効 な ア ク シ ョ ン を 列 挙 し ま す 。 install-docs へ は ア ク シ ョ ン オ プ シ ョ ン を ひ と つ し か 渡 せ ま せ ん 。 さ ら に 、 引 数 の あ る ア ク シ ョ ン は 、 最 後 の オ プ シ ョ ン と し て 渡 さ な け れ ば な り ま せ ん 。 各 file は 、 doc-base コ ン ト ロ ー ル フ ァ イ ル の フ ル パ ス (つ ま り ’/usr/share/doc-base/some_file’ や ’/etc/doc-base/documents/some_file’) に し て く だ さ い 。 ま た 、 各 docid は 、 ド キ ュ メ ン ト 識 別 子 (ド キ ュ メ ン ト 識 別 子 は 、 コ ン ト ロ ー ル フ ァ イ ル の ’Document’ フ ィ ー ル ド 設 定 さ れ て お り 、 通 常 パ ッ ケ ー ジ 名 と 同 じ ) に し て く だ さ い 。

file や docid が ’-’ (マ イ ナ ス 記 号 ) の 場 合 、 引 数 の リ ス ト を 標 準 入 力 (フ ァ イ ル 名 や ド キ ュ メ ン ト ID は 改 行 で 区 切 る ) か ら 読 み 込 み ま す 。
-i file [file ...], --install file [file ...] コ ン ト ロ ー ル フ ァ イ ル file に 記 述 し た ド キ ュ メ ン ト を イ ン ス ト ー ル し ま す 。
-r file [file ...], --remove file [file ...] コ ン ト ロ ー ル フ ァ イ ル file で 識 別 し た ド キ ュ メ ン ト を 削 除 し ま す 。
-c file [file ...], --check file [file ...] コ ン ト ロ ー ル フ ァ イ ル file を チ ェ ッ ク し 、 発 見 し た 問 題 の 数 を 表 示 し ま す 。 エ ラ ー や 警 告 の 実 際 の 場 所 を 得 る に は 、 --verbose と 合 わ せ て 使 用 し て く だ さ い 。 --rootdir が 与 え ら れ た 場 合 、 file の ’Files’ フ ィ ー ル ド や ’Index’ フ ィ ー ル ド が あ る と 、 そ の フ ァ イ ル 名 の 前 に 付 与 し ま す 。
-R, --remove-all 登 録 し た す べ て の ド キ ュ メ ン ト を 、 登 録 解 除 し ま す 。
-I, --install-all

/usr/share/doc-base や /etc/doc-base/documents か ら 、 す べ て の ド キ ュ メ ン ト を (再 ) 登 録 し ま す 。

-C, --install-changed

/usr/share/doc-base の 内 容 や /etc/doc-base/documents デ ィ レ ク ト リ と 、 登 録 ド キ ュ メ ン ト デ ー タ ベ ー ス と を 比 較 し 、 見 つ か ら な い フ ァ イ ル を 登 録 解 除 し た り 、 変 更 さ れ た だ け の フ ァ イ ル や 新 し い フ ァ イ ル を (再 ) 登 録 し ま す 。

-s docid [docid ...], --status docid [docid ...] ド キ ュ メ ン ト 識 別 子 docid の 状 態 を 表 示 し ま す 。
-L docid [docid ...], --listfiles docid [docid ...] 廃 止 予 定 の オ プ シ ョ ン で す 。 何 も し ま せ ん 。
--dump-db dbname デ バ ッ グ 用 に 、 内 部 デ ー タ ベ ー ス を ダ ン プ し ま す 。 dbname は files.db と status.db の い ず れ か で す 。
-h, --help 短 い ヘ ル プ メ ッ セ ー ジ を 表 示 し ま す 。
-V, --version バ ー ジ ョ ン 情 報 を 表 示 し ま す 。

互 換 性 問 題

以 下 の 機 能 は 、 バ ー ジ ョ ン 0.8.4 で 追 加 さ れ ま し た 。 パ ッ ケ ー ジ ス ク リ プ ト で 使 用 す る 場 合 は 、 適 切 な ’Conflicts’ 行 や ’Depends’ 行 を 、 確 実 に 追 加 し て く だ さ い 。

標 準 入 力 か ら の 引 数 読 み 込 み

-C, --install-changed, --dump-db, -V, --version の 各 オ プ シ ョ ン は 0.8.12 で 追 加 さ れ ま し た 。

フ ァ イ ル

/usr/share/doc-base/ さ ま ざ ま な パ ッ ケ ー ジ が 提 供 す る 、 doc-base 制 御 フ ァ イ ル の 場 所 。
/etc/doc-base/documents/ ロ ー カ ル 管 理 者 が 提 供 す る 、 doc-base 制 御 フ ァ イ ル の 場 所 。
/var/lib/doc-base/info/documents/ 登 録 さ れ た 制 御 フ ァ イ ル の 場 所 。
/var/lib/doc-base/info/status.db 登 録 さ れ た ド キ ュ メ ン ト の 状 態 。
/var/lib/doc-base/info/files.db 登 録 さ れ た doc-base フ ァ イ ル の 、 タ イ ム ス タ ン プ と ド キ ュ メ ン ト ID。
/var/lib/doc-base/omf/ 生 成 さ れ た scrollkeeper OMF フ ァ イ ル の 場 所 。 注 意 : /usr/share/omf/doc-base は 、 こ の デ ィ レ ク ト リ へ の シ ン ボ リ ッ ク リ ン ク で あ る べ き で す 。

バ グ

<http://bugs.debian.org/doc-base>; を ご 覧 く だ さ い 。

関 連 項 目

dhelp(1), doccentral(1), dwww(7), scrollkeeper(7), Debian doc-base マ ニ ュ ア ル /usr/share/doc/doc-base/doc-base.html/index.html

著 者

こ の プ ロ グ ラ ム は 、 元 々 Debian GNU/Linux シ ス テ ム 向 け に Christian Schwarz <schwarz [AT] debian.org> と 、 2代 目 メ ン テ ナ で あ る Adam Di Carlo <aph [AT] debian.org> に よ っ て 書 か れ ま し た 。 現 在 Robert Luberda <robert [AT] debian.org> が 、 保 守 と 拡 張 を 行 っ て い ま す 。 こ の ソ フ ト ウ ェ ア は 、 Debian の ユ ー ザ ・ 開 発 者 コ ミ ュ ニ テ ィ 全 体 の た め に な る よ う に 作 ら れ ま し た 。 こ の ソ フ ト ウ ェ ア に 興 味 が あ る 方 は 、 <debian-doc [AT] lists.org> メ ー リ ン グ リ ス ト に 参 加 し て く だ さ い 。