それぞれの Apache ディレクティブは、次のような共通の書式によって記述されます:
このドキュメントではディレクティブのそれぞれの属性が説明され ています。可能な場合はディレクティブが取り得るすべての値も書かれています。
設定ファイル中のディレクティブの書式を示します。 この構文はディレクティブ特有なので、詳細はディレクティブの説明を 参照してください。一般的に、ディレクティブ名の後には 空白により分割されたいくつかの引数が続きます。 引数が空白を含むときは二重引用符 (訳注: ") で囲まれています。 オプショナルな引数は括弧 (訳注: []) で囲まれています。 引数が複数の値を取り得る場合は、それらの値は垂直の棒 "|" で 分割されています。 変更されないテキストはデフォルトのフォントで表示され、置換の必要な 引数は強調されて表示されます。 引数の数が変わるディレクティブは最後の 引数が繰り返されることを示すために "..." で終わります。
ディレクティブは多くの違う型の引数をとります。いくつか、良く 使われるものを以下で定義します。
http://www.example.com/path/to/file.html
のように、
スキーム、ホスト名、パス名(省略可能)を含んでいる完全な
Uniform Resource Locator。/path/to/file.html
のように、スキームと
ホスト名の後に続く url の一部。url-path
は ファイルシステムからの視点ではなく、
ウェブからの視点でリソースを表現します。/usr/local/apache/htdocs/path/to/file.html
のように、
ルートディレクトリから始まるローカルのファイルシステム上のファイルへのパス。
通常、スラッシュで始まらない file-path は ServerRoot からの相対パスとして
扱われます。/usr/local/apache/htdocs/path/to/
のように、
ルートディレクトリから始まるローカルのファイルシステムのディレクトリへの
パス。file.html
のように、パス情報の付いていない
ファイル名。file.html.en
には二つの拡張子があります。.html
と
.en
です。Apache
のディレクティブでは、extension
はドット付きでも無しでも指定できます。さらに、extension
は 大文字小文字を区別しません。text/html
のように、スラッシュで分離された
主フォーマットと副フォーマットによってファイルの形式を
表す方法です。ディレクティブにデフォルト値 (すなわち、設定ファイルから 省略されていても、Apache ウェブサーバは特定の値に設定されているかのように 動作します) がある場合はここに記述されます。 デフォルト値の無い場合、ここは "None" と 書かれます。ここで書かれているデフォルトはサーバと共に配布されている デフォルトの httpd.conf 内に書かれているディレクティブの値と 違う可能性があることに注意してください。
これは、サーバの設定ファイル中のどこでディレクティブが有効なのかを示します。 次に示す値が一つ以上カンマ区切りで列挙されています。
ディレクティブは指示されたコンテキストでのみ許可されます。 他の場所で使おうとすると、サーバがそのコンテキストを正しく扱えなく なるような設定エラーが発生するか、サーバがまったく動作しなくなる、 すなわち、サーバが起動しなくなるということになります。
ディレクティブの有効な位置は、実際は挙げられているコンテキストの 論理和 (訳注: Boolen OR) になります。言い換えると、 "サーバ設定ファイル、.htaccess" で有効だと 記されているディレクティブは httpd.conf ファイルと .htaccess ファイルとで有効ですが、 <Directory> や <VirtualHost> の中では使用できません。
このディレクティブの属性は、.htaccess ファイル中に ディレクティブが現れたときに、それの処理を有効にするために どの設定の上書きが必要かを示します。 ディレクティブの コンテキスト が、.htaccess ファイル中では許可していない場合は、 この属性は "適用不可" と書かれます。
上書きは、AllowOverride ディレクティブによって有効にされ、 特定のスコープ(ディレクトリなど)と、 さらに下位のレベルの AllowOverride で修正されない限り、 その配下に対して適用されます。 ディレクティブのドキュメントは取り得る上書きの名前も挙げます。
これはディレクティブが Apache ウェブサーバにどれくらいきつく組み込まれているかを 示します。言い換えれば、ディレクティブとその機能を利用するために、 モジュールの数を増やして、サーバを再コンパイルする必要があるかもしれない ということを示します。 この属性が取り得る値は以下のものです:
これは単純にディレクティブが定義されているモジュールの名前を記載します。
ディレクティブが Apache 1 の配布に組み込まれていなかった場合、 ディレクティブが導入されたバージョンがここに書かれています。 ディレクティブが NCSA HTTPd サーバのものと同じ名前である場合、 異なる挙動があるとここに書かれます。 挙動が同じ場合は、"互換性の問題無し" と書かれています。