test

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

第 7 章 コマンドの要約

この章では、ヘルプ・コマンドが端末ウィンドウで手動で実行されるときに使用可能なコマンド行オプションを要約します。

ヘルプ・システム・コマンド

ヘルプ・システムが提供するデスクトップのアクションとデータ型により、ヘルプ・ファイルのアイコンをクリックするかメニュー項目を選択すると、実行時のヘルプ・ファイルをコンパイルしたり表示したりできます。しかし、特定のコマンド・オプションを選択する場合、端末エミュレータでコマンドを入力するか、新しいアクションを作成しなければなりません。

ヘルプのアクションとデータ型は、/usr/dt/appconfig/types/lang ディレクトリにある 2 つのファイル dthelp.dt と dthelptag.dt に定義されています。

ここで要約されているコマンドは、次のとおりです。

dthelptag

ヘルプタグのソース・ファイルを実行ファイルにコンパイルします。

dthelpview

ヘルプ・ボリューム、ヘルプ・トピック、テキスト・ファイルまたはマニュアル・ページを表示します。

dthelpgen

各ファミリ・ファイルのエントリが入っている新しいヘルプ・ボリューム browser.hv にヘルプ・ファミリ・ファイルを格納します。

ヘルプタグ・ファイルの処理 (dthelptag)

ヘルプタグ・ソフトウェアは dthelptag コマンドで起動され、ヘルプタグのソース・ファイルを実行時のヘルプ・ファイルにコンパイルします。volume.htg ファイルがあるディレクトリで dthelptag を実行してください。

コマンド形式

dthelptag  [command-options]  volume  [parser-options]

command-options は、volume 名の前に入力されるオプションで、parser-options は volume 名の後に入力されるオプションです。

コマンド・オプション

-clean

指定の volume のためにヘルプタグを以前に実行したときに作成されたすべてのファイルを削除します。

-shortnames

作成されたすべてのファイル名を、ベース名は 8 文字まで、拡張子は 3 文字までにそれぞれ制限します。これにより、実行時のヘルプ・ファイルを長い名前がサポートされていないシステムに移植できます。

-verbose

dthelptag コマンドの経過状況を表示し、発生したパーサ・エラーをすべて表示します。パーサ・エラーは volume.err という名前のファイルに保存されます。

-formal

正規パーサを使用して、SGML 準拠マークアップでタグが付けられたヘルプ・ファイルを解釈します。このオプションを指定しない場合、dthelptag は入力ファイルに簡易マークアップが記述されているものと判断します。

2 種類のマークアップ (簡易マークアップと正規マークアップ) があるため、ファイル拡張子を使用してその種類を識別するようにしてください。簡易マークアップには .htg を、正規マークアップには .ctg を使用してください。

パーサ・オプション

パーサ・オプションは volume 名の後に入力され、parser に直接渡されます。この parser は、マークアップ・ファイルを実行時のファイルに変換するヘルプタグ・ソフトウェアの一部です。

これらのオプションは次の方法で使用できます。

コマンド行に入力されたオプションは、別の方法を使用して設定されたオプションを無効にします。

onerror

パーサ・エラーが発生した場合に、dthelptag コマンドを続行すべきかどうかを指定します。デフォルトは onerror=stop で、これによりパーサ・エラーが 1 つでも発生するとコマンドは停止します。onerror=go を指定すると、処理は続行されますが、作成された実行時のヘルプ・ファイルが正しく動作しない可能性があります。

charset

テキストファイルを記述するのに使用された文字セットを指定します。ヘルプ・トピックが適切なフォントで表示されるようにするには文字セット名が正しくなければなりません。デフォルトは charset=ISO-8859-1 です。

LanguageElementDefaultCharset という名前のエンティティを宣言してヘルプ・ボリューム内の文字セットを指定することもできます。

/usr/dt/dthelp/dthelptag/helplang.ent ファイルには、このエンティティの宣言が記述されています。サポートされている文字セットのリストについては、第 14 章「母国語のサポート」を参照してください。

search

参照されたファイル・エンティティを探すために検索されるディレクトリのリストに別のディレクトリを追加します。複数のディレクトリを指定するには、複数の search=directory オプションを使用してください。検索オプションが使用されていない場合は、現在のディレクトリだけが検索されます。

clearsearch

検索ディレクトリのリストを無視します。このオプションは、helptag.opt ファイルに指定された検索オプションを無効にする場合にコマンド行で有効です。

memo

設計者のメモ (<memo> 要素を使用して入力される) を取り込みます。デフォルトは nomemo で、これはヘルプタグがメモを無視するようにします。

nomemo

ヘルプタグが設計者のメモ (<memo> 要素で入力される) を無視するようにします。これがデフォルトです。

関連項目

ヘルプ・トピックの表示 (dthelpview)

dthelpview コマンドは、ヘルプ・ボリューム、個々のヘルプ・トピック、テキスト・ファイル、またはマニュアル・ページを表示するために使用できます。

コマンド形式

ヘルプ・ビューアを起動するには、次のいくつかの方法があります。

-helpVolume volume

表示したい volume.sdl ファイル名を指定します。ボリュームが現在のディレクトリになく、ボリュームが登録されていない場合はパス名が必要です。

-locationId id

ID を指定します。dthelpview は、id が入っているトピックを表示します。ID を指定しない場合、ヘルプ・ビューアはデフォルトとして _hometopic を使用します。

-man

表示するマニュアル・ページを要求するダイアログを表示してから、要求されたマニュアル・ページを表示します。

-manPage man

特定のマニュアル・ページが表示されるように指定します。

-file filename

特定のテキスト・ファイルが表示されるように指定します。

デフォルトの volume と id は dthelpview の app-defaults ファイルである /usr/dt/app-defaults/lang/Dthelpview に設定できます。lang にはロケール名が入ります。

関連項目

ブラウザ・ヘルプ・ボリュームの作成 (dthelpgen)

dthelpgen ユーティリティは、フロントパネルの [ヘルプ・ビューア] を使用してシステムに登録されたヘルプ・ボリュームを表示できるようにする特殊なヘルプ・ボリュームを作成します。フロントパネルの [ヘルプ・ビューア] コントロールを最初にクリックすると、dthelpgen は自動的に実行されます。ヘルプ検索パス・ディレクトリ (ローカルな、またはネットワーク化されたディレクトリ) を検索してヘルプ・ファミリ・ファイルを位置付け、次にユーザの HomeDirectory/.dt/help/$DTUSERSESSION ディレクトリにブラウザ・ボリューム (browser.hv) を作成します。いったん作成されると、ボリュームは次のアクションのどれかに応じて更新されます。

コマンド形式

dthelpgen -dir [options]
-dir

ブラウザ・ボリュームと中間ファイルを格納するディレクトリを指定します。これは、必須のパラメータです。

オプション

-generate

システム上のファミリ・ファイルとヘルプ・ボリュームが変更されていない場合でも、新しいブラウザ・ヘルプ・ボリュームが作成されるように指定します。

-file basename

dthelpgen が作成したヘルプ・ボリュームと中間ファイルの名前を指定します。デフォルトは、browser.hv です。

-lang

どの言語ディレクトリのヘルプ・ファミリとヘルプ・ボリュームを検索するかを指定します。-lang オプションを設定すると、LANG 環境変数の現在値よりも優先されます。

注 -

ブラウザ・ボリュームがヘルプ・ウィンドウに表示されている間に dthelpgen を実行する場合、ウィンドウを閉じてからブラウザ・ボリュームをもう一度開いてください。

関連項目