Skip navigation links
MySQL Enterprise Monitor :: 1 はじめに :: 1.2 本書の表記規則
2 インストールとアップグレード »
Section Navigation      [Toggle]

1.2. 本書の表記規則

本書では次の表記規則を使用しています。

  • Text in this styleは、SQL ステートメント、データベース、テーブル、カラム名、プログラムリスト、ソースコード、環境変数に使用されます。例: 「権限テーブルをリロードするには、FLUSH PRIVILEGES ステートメントを使用します。」

  • Text in this styleは、入力する文字の例を示します。

  • Text in this styleは、実行可能なプログラムおよびスクリプトの名前、たとえば mysql（MySQL コマンドラインクライアントプログラム）や mysqld（MySQL サーバ実行可能ファイル）を示します。

  • Text in this style は、独自に選択する値に置き換える変数入力に使用されます。

  • ファイル名とディレクトリ名は次のように表示されます。「グローバル my.cnf ファイルは、/etc ディレクトリにあります。」

  • 文字シーケンスは次のように表示されます。「ワイルドカードを指定するには、‘%’ 文字を使用します。」

  • Text in this style のスタイルは、強調に使用されます。

  • Text in this style のスタイルは、表の見出しや特に重要なことを示すときに使用されます。

特定のプログラム内から実行されるコマンドが示される場合、そのコマンドの前に記されるプロンプトは、どのコマンドが使用されるかを示しています。たとえば、shell> は、ログインシェルまたは Windows のコマンドラインから実行するコマンドを示します。 

shell> type a shell command here

「shell」 は、コマンドインタープリタです。UNIX の場合、これは通常、sh、csh、bash などのプログラムです。Windows の場合、プログラムは command.com または cmd.exe で、通常コンソールウィンドウで実行します。

例に示されるコマンドまたはステートメントを入力する場合、その例に示されるプロンプトを入力する必要はありません。

コンソールウィンドウで 1 行に示されるコマンドが、マニュアルでは 1 行で示すことができない場合があります。この場合、文字 ‘»’ が使用されます。例: 

Please specify the directory where the MySQL Enterprise Monitor »
 will be installed.

UNIX コマンドの場合、連続文字 ‘\’ が使用されます。これにより、コマンドをコピーして、コマンドラインに文字通りにペーストできます。次に例を示します。 

shell> /opt/mysql/enterprise/agent/bin/mysql-monitor-agent -f \
 /opt/mysql/enterprise/agent/etc/mysql-monitor-agent.ini

SQL キーワードは、大文字と小文字は区別されないので、どちらも使用できます。このドキュメントでは、大文字を使用します。

構文の説明では、角括弧（‘[’ と ‘]’）は、オプションの単語または句を示します。たとえば、次のステートメントでは、IF EXISTS はオプションです。 

DROP TABLE [IF EXISTS] tbl_name

構文要素が複数の選択肢で構成される場合、その選択肢は、縦線（‘|’）で区切られます。選択肢からいずれかを選択できる場合、選択肢は、角括弧（‘[’ と ‘]’）に囲んでリストされます。 

TRIM([[BOTH | LEADING | TRAILING] [remstr] FROM] str)

選択肢からいずれかを選択しなければならない場合、選択肢は、中括弧（‘{’ と ‘}’）に囲んでリストされます。 

{DESCRIBE | DESC} tbl_name [col_name | wild]

省略記号（...）は、ステートメントの一部が省略されていることを示し、通常、複雑な構文を簡単に記しています。たとえば、INSERT ... SELECT は、INSERT ステートメントに SELECT ステートメントが続く構文を簡単に記しています。

省略記号は、ステートメントで前にある構文要素を繰り返す場合にも使用されます。次の例では、カンマの前の最初の reset_option 値を複数回繰り返すことができます。 

RESET reset_option [,reset_option] ...

シェル変数を設定するコマンドは、Bourne シェル構文を使用して示されます。たとえば、CC 環境変数を設定し、configure コマンドを実行するシーケンスは、Bourne シェル構文では次のように示されます。 

shell> CC=gcc ./configure

csh または tcsh を使用する場合、コマンドを多少区別して入力する必要があります。 

shell> setenv CC gcc
shell> ./configure

このマニュアルでは、‘Unix’ という用語は、UNIX または UNIX と同様のオペレーティングシステムを表すときに使用されています。MySQL Enterprise Monitor でサポートされるオペレーティングシステムの最新のリストについては、http://www.mysql.com/products/enterprise/を参照してください。