前のトピック: CA Technologies 製品リファレンス

次のトピック: ファイル ロケーションに関する規則

ドキュメントの表記規則

CA Access Control のドキュメントには、以下の規則があります。

形式

意味

等幅フォント

コードまたはプログラムの出力

斜体

強調または新規用語

太字

表示されているとおりに入力する必要のある要素

スラッシュ(/)

UNIX および Windows のパスの記述で使用される、プラットフォームに依存しないディレクトリの区切り文字

また、本書では、コマンド構文およびユーザ入力の説明に(等幅フォントで)以下の特殊な規則を使用します。

形式

意味

斜体

ユーザが入力する必要のある情報

角かっこ([])で囲まれた文字列

オプションのオペランド

中かっこ({})で囲まれた文字列

必須のオペランド セット

パイプ(|)で区切られた選択項目

代替オペランド(1 つ選択)を区切ります。

たとえば、以下の例は「ユーザ名またはグループ名のいずれか」を意味します。

{username|groupname}

...

前の項目または項目のグループが繰り返し可能なことを示します

下線

デフォルト値

スペースに続く、行末の円記号(¥)

本書では、コマンドの記述が 1 行に収まらない場合があります。 このような場合、行末の空白とそれに続く円記号(¥)は、そのコマンドが次の行に続くことを示します。

注: このような円記号はコピーしないでください。また、改行はコマンドに含めないようにしてください。 これらの文字は、実際のコマンド構文の一部ではありません。

例: コマンドの表記規則

以下のコードは、本書でのコマンド表記規則の使用方法を示しています。

ruler className [props({all|{propertyName1[,propertyName2]...})]

この例の内容