1.1 マニュアルの説明
このマニュアルで使用している表記について説明します。
- 文法の記号
-
このマニュアルで使用する各種の記号を説明します。
- 属性表示記号
-
ユーザ指定値の範囲などを説明する記号です。
属性表示記号
意味
〜
この記号のあとにユーザ指定値の属性を示します。
《 》
ユーザが指定を省略したときの解釈値を示します。
< >
ユーザ指定値の構文要素を示します。
(( ))
ユーザ指定値の指定範囲を示します。
- 構文要素記号
-
ユーザ指定値の内容を説明する記号です。
構文要素記号
意味
<英字>
半角のアルファベット(A〜Z,a〜z)
<数字>
半角の数字(0〜9)
<英数字>
英字と数字
<識別子>
先頭が英字の英数字列と_(アンダスコア)
<文字列>
任意の文字の配列(ただし,2バイト文字は除く)
- 文法記述記号
-
記述形式を説明する記号です。
文法記述記号
意味
〔 〕
この記号で囲まれている項目は省略してもよいことを示します。
- (例)
-
〔-l 最大メッセージ長〕
-lオプションとそのオペランドを指定するか,何も指定しないことを示します。
{ }
この記号で囲まれている複数の項目のうちから一つを選択することを示します。
- (例)
-
{local|shr_receive}
localとshr_receiveのうち,どちらかを指定することを示します。
|
(ストローク)
この記号で区切られた項目は選択できることを示します。
- (例)
-
{local|shr_receive}
localとshr_receiveのうち,どちらかを指定することを示します。
< >
この記号で囲まれている項目はユーザの環境によって異なることを表します。
- (例)
-
<HiRDBサーバのホスト名またはIPアドレス>
ユーザの環境で使用しているHiRDBサーバのホスト名またはIPアドレスを指定することを示します。
- このマニュアルで使用するディレクトリ名
-
このマニュアルでは,原則としてWindowsの表記を使用しています。UNIXの場合は,環境変数の頭に「$」を付加し,ディレクトリセパレータを「/」で読み替えてください。読み替えの例を次の表に示します。
Windowsの場合
UNIXの場合
%HRMDIR%\sql
$HRMDIR/sql
- リソースアダプタの違いによる機能相違点の表記
-
このマニュアルの対象製品は,永続版リソースアダプタと非永続版リソースアダプタの2種類のリソースアダプタを提供します。リソースアダプタによって記述を書き分ける場合,次に示す表記を使用して,それぞれの説明にリソースアダプタの種別を明記しています。
表記
意味
永続版リソースアダプタの場合
永続版リソースアダプタに該当する表記です。
非永続版リソースアダプタの場合
非永続版リソースアダプタに該当する表記です。