共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

マニュアル・ページへのリンクを作成するには

    <link> 要素を次のように使用します。

       
    <link manpage Man>text<¥link> 

    特定のセクションからマニュアル・ページを要求するには、hyperlink パラメータを次のように使用します。

       
    <link hyperlink="section manpage" Man>text<¥link> 

マニュアル・ページへのリンクの場合、hyperlink パラメータは、端末エミュレータ・ウィンドウで man コマンドを実行するときに入力するのと同じ文字列です。


注 -

アプリケーション用のヘルプを記述していて、マニュアル・ページへのリンクを指定する場合、そのアプリケーションはマニュアル・ページに対する特別なサポートを指定していなければなりません。詳細は、「マニュアル・ページを表示するには」を参照してください。(デスクトップのヘルプ・ビューアでは、マニュアル・ページへのリンクがサポートされています。)


次の例は、grep コマンドのマニュアル・ページを表示するリンクです。

Refer to the <link grep Man> grep(1)<¥link> command.

「Man」 は <link> 要素へのキーワードです。ですから、man コマンドのマニュアル・ページを表示するリンクを作成する場合は、必ず hyperlink パラメータを使用してください。

Refer to the <link hyperlink="man" Man>man(1)<¥link> command.

特定のセクションにマニュアル・ページを表示するには、マニュアル・ページ名の前にセクション番号を付けます。次のリンクは、セクション 2 から「mkdir」マニュアル・ページを表示します (セクション 1 の同じ名前のマニュアル・ページとは異なります)。

Refer to the <link hyperlink= "2 mkdir" Man>mkdir(2)<¥link> command.

関連項目