Man page - help2man(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl vi nb eo ko ta da hu sv hr ja uk fi ru ro sr el zh_CN de

Manual

HELP2MAN

名 前
書 式
説 明
イ ン ク ル ー ド フ ァ イ ル
入 手 先
作 者
バ グ の 報 告
著 作 権
関 連 項 目

名 前

help2man - 簡 易 マ ニ ュ ア ル ペ ー ジ の 生 成

書 式

help2man [ OPTION ]... EXECUTABLE

説 明

‘help2man’ は ‘--help’ お よ び ‘--version’ の 出 力 を 元 に マ ニ ュ ア ル ペ ー ジ を 生 成 す る 。

引 数 EXECUTABLE に は 、 マ ニ ュ ア ル 作 成 の 対 象 と す る コ マ ン ド を 指 定 す る 。
-n , --name = STRING

「 名 前 」 セ ク シ ョ ン で 使 う コ マ ン ド の 短 い 説 明

-s , --section = SECTION

マ ニ ュ ア ル ペ ー ジ が 所 属 す る セ ク シ ョ ン の 番 号 (1, 6, 8)

-m , --manual = TEXT

マ ニ ュ ア ル の 種 類 (ユ ー ザ コ マ ン ド , ...)

-S , --source = TEXT

プ ロ グ ラ ム の 出 自 (FSF, Debian, ...)

-L , --locale = STRING

ロ ケ ー ル を 選 択 す る (デ フ ォ ル ト は "C")

-i , --include = FILE

‘FILE’ か ら 原 稿 を 取 り 込 む

-I , --opt-include = FILE

‘FILE’ が 存 在 し た 場 合 ‘FILE’ か ら 原 稿 を 取 り 込 む

-o , --output = FILE

‘FILE’ へ 出 力 を 送 る

-p , --info-page = TEXT

Texinfo マ ニ ュ ア ル の 名 前

-N , --no-info

Texinfo マ ニ ュ ア ル の 紹 介 を 省 略 す る

-l , --libtool

プ ロ グ ラ ム 名 か ら ‘lt-’ を 取 り 除 く

--help

簡 単 な 使 い 方 を 表 示 し 終 了 す る

--version

バ ー ジ ョ ン 番 号 を 表 示 し 終 了 す る

マ ニ ュ ア ル 作 成 の 対 象 に な る コ マ ン ド は 、 --help や --version と い う オ プ シ ョ ン を 受 け 入 れ て 、 標 準 出 力 に メ ッ セ ー ジ を 表 示 す る よ う に な っ て い る べ き で あ る 。 も っ と も 、 以 下 の オ プ シ ョ ン を 使 え ば 、 --help や --version に 相 当 す る 別 の オ プ シ ョ ン を 指 定 す る こ と が 可 能 だ 。
-h , --help-option = STRING

ヘ ル プ 表 示 オ プ シ ョ ン の 文 字 列

-v , --version-option = STRING

バ ー ジ ョ ン 表 示 オ プ シ ョ ン の 文 字 列

--version-string = STRING

バ ー ジ ョ ン と し て 表 示 す る 文 字 列

--no-discard-stderr

オ プ シ ョ ン の 出 力 を 解 析 す る と き に 標 準 エ ラ ー 出 力 を 含 め る

イ ン ク ル ー ド フ ァ イ ル

--include や --opt-include オ プ シ ョ ン を 使 用 す る と 、 生 成 す る 出 力 に 追 加 の 原 稿 を 取 り 込 む こ と が で き る 。 フ ァ イ ル の 書 式 は 単 純 で あ る 。

[セ ク シ ョ ン ]
本 文

/パ タ ー ン /
本 文

本 文 は *roff の テ キ ス ト で あ り 、 出 力 中 の 、 指 定 さ れ た [ セ ク シ ョ ン ] (大 文 字 ・ 小 文 字 は 区 別 さ れ な い ) の 先 頭 部 分 や / パ タ ー ン / . に マ ッ チ す る パ ラ グ ラ フ の 直 後 に 、 そ の ま ま の 形 で 挿 入 さ れ る 。

パ タ ー ン に は Perl の 正 規 表 現 の 文 法 を 使 用 す る 。 修 飾 子 の i , s , m を 後 に 付 け る こ と も で き る ( perlre (1) を 参 照 )。

最 初 の セ ク シ ョ ン や パ タ ー ン よ り 前 に あ る 行 で 、 ’-’ で 始 ま っ て い る 行 は 、 オ プ シ ョ ン と し て 処 理 さ れ る 。 そ れ 以 外 は 、 何 も せ ず に 無 視 さ れ る の で コ メ ン ト や RCS の キ ー ワ ー ド な ど に 使 用 す る こ と が で き る 。

セ ク シ ョ ン の 出 力 順 序 :

名 前
書 式
説 明
オ プ シ ョ ン
そ の 他
環 境 変 数
フ ァ イ ル
例
作 者
バ グ の 報 告
著 作 権
関 連 項 目

イ ン ク ル ー ド フ ァ イ ル に [名 前 ] や [書 式 ] と い う セ ク シ ョ ン が あ れ ば 、 そ こ に 記 述 し た 内 容 が 、 自 動 的 に 生 成 さ れ る 内 容 の か わ り に 出 力 さ れ る 。
(も っ と も 、 ど う し て も 必 要 な ら ば 、 前 者 に つ い て は 、 --name オ プ シ ョ ン を 使 っ て 、 さ ら に 置 き 換 え る こ と が で き る が 。 )

そ れ 以 外 の セ ク シ ョ ン に つ い て は 、 上 記 の 標 準 的 な セ ク シ ョ ン の た め に 自 動 的 に 生 成 さ れ る 出 力 の 前 に 挿 入 さ れ る か 、 あ る い は 、 (上 記 の ) そ の 他 の 位 置 に 、 イ ン ク ル ー ド フ ァ イ ル 中 で 見 つ か っ た 順 番 で 取 り 込 ま れ る 。

デ フ ォ ル ト の 出 力 の 代 わ り に 、 [< section ]、 [= section ] あ る い は [> section ] と い う 文 法 を 使 う こ と で セ ク シ ョ ン 内 で の 追 加 の 原 稿 の 配 置 を 明 示 的 に 要 求 す る こ と が で き る 。 そ れ ぞ れ 追 加 の 原 稿 を 元 の 文 章 の 前 、 元 の 文 章 の 代 わ り に 、 あ る い は 元 の 文 章 の 後 に 配 置 す る 。

入 手 先

こ の 配 布 物 の 最 新 バ ー ジ ョ ン は 次 の 場 所 か ら 入 手 可 能 で あ る 。

ftp://ftp.gnu.org/gnu/help2man/

作 者

作 者 は Brendan O’Dea <bod@debian.org> で あ る 。

バ グ の 報 告

バ グ を 発 見 し た 場 合 は <bug-help2man@gnu.org> に 報 告 さ れ た い 。

著 作 権

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

関 連 項 目

help2man の 完 全 な マ ニ ュ ア ル は Texinfo マ ニ ュ ア ル と し て 整 備 さ れ て い る 。 も し 、 info お よ び help2man の プ ロ グ ラ ム が 正 し く イ ン ス ト ー ル さ れ て い る な ら ば 、 コ マ ン ド

info help2man

を 使 用 す る と 完 全 な マ ニ ュ ア ル を 読 む こ と が で き る は ず だ 。