Template:Unix manual/doc

このテンプレートは、UNIXおよびUnix系コマンド記事を中心に、マニュアルサイトの外部リンクを一覧表示するために使用します。サイト移転やサイト構成変更に容易に対応可能とすることを目的としています。

使い方

書式

以下の {{ から }} までをコピーして、外部リンク節に置いてください。使わない引数は削除してもかまいません。

簡単な例

{{Unix manual|name=chroot|section=1|linuxjmn=1L}}

必須パラメータは名前と章番号です。個々の外部リンク先URLは名前と章番号から自動的に生成されます。その他のパラメータは各マニュアルサイト用パラメータで、省略可能です。

一部のUnix系OSにおいては章番号が他のものと異なるケースがあります。個々のサイト別章番号を指定すると、sectionの指定に優先してサイト別章番号を基に外部リンクのURLが生成されます。とくに、The Open Groupのサイトでは章番号に当たる部分を章番号ではなく分類名（utilityなど）とする必要があります。

大半のサイトについては、サイト別章番号を省略すると、そのサイトを外部リンクに含めます。noneを指定すると、そのサイトを一覧に含めません。英語以外のマニュアルサイトで特定のコマンドが未翻訳であるなどの事情で、デッドリンクになるのを回避したい場合にnoneを指定します。例外的に、The Open Groupについては省略時するとサイトを一覧に含めません。これは、サイト構成が章番号ベースではなく分類名ベースであるために、外部リンクURLを生成するには分類名が必須であることが理由となっています。

一部のサイトにはサイト別表示用章番号パラメータが設けられています。URLの章番号には"1"を指定したいが、表示上の章番号にはchroot(1L)のように"1L"を指定したいというケースで、このパラメータを指定します。章番号パラメータの末尾にnをつけたものとなります。

各引数の解説

{{Unix manual
<!-- 必須パラメータ -->
|name       = 名前（必須、[[tail]]など）
|section    = [[Manページ#マニュアルの章立て|マニュアルの章番号]]（必須）
<!-- サイト別章番号パラメータ -->
|opengroup  = [[The Open Group]]のマニュアルサイト（省略時、外部リンクなし）
|linuxjm    = [[Linux]]の JM Project
|macos      = [[Mac OS X]]のコミュニティサイト
<!-- サイト別表示用章番号パラメータ -->
|linuxjmn   = Linuxの JM Project
|macosn     = [[Mac OS X]]のコミュニティサイト
<!-- その他のパラメータ -->
}}

未収録サイトに関する情報

• HP-UXのマニュアルサイトは、マニュアルをHP Business Support Center (BSC)に移転しているため外部参照できない理由から、上記のサイト一覧に含めていません。

関連項目

• manページ