~ubuntu-branches/ubuntu/feisty/apache2/feisty

<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>

<p class="apache">Apache HTTP Server Version 2.2</p>

<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a></div><div id="page-content"><div id="preamble"><h1>Terms Used to Describe Directives</h1>

<p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |

<a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |

</div>

<p>This document describes the terms that are used to describe

each Apache <a href="directives.html">configuration

directive</a>.</p>

</div>

<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#Description">Description</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Syntax">Syntax</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Default">Default</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Context">Context</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Override">Override</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Module">Module</a></li>

<li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li>

</ul><h3>See also</h3><ul class="seealso"><li><a href="../configuring.html">Configuration files</a></li></ul></div>

<h2><a name="Description" id="Description">Description</a></h2>

<p>A brief description of the purpose of the directive.</p>

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

<h2><a name="Syntax" id="Syntax">Syntax</a></h2>

<p>This indicates the format of the directive as it would

appear in a configuration file. This syntax is extremely

directive-specific, and is described in detail in the

directive's definition. Generally, the directive name is

followed by a series of one or more space-separated arguments.

If an argument contains a space, the argument must be enclosed

in double quotes. Optional arguments are enclosed in square

brackets. Where an argument can take on more than one possible

value, the possible values are separated by vertical bars "|".

Literal text is presented in the default font, while

argument-types for which substitution is necessary are

<em>emphasized</em>. Directives which can take a variable

number of arguments will end in "..." indicating that the last

argument is repeated.</p>

<p>Directives use a great number of different argument types. A

few common ones are defined below.</p>

<dl>

<dd>A complete Uniform Resource Locator including a scheme,

hostname, and optional pathname as in

<code>http://www.example.com/path/to/file.html</code></dd>

<dd>The part of a <em>url</em> which follows the scheme and

hostname as in <code>/path/to/file.html</code>. The

<em>url-path</em> represents a web-view of a resource, as

opposed to a file-system view.</dd>

<dd>The path to a file in the local file-system beginning

with the root directory as in

<code>/usr/local/apache/htdocs/path/to/file.html</code>.

Unless otherwise specified, a <em>file-path</em> which does

not begin with a slash will be treated as relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>

<dt><em>directory-path</em></dt>

<dd>The path to a directory in the local file-system

beginning with the root directory as in

<code>/usr/local/apache/htdocs/path/to/</code>.</dd>

<dt><em>filename</em></dt>

<dd>The name of a file with no accompanying path information

as in <code>file.html</code>.</dd>

<dt><em>regex</em></dt>

100

101

<dd>A Perl-compatible <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular

102

expression</a>. The directive definition will specify what the

103

<em>regex</em> is matching against.</dd>

104

105

<dt><em>extension</em></dt>

106

107

<dd>In general, this is the part of the <em>filename</em>

108

which follows the last dot. However, Apache recognizes

109

multiple filename extensions, so if a <em>filename</em>

110

contains more than one dot, each dot-separated part of the

111

filename following the first dot is an <em>extension</em>.

112

For example, the <em>filename</em> <code>file.html.en</code>

113

contains two extensions: <code>.html</code> and

114

<code>.en</code>. For Apache directives, you may specify

115

<em>extension</em>s with or without the leading dot. In

116

addition, <em>extension</em>s are not case sensitive.</dd>

117

118

119

120

<dd>A method of describing the format of a file which

121

consists of a major format type and a minor format type,

122

separated by a slash as in <code>text/html</code>.</dd>

123

124

<dt><em>env-variable</em></dt>

125

126

<dd>The name of an <a href="../env.html">environment

127

variable</a> defined in the Apache configuration process.

128

Note this is not necessarily the same as an operating system

129

environment variable. See the <a href="../env.html">environment variable documentation</a> for

130

more details.</dd>

131

</dl>

132

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

133

134

<h2><a name="Default" id="Default">Default</a></h2>

135

136

<p>If the directive has a default value (<em>i.e.</em>, if you

137

omit it from your configuration entirely, the Apache Web server

138

will behave as though you set it to a particular value), it is

139

described here. If there is no default value, this section

140

should say "<em>None</em>". Note that the default listed here

141

is not necessarily the same as the value the directive takes in

142

the default httpd.conf distributed with the server.</p>

143

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

144

145

<h2><a name="Context" id="Context">Context</a></h2>

146

147

<p>This indicates where in the server's configuration files the

148

directive is legal. It's a comma-separated list of one or more

149

of the following values:</p>

150

151

<dl>

152

<dt>server config</dt>

153

154

<dd>This means that the directive may be used in the server

155

configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but

156

<strong>not</strong> within any

157

158

or <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>

159

containers. It is not allowed in <code>.htaccess</code> files

