# コマンドの要約

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

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

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

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

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

`dtDocBook` | DocBook のソース・ファイルを実行ファイルにコンパイルします。
`dthelpview` | ヘルプ・ボリューム、ヘルプ・トピック、テキスト・ファイルまたはマニュアル・ページを表示します。
`dthelpgen` | 各ファミリ・ファイルのエントリが入っている新しいヘルプ・ボリューム `index.hv` にヘルプ・ファミリ・ファイルを格納します。

## DocBook ファイルの処理 (dtdocbook)

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

### コマンド形式

    dtdocbook [command-options] volume

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

### コマンド・オプション

`-c` | 既存の SDL ファイルを圧縮します。入力ファイルの拡張子は、“`.sdl`” であることを仮定します。
`-d` | 既存の SDL ファイルを伸張します。入力ファイルの拡張子は、“`.sdl`” であることを仮定します。
`-h` | (ヘルプ) `dtdocbook` コマンドの形式およびオプションのリストを、標準出力に表示します。
`-l` | ログを `basename.log` に出力します。
`-m` | (マップ) 追加の SDATA および／または文字のマッピング・ファイルを追加します。
`-o` `file` | `file` を出力ファイル名として使用します。ファイル名に拡張子を付けてはいけません。
`-r` | すべての中間ファイルおよび出力ファイルを削除します。それらが存在しない場合でも、通知はしません。
`-u` | (非圧縮) 翻訳中、出力ファイルの圧縮を行いません。
`-v` | (饒舌) `dtdocbook` の処理中にパーサのメッセージを生成、表示します。

`-c` オプションが指定され、ファイルがすでに圧縮されている場合は、ファイルは伸張されてから、再度圧縮されます。この処理は、圧縮された SDL ファイルの統合性を検証する手段として有用です。

`-d` オプションが指定され、ファイルがすでに伸張されている場合は、再度の解析、すべての前計算の実行が行われ、ファイルは再度書き込まれます。この処理は、SDL ファイルの統合性を検証する手段として有用です。また、たとえば SDL ファイルを直接編集したことによって、再計算が必要になったとき、個々のヘルプ・トピックのバイト・オフセットを含む目次の再計算を強制的に実行させる場合にも有用です。

#### 関連項目

- HRDC.CrHV.mkr.2

- HRDC.Inst.mkr.5

- HRDC.CrHV.mkr.6

- `dtdocbook`(1) マニュアル・ページ

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

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

### コマンド形式

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

- `dthelpview -helpVolume volume [ -locationId id ]`

- `dthelpview -man`

- `dthelpview -manPage` man

- `dthelpview -file` filename

オプションの機能を次に示します。

`-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/C/Dthelpview` に設定できます。

#### 関連項目

- HRDC.Inst.mkr.9

- HRDC.CrHV.mkr.6

- `dthelpview`(1) マニュアル・ページ

## 索引ボリュームの生成 (dthelpgen)

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

- ファミリ・ファイルまたはヘルプ・ボリュームの追加、削除、または変更

- `LANG` 環境変数の変更

- `ReloadApps` アクションの起動

- 端末エミュレータ上での `dthelpgen` の手動による実行

索引ボリュームは、フロントパネルの[ヘルプ・ビューア]コントロールをクリックすると表示されます。または、`dthelpview` を手動で実行し、次のコマンド行で示されているように索引ボリューム名を指定することができます。

    dthelpview -h index.hv

### コマンド形式

    dthelpgen -dir [options]

オプションの機能を次に示します。

`-dir` | 索引ボリュームと中間ファイルを格納するディレクトリを指定します。これは、必須のパラメータです。

### オプション

`-generate` | システム上のファミリ・ファイルとヘルプ・ボリュームが変更されていない場合でも新しい索引ヘルプ・ボリュームが作成されるように指定します。
`-file` basename | `dthelpgen` が作成したヘルプ・ボリュームと中間ファイルの名前を指定します。デフォルトの名前は `index.hv` です。
`-lang` | どの言語ディレクトリのヘルプ・ファミリとヘルプ・ボリュームを検索するかを指定します。`-lang` オプションを設定すると、`LANG` 環境変数の現在値よりも優先されます。

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

#### 関連項目

- HRDC.Inst.mkr.9

- `dthelpgen`(1) マニュアル・ページ