HELPコマンドを実行すると,HELP機能が起動します。 HELP機能は,コマンドの形式や説明,パラメータ,修飾子, およびシステム・メッセージを含め,システムの使用に関する情報を表示します。 Topic?というプロンプトに対して,次の指示ができます。
すべてのトピック名は短縮することができます。 一意にトピックを選択できない場合は,あてはまるすべてのトピックが表示されます。
HELP [トピック[サブトピック...]]
OpenVMS上で最も簡単な形式でHELP機能を使用する方法は, ターミナルからHELPコマンドを入力することです。 HELPコマンドを入力すると,HELP機能はユーザのターミナルにトピックの一覧と Topic?というプロンプトを表示します。 あるトピックに関する情報を表示したい場合は, Topic?プロンプトに対してトピック名を入力します。 システムは,そのトピックに関する情報を表示します。
トピックにサブトピックがある場合は, サブトピックの一覧とSubtopic?というプロンプトが表示されます。 あるサブトピックに関する情報を表示したい場合は, Subtopic?プロンプトに対してサブトピック名を入力します。 他のトピックの情報を見たい場合は,RETURNキーを押します。 Topic?プロンプトが表示されている時は, 他のトピックの情報を表示させることができます。 HELP機能を終了しDCLレベルに戻るには,RETURNキーを押します。
キーワードの代わりにアスタリスク(*)を使用すると, HELPコマンドはアスタリスクを指定したレベルで使用可能な, すべての情報を表示します。 たとえば,HELP COPY *と入力すると,COPY以下のすべてのサブトピックを表示します。
主キーワードのすぐ後に反復記号( . . . )を使用すると, 指定したトピックとそのトピックのすべてのサブトピックに関する, すべての情報が表示されます。たとえばHELP COPY . . . と指定すると, COPYというトピックに関する情報と, COPYの下のすべてのサブトピックに関する情報が表示されます。
アスタリスク(*)とパーセント記号(%)ワイルドカード文字を, キーワードに指定することはできません。
/SEARCH修飾子を指定せずに/EXACT修飾子を指定した場合は, Findキー(E1)を押して検索文字列を設定すると正確に一致する文字列を検索できます。
装置とディレクトリの指定を省略すると,省略時の値としてSYS$HELPが使用されます。 SYS$HELPは,システム・ヘルプ・ライブラリの位置を示す論理名です。 省略時のファイル・タイプは.HLBです。
省略時のヘルプ・ライブラリを検索しないようにするには, /NOLIBRARY修飾子を指定します。
/OUTPUT修飾子で部分ファイル指定を行う(たとえば/OUTPUT=[JONES])と, 省略時のファイル名はHELP,省略時のファイル・タイプは.LISになります。 アスタリスク(*)およびパーセント記号(%)ワイルドカード文字を使用することはできません。
/NOOUTPUT修飾子を指定すると,どこにも出力されません。
/PAGE修飾子とともに次のキーワードを指定することができます。
CLEAR_SCREEN | 各ページを表示する前に画面をクリアします。 |
SCROLL | 一行ずつ情報を表示します。 |
SAVE[=n] | 情報の表示を制御することができます。 nは履歴を保持するページ数です。 |
/PAGE=SAVE修飾子を指定すると, 最大5画面(最大255カラムまで)分の履歴を保存できます。 /PAGE=SAVE修飾子を使用すると,次のキーを使用して画面を移動することができます。
キー | 説明 |
---|---|
Up arrow key, Ctrl/B | 1行ずつスクロールアップ |
Down arrow key | 1行ずつスクロールダウン |
Left arrow key | 1カラム左シフト |
Right arrow key | 1カラム右シフト |
Find (E1) | 文字列検索を起動 |
Insert Here (E2) | 半画面右シフト |
Remove (E3) | 半画面左シフト |
Select (E4) | 80/132カラム切り替え |
Prev Screen (E5) | 前ページに移動 |
Next Screen (E6), Return, Enter, Space | 次ページに移動 |
F10, Ctrl/Z | 終了(ユーティリティにより異なる場合があります) |
Help (F15) | ユーティリティ・ヘルプ・テキストを表示 |
Do (F16) | 最新(現在)画面と(履歴内で)最古画面の入れ替え |
Ctrl /W | 再表示 |
/PAGE修飾子と/OUTPUT修飾子を同時に指定することはできません。
/PROMPT修飾子が有効な場合は, 特定のヘルプ・トピックまたはサブトピックを指定するよう要求する, プロンプト(4つのプロンプトのうちいずれか1つ)が表示されます。 ヘルプ情報の階層構造のレベルにより,異なるプロンプトが表示されます。 次のその4つのプロンプトを示します。
これらのプロンプトのいずれか1つが表示されたら, 次の表のいずれか1つの応答を入力します。
応答 | 現在の プロンプト |
動作 |
---|---|---|
キーワード[...] | 1,2 | 使用可能なすべてのライブラリから,指定したキーワードを検索する。 |
3,4 | 現在のトピックおよびサブトピックの両方, またはどちらかに関する追加のヘルプ・ライブラリから, 指定したキーワードを検索する。 | |
@ファイル指定キーワード[...] | 1,2 | 上記と同じ。
ただし@ファイル指定で指定したライブラリが,ルート・ライブラリである点が異なる。
指定したライブラリが存在しない場合は,
HELPは@ファイル指定を普通のキーワードとして扱う。
ルート・ライブラリで使用できるトピックの一覧を表示する。 |
3,4 | 上記と同じ。@ファイル指定を普通のキーワードとして扱う。
ヘルプが存在する現在のトピック(またはサブトピック) のサブトピックのリストを表示する。 | |
[Return] | 1 | HELPを終了する。 |
2 | ルート・ライブラリをメイン・ライブラリに変更する。 | |
3,4 | 1つ上のレベルで,トピックまたはサブトピックを要求するプロンプトを表示する。 | |
[Ctrl/Z] | 1,2,3,4 | HELPを終了する。 |
情報が表示されている時に, Findキー(E1)を押して検索文字列を動的に変更することができます。 この場合,二重引用符は必要ありません。
PROCESS | プロセス・レベルで定義したライブラリ |
GROUP | グループ・レベルで定義したライブラリ |
SYSTEM | システム・レベルで定義したライブラリ |
ALL | すべてのライブラリ(省略時の設定) |
NONE | ライブラリなし(/NOUSERLIBRARY修飾子を指定した場合と同じ) |
使用可能なヘルプ・ライブラリは,論理名HLP$LIBRARY,HLP$LIBRARY_1, HLP$LIBRARY_2...で定義されたライブラリです。 各ライブラリは,この順序で検索されます。つまりルート(現在の)ライブラリ, メイン・ライブラリ(ルート・ライブラリと異なる場合), プロセス・レベルで定義されたライブラリ, グループ・レベルで定義されたライブラリ, システム・レベルで定義されたライブラリ,ルート・ライブラリの順序です。 検索した結果,指定したトピックを見つけられなかった場合には, ルート・ライブラリがもう一度検索され,コンテキストは, 検索が開始されたルート・ライブラリに戻されます。 省略時の設定は,/USERLIBRARY=ALLです。 検索のためのレベルを1つしか指定しない場合は,括弧は省略できます。
/NOWRAP修飾子を指定すると,画面の幅以上に行を続けます。 /PAGE=SAVE修飾子により提供されるスクロール機能(右および左)を使用すれば, 行すべてを読むことができます。
$ HELP HELP . . (HELP message text and list of topics) . Topic?この例では修飾子やパラメータを指定せずにHELPコマンドを入力しています。 ここではルート・ヘルプ・ライブラリSYS$HELPLIB.HLB で使用できるヘルプ・トピックが表示されます。
Topic?というプロンプトに対して,いずれか1つのトピックを入力すると, HELPはそのトピックに関する情報と, サブトピックが存在する場合にはそのリストを表示します。 1つまたは複数のサブトピックが存在する場合は, サブトピックを要求するプロンプトが表示されます。
Topic? ASSIGN ASSIGN . . (HELP message text and subtopics) . ASSIGN Subtopic?
サブトピック名をタイプすると,HELPはそのサブトピックに関する情報を表示します。 次の例を参照してください。
ASSIGN Subtopic? Name ASSIGN Name . . (HELP message text and subtopics, if any) . ASSIGN Subtopic?
1つまたは複数のサブ・サブトピックが存在する場合は, HELPはサブ・サブトピックを要求するプロンプトを表示します。 この例のようにサブ・サブトピックが存在しない場合は,現在調べているトピックの, 別のサブトピックの入力を要求するプロンプトが表示されます。
疑問符(?)タイプすると, 現在のレベルのHELPメッセージとオプションが再表示されます。 RETURNを押すと,次のいずれかの操作が行われます。
Ctrl/Zを押すと,どのレベルでもHELPは終了します。
$ HELP COPY...このHELPコマンドを入力すると,COPYコマンド, およびCOPYコマンドのパラメータや修飾子の説明が表示されます。 反復記号( . . . )は,トピック・レベルでしか使用できない点に注意してください。 サブトピック・レベルで使用することはできません。
$ HELP/NOPROMPT ASSIGN/GROUP . . (ASSIGN/GROUP HELP message) . $ $ HELP/NOPROMPT/PAGE EDIT * . . (HELP messages on all first-level EDIT subtopics) . $2つのHELPコマンドは,特定のトピックに関する情報を要求しています。 どちらの場合も,HELPコマンドはユーザが要求したヘルプ・メッセージを表示し, その後,DCLコマンド・レベルに制御を戻し,ドル記号プロンプト($)が表示されます。
最初のコマンドは,ASSIGNコマンドの/GROUP修飾子に関する情報を要求しています。 2番目の例のアスタリスク(*)は,ワイルドカード文字です。 これは,すべてのEDITサブトピックに関する情報を要求しており,これらの情報は, アルファベット順に表示されます。 /NOPROMPT修飾子を指定しているので,どちらの場合もプロンプトは表示されません。 2つめのHELPコマンドでは/PAGE修飾子を指定しているので, 画面に情報が表示されると,そこで表示が一時止まります。
$ HELP FILL Sorry, no documentation on FILL Additional information available: . . (list of first-level topics ) . Topic? @EDTHELP FILL FILL . . (FILL HELP message) . @EDTHELP Topic?省略時のヘルプ・ライブラリに含まれていないトピックに関するヘルプ情報を要求する場合いは, そのトピックを他のヘルプ・ライブラリから検索するよう, HELPに指示を与えることができます。 この例では,@EDTHELP FILLというコマンドを入力することにより, EDTエディタ・コマンドであるFILLに関する情報を,SYS$HELP:EDTHELP.HLB というヘルプ・ライブラリから検索するよう HELPに指示しています。 HELPはメッセージを表示し, 他のEDTエディタ・トピックを指定するよう要求するプロンプトを表示します。
$ SET DEFAULT SYS$HELP $ DEFINE HLP$LIBRARY EDTHELP $ DEFINE HLP$LIBRARY_1 MAILHELP $ DEFINE HLP$LIBRARY_2 BASIC $ DEFINE HLP$LIBRARY_3 DISK2:[MALCOLM]FLIP $ HELP REM論理名を使用してライブラリを定義しておくと, 指定したトピックをOpenVMSルート・ヘルプ・ライブラリで見つけられない場合, HELPは自動的にこれらのライブラリを検索します。 この例では,省略時のルート・ライブラリSYS$HELP:HELPLIB.HLBに加え, これらのライブラリも検索するようHELPに指示しています。
DEFINE文でユーザ定義のヘルプ・ライブラリに論理名を割り当てています。 HELPは,ルート・ライブラリを検索した後, これらのユーザ定義のヘルプ・ライブラリを検索します。 最初の3つのエントリは,現在の省略時のディレクトリにあるヘルプ・ライブラリです。 省略時の設定では,HELPは, 論理名SYS$HELPで定義されるディレクトリ内のヘルプ・ライブラリを検索します。 4つ目のエントリは, ディレクトリDISK2:[MALCOLM]内のヘルプ・ライブラリ FLIP.HLBです。 ヘルプ・ライブラリを定義するために使用する論理名は, 連続的に指定しなければならない点に注意してください。 つまり,論理名の数字をスキップさせることはできません。
この例ではHELPは,まずルート・ライブラリでREMを検索します。 次に,HLP$LIBRARY,HLP$LIBRARY_1,HLP$LIBRARY_2という順に検索します。 これはREMが見つかるまで, またはすべてのライブラリで見つけられなかったと分かるまで,検索を続けます。 BASIC.HLBライブラリでREMが見つかった場合HELPは,REMに関する情報を表示し, BASIC.HLBライブラリ内のサブトピックを指定するよう要求します。 BASIC.HLBライブラリにないトピックを指定すると,HELPは, 定義したヘルプ・ライブラリでそのトピックを検索します。
システム・メッセージの説明を表示します。
HELP/MESSAGE [/修飾子[...]] [検索文字列]
Help Messageユーティリティ(MSGHLP)は,次の規則に従って検索文字列を扱います。
最初に一般的ではない単語を指定すると,検索にかかる時間を短縮することができます。
指定したメッセージをHelp Messageがデータベースで見つけられなかった場合は, 先行の特殊文字,ファシリティ・コード,および重大度を削除し, もう1回コマンドを実行します。 いくつかのメッセージは,ファシリティ固有のメッセージではなく, "共有"メッセージと記されています。
1つまたは複数の指定したファシリティにより生成される, すべてのメッセージを抽出することができます。この出力をファイルに書き込むと, ユーザ独自のメッセージ・ドキュメントを作成し印刷することができます。
Help Messageデータベースにコメントまたはメッセージを追加する方法についての詳細は, 『OpenVMS System Messages: Companion Guide for Help Message Users』 を参照してください。
弊社が提供したデータベースからメッセージを削除するには, 弊社が提供した.MSGHLP$DATAファイルに対する書き込みアクセス権が必要です。
- 注意
- 検索文字列を指定して.MSGHLPファイルを作成する場合は, 出力される.MSGHLPファイルをチェックして, データベースから削除したくない意図しないメッセージが, 検索されなかったことを確認してください。 このようなメッセージは,削除操作を行う前に.MSGHLPファイルの外で編集してください。
省略時のデータベースまたは /LIBRARY で指定されたデータベース内のすべてのファシリティのリストを出力するには, /FACILITY=?と入力します。
検索範囲を狭めるために,1つまたは複数のファシリティ名を/FACILITYに指定します (複数のファシリティを指定する場合には,コンマで区切り括弧で囲みます)。 Help Messageは, 指定されたファシリティで生成されるメッセージの中で一致するものだけを出力します。
データベース内のすべてのファシリティのメッセージを出力するには, /FACILITY=ALLを指定します。他のファシリティが暗黙的に指定されない限り, /FACILITY=ALLが省略時の設定になります。これは,たとえば/STATUSを指定したり, $STATUSというCLIシンボルの値を使用する場合などで, この場合には特定のファシリティが自動的に指定されます。 同様に,ファシリティ名を含んだメッセージのカット・アンド・ペーストは, /FACILITY修飾子の使用を無効にします。
/FACILITY修飾子の使用についての詳細は, 『OpenVMS System Messages: Companion Guide for Help Message Users』 を参照してください。
弊社が提供する.MSGHLP$DATAファイルにデータを挿入するには, このファイルに対する書き込みアクセス権が必要です。 ユーザが指定したデータは,Help Messageの出力中で,変更バーが付けられます。
大部分の操作では,省略時のデータベースは SYS$HELP:MSGHLP$LIBRARY.MSGHLP$DATAであるか, 論理名MSGHLP$LIBRARYで定義された .MSGHLP$DATA ファイルの検索パスです。
/DELETEおよび/INSERT操作では,省略時のデータベースは, SYS$HELP:MSGHLP$LIBRARY.MSGHLP$DATAであるか, 論理名MSGHLP$LIBRARYで定義された検索パスの最初のファイルです。
- 注意
- この修飾子を使用した結果は,SET MESSAGEコマンドによる結果とは関係ありません。 Help MessageユーティリティとMessageユーティリティは, 互いに影響を与えることはありません。結果を得るためには, 各ユーティリティをそれぞれコーディングしなければなりません。
HELP/MESSAGEコマンドに検索文字列が含まれない場合,Help Message は $STATUS というCLIシンボルに相当するメッセージを,省略時の値として出力します。 つまり,Help Messageは, 最後に実行したコマンドがどのように終了したかを示す情報を表示します。
/STATUS修飾子を指定した場合は,検索文字列や/FACILITY修飾子は指定できません。 検索文字列を省略し,/STATUS='$STATUS'という省略時設定を使用する場合は, /FACILITYを指定することはできません。
/WORD_MATCH=WHOLE_WORDは,単語全体が一致するものを検索し, 指定した単語を細かに検索します。 たとえば,ACCに関する精密な検索は,ACCという文字で始まる単語を持つ, 多数の他のメッセージを表示します。
$ SHOW DEVICE KUDOS %SYSTEM-W-NOSUCHDEV, no such device available $ HELP/MESSAGE最初のコマンドはエラーになります。修飾子のない省略時のHELP/MESSAGEコマンドは, NOSUCHDEVというSYSTEMファシリティ・メッセージの説明を表示します。
$ HELP/MESSAGE ACCVIO $ HELP/MESSAGE/BRIEF ACCVIO $ HELP/MESSAGE/FACILITY=SYSTEM ACCVIO $ HELP/MESSAGE VIRTUAL ACCESS $ HELP/MESSAGE/STATUS=12 $ HELP/MESSAGE/STATUS=%XCこれらのコマンドは, ACCVIOメッセージにアクセスし表示するためのいろいろな修飾子を, 異なる形式で使用する方法を示しています。
$ HELP/MESSAGE/BRIEF ACC $ HELP/MESSAGE/BRIEF/WORD_MATCH=WHOLE_WORD ACC最初のコマンドでは,Help Messageは省略時の設定により "ACC" という文字列で始まる多くの単語を検索します。 /WORD_MATCH=WHOLE_WORD修飾子を指定すると, 単語だけに厳密に一致するよう検索処理を改良することができます。
$ HELP/MESSAGE/FACILITY=(BACKUP,SHARED)/SORT/OUTPUT=MESSAGES.TXTこのコマンドは,BACKUPファシリティから発行されるすべてのメッセージと, "Shared by several facilities," と記載されているメッセージを選択し, アルファベット順に並べ,印刷可能なMESSAGES.TXTというファイルを出力します。
メッセージを選択し,それらをファイルに出力することによって, ユーザ独自の変更したメッセージ・ドキュメントを作成, および印刷することができます。
$ HELP/MESSAGE/EXTRACT=BADMESSAGE.MSGHLP BADMESSAGE $ HELP/MESSAGE/DELETE=BADMESSAGE.MSGHLP- _$ /LIBRARY=SYS$LOGIN:MYMESSAGES.MSGHLP$DATA $ CONVERT SYS$LOGIN:MYMESSAGES.MSGHLP$DATA- _$ SYS$LOGIN:MYMESSAGES.MSGHLP$DATA $ PURGE SYS$LOGIN:MYMESSAGES.MSGHLP$DATA $ HELP/MESSAGE/INSERT=BADMESSAGE.MSGHLP最初のコマンドは, BADMESSAGEという仮のメッセージを省略時のデータベースから取り出し, それをBADMESSAGE.MSGHLPというファイルに出力します。
2番目のコマンドは, /LIBRARY修飾子に指定したMYMESSAGES.MSGHLP$DATAというファイルから, BADMESSAGEの説明を削除するために, このBADMESSAGE.MSGHLPというファイルを使用しています。
次の2つのコマンドは,削除後にディスク領域を節約するために, ファイル MYMESSAGES.MSGHLP$DATAファイルを圧縮しています。
最後のコマンドは, 省略時の.MSGHLP$DATAファイルにBADMESSAGEメッセージを挿入するために, ファイルBADMESSAGE.MSGHLPを使用しています。 ファイル BADMESSAGE>MSGHLPは,編集されている可能性があります。
$ HELP/MESSAGE/EXTRACT=NOSNO.MSGHLP NOSNO $ EDIT/EDT NOSNO.MSGHLP 1NOSNO, can't ski; no snow 2XCSKI, XCSKI Program 3Your attempt to ski failed because there is no snow. 4Wait until there is snow and attempt the operation again. 5If you don't want to wait, go to a location where there is 5snow and ski there. 5 5Or, try ice skating instead! [EXIT] $ HELP/MESSAGE/INSERT=NOSNO.MSGHLPこのコマンドは,弊社が提供する .MSGHLP$DATAファイルに書き込みアクセス権を持つユーザが, 弊社の提供しているメッセージにコメントを追加する様子を示しています。
最初のコマンドは, NOSNOという仮のメッセージをファイルNOSNO.MSGHLPに出力しています。 2番目のコマンドで,その.MSGHLPファイルを編集し, メッセージの最後にコメントを追加しています。各コメント行には, それが空白行であっても,"5"という文字が最初に付けられています。 次のコマンドでNOSNO.MSGHLPを使用してデータベースを更新し, 省略時の.MSGHLP$DATAファイルに変更したメッセージを挿入しています。