160

at all.</dd>

161

162

<dt>virtual host</dt>

163

164

<dd>This context means that the directive may appear inside

165

166

containers in the server

167

configuration files.</dd>

168

169

<dt>directory</dt>

170

171

<dd>A directive marked as being valid in this context may be

172

used inside <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>, <code class="directive"><a href="../mod/core.html#location"><Location></a></code>, <code class="directive"><a href="../mod/core.html#files"><Files></a></code>, and <code class="directive"><a href="../mod/mod_proxy.html#proxy"><Proxy></a></code> containers

173

in the server configuration files, subject to the restrictions

174

outlined in <a href="../sections.html">Configuration

175

Sections</a>.</dd>

176

177

<dt>.htaccess</dt>

178

179

<dd>If a directive is valid in this context, it means that it

180

can appear inside <em>per</em>-directory

181

<code>.htaccess</code> files. It may not be processed, though

182

depending upon the <a href="#Override">overrides</a> currently active.</dd>

183

</dl>

184

185

<p>The directive is <em>only</em> allowed within the designated

186

context; if you try to use it elsewhere, you'll get a

187

configuration error that will either prevent the server from

188

handling requests in that context correctly, or will keep the

189

server from operating at all -- <em>i.e.</em>, the server won't

190

even start.</p>

191

192

<p>The valid locations for the directive are actually the

193

result of a Boolean OR of all of the listed contexts. In other

194

words, a directive that is marked as being valid in

195

"<code>server config, .htaccess</code>" can be used in the

196

<code>httpd.conf</code> file and in <code>.htaccess</code>

197

files, but not within any <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> or

198

199

containers.</p>

200

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

201

202

<h2><a name="Override" id="Override">Override</a></h2>

203

204

<p>This directive attribute indicates which configuration

205

override must be active in order for the directive to be

206

processed when it appears in a <code>.htaccess</code> file. If

207

the directive's <a href="#Context">context</a>

208

doesn't permit it to appear in <code>.htaccess</code> files,

209

then no context will be listed.</p>

210

211

<p>Overrides are activated by the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directive, and apply

212

to a particular scope (such as a directory) and all

213

descendants, unless further modified by other

214

<code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directives at

215

lower levels. The documentation for that directive also lists the

216

possible override names available.</p>

217

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

218

219

<h2><a name="Status" id="Status">Status</a></h2>

220

221

<p>This indicates how tightly bound into the Apache Web server

222

the directive is; in other words, you may need to recompile the

223

server with an enhanced set of modules in order to gain access

224

to the directive and its functionality. Possible values for

225

this attribute are:</p>

226

227

<dl>

228

229

230

<dd>If a directive is listed as having "Core" status, that

231

means it is part of the innermost portions of the Apache Web

232

server, and is always available.</dd>

233

234

235

236

<dd>A directive labeled as having "MPM" status is provided by

237

a <a href="../mpm.html">Multi-Processing Module</a>. This

238

type of directive will be available if and only if you are

239

using one of the MPMs listed on the <a href="#Module">Module</a> line of the directive

240

definition.</dd>

241

242

243

244

<dd>A directive labeled as having "Base" status is supported

245

by one of the standard Apache modules which is compiled into

246

the server by default, and is therefore normally available

247

unless you've taken steps to remove the module from your

248

configuration.</dd>

249

250

<dt>Extension</dt>

251

252

<dd>A directive with "Extension" status is provided by one of

253

the modules included with the Apache server kit, but the

254

module isn't normally compiled into the server. To enable the

255

directive and its functionality, you will need to change the

256

server build configuration files and re-compile Apache.</dd>

257

258

<dt>Experimental</dt>

259

260

<dd>"Experimental" status indicates that the directive is

261

available as part of the Apache kit, but you're on your own

262

if you try to use it. The directive is being documented for

263

completeness, and is not necessarily supported. The module

264

which provides the directive may or may not be compiled in by

265

default; check the top of the page which describes the

266

directive and its module to see if it remarks on the

267

availability.</dd>

268

</dl>

269

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

270

271

<h2><a name="Module" id="Module">Module</a></h2>

272

273

<p>This quite simply lists the name of the source module which

274

defines the directive.</p>

275

</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>

276

277

<h2><a name="Compatibility" id="Compatibility">Compatibility</a></h2>

278

279

<p>If the directive wasn't part of the original Apache version

280

2 distribution, the version in which it was introduced should

281

be listed here. In addition, if the directive is available

282

only on certain platforms, it will be noted here.</p>

283

</div></div>

284

285

<p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |

286

<a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |

287

288

</div><div id="footer">

289

290

291

</body></html>

b'\\ No newline at end of file'

Older »