HELP 情報の作成

コマンド・プロセッサーを作成して、他のユーザーでコマンドが使用できるようにする場合は、そのコマンドのヘルプ情報も用意しておいてください。用意するヘルプ情報には、コマンドの機能、構文、オペランド、およびメッセージに関する情報を 含める必要があります。コマンド・プロセッサーがサブコマンドを持っている場合は、サブコマンドとそのオペランドの説明も、ヘルプ情報に含める必要があります。

ヘルプ情報は、ヘルプ・データ・セット に用意します。 ヘルプ・データ・セットは、コマンドのヘルプ情報を含む個々のメンバーから構成される、カタログされた、区分データ・セットです。それぞれのメンバー は、1 つのコマンドとそのサブコマンド用のヘルプ情報を含んでいます。メンバーの名前は、コマンドそのものの名前です。たとえば、PRTDATA という 名前のコマンド・プロセッサーを作成する場合、PRTDATA という名前のメンバーにヘルプ情報を 用意します。ヘルプ・データ・セットのメンバーは、固定長 80 文字の レコードを持っています。

ヘルプ情報は、SYS1.HELP データ・セットまたはユーザーやユーザーのインストール・システムで作成したデータ・セットで用意することができます。TSO/E では、TSO/E のコマンドとサブコマンド用のヘルプ情報が 入った SYS1.HELP データ・セットを提供しています。ユーザーは、SYS1.HELP の更新を許可されている必要があります。

SYS1.HELP ではなく、ユーザー独自のヘルプ・データ・セットを使用する 場合は、そのデータ・セットをシステムに定義する必要があります。ユーザーのヘルプ・データ・セットを SYS1.HELP データ・セットに、 あるいは SYS1.HELP をユーザーのデータ・セットに連結することができます。データ・セットをシステム・ファイルの SYSHELP に割り振ります。データ・セットの割り振りは、ログオン・プロシージャーの中 でも、ALLOCATE コマンドを使用してもいずれも可能です。 たとえば、ヘルプ・データ・セットの名前が MYCOMMS.HELPCOM である 場合、ALLOCATE コマンドを次のように使用することができます。
ALLOCATE FILE(SYSHELP) DA('SYS1.HELP' MYCOMMS.HELPCOM) SHR REUSE

SYS1.HELP に連結するヘルプ・データ・セットは、SYS1.HELP と同じ属性を 持っている必要はありません。ただし、最初の連結データ・セットは、その データ・セットの中で最大のブロック・サイズを持っている必要があり、固定ブロック・サイズを指定する必要があります。

また、SYS1.PARMLIB の IKJTSOxx メンバーを使用して、ユーザーの ヘルプ・データ・セットを定義することもできます。 SYS1.PARMLIB で、HELP ステートメントを使用して、インストール・システムの ヘルプ・データ・セットを定義します。ユーザーは SYS1.PARMLIB の IKJTSOxx の 更新を許可されている必要があります。SYS1.PARMLIB を使用して、ユーザーの ヘルプ・データ・セットを定義すると便利です。その理由は、これに よって、TSO/E PARMLIB コマンドを使用して、HELP PARMLIB ステートメントを 動的にリストし、変更することができるからです。SYS1.PARMLIB を使用して、ヘルプ・データ・セットを指定する方法に関しては、z/OS TSO/E カスタマイズ を参照してください。

SYS1.HELP データ・セットを使用する利点の 1 つは、システムはヘルプ情報に ついては 1 つのデータ・セットだけしか探索する必要がないということです。ユーザー独自のヘルプ・データ・セットを使用する利点は、TSO/E の新しい リリースをインストールするときに、ユーザーのヘルプ情報がオーバーレイされる 可能性が避けられるということです。

ヘルプ情報を用意する方法を決める際には、 HELP コマンドがどのようにして情報を見つけるのか考慮してください。ユーザーが HELP コマンドを 出して、コマンドやサブコマンドのヘルプを入手する場合、HELP は 以下のようにして情報を見つけます。