content-negotiation.xml revision 7a98571671f92e53441bf24a0222768072172f90
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<?xml version='1.0' encoding='UTF-8' ?>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<!DOCTYPE manualpage SYSTEM "/style/manualpage.dtd">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<!-- $LastChangedRevision$ -->
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<!--
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Licensed to the Apache Software Foundation (ASF) under one or more
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen contributor license agreements. See the NOTICE file distributed with
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen this work for additional information regarding copyright ownership.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen The ASF licenses this file to You under the Apache License, Version 2.0
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen (the "License"); you may not use this file except in compliance with
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the License. You may obtain a copy of the License at
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen http://www.apache.org/licenses/LICENSE-2.0
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Unless required by applicable law or agreed to in writing, software
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen distributed under the License is distributed on an "AS IS" BASIS,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen See the License for the specific language governing permissions and
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen limitations under the License.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen-->
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<manualpage metafile="content-negotiation.xml.meta">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<title>Content Negotiation</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<summary>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>Apache HTTPD supports content negotiation as described in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the HTTP/1.1 specification. It can choose the best
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representation of a resource based on the browser-supplied
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen preferences for media type, languages, character set and
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen encoding. It also implements a couple of features to give
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen more intelligent handling of requests from browsers that send
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen incomplete negotiation information.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>Content negotiation is provided by the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <module>mod_negotiation</module> module, which is compiled in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen by default.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</summary>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="about"><title>About Content Negotiation</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>A resource may be available in several different
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representations. For example, it might be available in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen different languages or different media types, or a combination.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen One way of selecting the most appropriate choice is to give the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen user an index page, and let them select. However it is often
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen possible for the server to choose automatically. This works
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen because browsers can send, as part of each request, information
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen about what representations they prefer. For example, a browser
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen could indicate that it would like to see information in French,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen if possible, else English will do. Browsers indicate their
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen preferences by headers in the request. To request only French
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representations, the browser would send</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<example>Accept-Language: fr</example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>Note that this preference will only be applied when there is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen a choice of representations and they vary by language.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>As an example of a more complex request, this browser has
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen been configured to accept French and English, but prefer
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen French, and to accept various media types, preferring HTML over
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen plain text or other text types, and preferring GIF or JPEG over
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen other media types, but also allowing any other media type as a
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen last resort:</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Accept-Language: fr; q=1.0, en; q=0.5<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Accept: text/html; q=1.0, text/*; q=0.8, image/gif; q=0.6, image/jpeg; q=0.6, image/*; q=0.5, */*; q=0.1
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>httpd supports 'server driven' content negotiation, as
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen defined in the HTTP/1.1 specification. It fully supports the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>Accept</code>, <code>Accept-Language</code>,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>Accept-Charset</code> and <code>Accept-Encoding</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen request headers. httpd also supports 'transparent'
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen content negotiation, which is an experimental negotiation
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen protocol defined in RFC 2295 and RFC 2296. It does not offer
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen support for 'feature negotiation' as defined in these RFCs.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>A <strong>resource</strong> is a conceptual entity
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen identified by a URI (RFC 2396). An HTTP server like Apache HTTP Server
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen provides access to <strong>representations</strong> of the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen resource(s) within its namespace, with each representation in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the form of a sequence of bytes with a defined media type,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen character set, encoding, etc. Each resource may be associated
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen with zero, one, or more than one representation at any given
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen time. If multiple representations are available, the resource
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen is referred to as <strong>negotiable</strong> and each of its
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representations is termed a <strong>variant</strong>. The ways
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen in which the variants for a negotiable resource vary are called
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the <strong>dimensions</strong> of negotiation.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</section>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="negotiation"><title>Negotiation in httpd</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>In order to negotiate a resource, the server needs to be
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen given information about each of the variants. This is done in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen one of two ways:</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <ul>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>Using a type map (<em>i.e.</em>, a <code>*.var</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen file) which names the files containing the variants
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen explicitly, or</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>Using a 'MultiViews' search, where the server does an
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen implicit filename pattern match and chooses from among the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen results.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </ul>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <section id="type-map"><title>Using a type-map file</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>A type map is a document which is associated with the handler
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen named <code>type-map</code> (or, for backwards-compatibility with
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen older httpd configurations, the <glossary>MIME-type</glossary>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>application/x-type-map</code>). Note that to use this
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen feature, you must have a handler set in the configuration that
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen defines a file suffix as <code>type-map</code>; this is best done
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen with</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <highlight language="config">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom GundersenAddHandler type-map .var
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </highlight>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>in the server configuration file.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>Type map files should have the same name as the resource
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen which they are describing, followed by the extension
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>.var</code>. In the examples shown below, the resource is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen named <code>foo</code>, so the type map file is named
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>foo.var</code>.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>This file should have an entry for each available
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variant; these entries consist of contiguous HTTP-format header
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen lines. Entries for different variants are separated by blank
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen lines. Blank lines are illegal within an entry. It is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen conventional to begin a map file with an entry for the combined
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen entity as a whole (although this is not required, and if
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen present will be ignored). An example map file is shown below.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>URIs in this file are relative to the location of the type map
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen file. Usually, these files will be located in the same directory as
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the type map file, but this is not required. You may provide
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen absolute or relative URIs for any file located on the same server as
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the map file.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo.en.html<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-type: text/html<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-language: en<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo.fr.de.html<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-type: text/html;charset=iso-8859-2<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-language: fr, de<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>Note also that a typemap file will take precedence over the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen filename's extension, even when Multiviews is on. If the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variants have different source qualities, that may be indicated
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen by the "qs" parameter to the media type, as in this picture
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen (available as JPEG, GIF, or ASCII-art): </p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo.jpeg<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-type: image/jpeg; qs=0.8<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo.gif<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-type: image/gif; qs=0.5<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen URI: foo.txt<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Content-type: text/plain; qs=0.01<br />
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</example>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>qs values can vary in the range 0.000 to 1.000. Note that
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen any variant with a qs value of 0.000 will never be chosen.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Variants with no 'qs' parameter value are given a qs factor of
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen 1.0. The qs parameter indicates the relative 'quality' of this
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variant compared to the other available variants, independent
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen of the client's capabilities. For example, a JPEG file is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen usually of higher source quality than an ASCII file if it is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen attempting to represent a photograph. However, if the resource
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen being represented is an original ASCII art, then an ASCII
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representation would have a higher source quality than a JPEG
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen representation. A qs value is therefore specific to a given
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variant depending on the nature of the resource it
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen represents.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>The full list of headers recognized is available in the <a
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen href="mod/mod_negotiation.html#typemaps">mod_negotiation
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen typemap</a> documentation.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</section>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="multiviews"><title>Multiviews</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p><code>MultiViews</code> is a per-directory option, meaning it
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen can be set with an <directive module="core">Options</directive>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen directive within a <directive module="core"
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen type="section">Directory</directive>, <directive module="core"
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen type="section">Location</directive> or <directive module="core"
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen type="section">Files</directive> section in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>httpd.conf</code>, or (if <directive
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen module="core">AllowOverride</directive> is properly set) in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>.htaccess</code> files. Note that <code>Options All</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen does not set <code>MultiViews</code>; you have to ask for it by
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen name.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>The effect of <code>MultiViews</code> is as follows: if the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen server receives a request for <code>/some/dir/foo</code>, if
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>/some/dir</code> has <code>MultiViews</code> enabled, and
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>/some/dir/foo</code> does <em>not</em> exist, then the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen server reads the directory looking for files named foo.*, and
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen effectively fakes up a type map which names all those files,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen assigning them the same media types and content-encodings it
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen would have if the client had asked for one of them by name. It
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen then chooses the best match to the client's requirements.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p><code>MultiViews</code> may also apply to searches for the file
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen named by the <directive
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen module="mod_dir">DirectoryIndex</directive> directive, if the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen server is trying to index a directory. If the configuration files
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen specify</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <highlight language="config">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom GundersenDirectoryIndex index
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </highlight>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>then the server will arbitrate between <code>index.html</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen and <code>index.html3</code> if both are present. If neither
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen are present, and <code>index.cgi</code> is there, the server
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen will run it.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>If one of the files found when reading the directory does not
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen have an extension recognized by <code>mod_mime</code> to designate
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen its Charset, Content-Type, Language, or Encoding, then the result
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen depends on the setting of the <directive
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen module="mod_mime">MultiViewsMatch</directive> directive. This
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen directive determines whether handlers, filters, and other
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen extension types can participate in MultiViews negotiation.</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</section>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</section>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="methods"><title>The Negotiation Methods</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>After httpd has obtained a list of the variants for a given
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen resource, either from a type-map file or from the filenames in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the directory, it invokes one of two methods to decide on the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen 'best' variant to return, if any. It is not necessary to know
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen any of the details of how negotiation actually takes place in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen order to use httpd's content negotiation features. However the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen rest of this document explains the methods used for those
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen interested. </p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>There are two negotiation methods:</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <ol>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li><strong>Server driven negotiation with the httpd
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen algorithm</strong> is used in the normal case. The httpd
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen algorithm is explained in more detail below. When this
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen algorithm is used, httpd can sometimes 'fiddle' the quality
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen factor of a particular dimension to achieve a better result.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen The ways httpd can fiddle quality factors is explained in
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen more detail below.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li><strong>Transparent content negotiation</strong> is used
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen when the browser specifically requests this through the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen mechanism defined in RFC 2295. This negotiation method gives
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the browser full control over deciding on the 'best' variant,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen the result is therefore dependent on the specific algorithms
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen used by the browser. As part of the transparent negotiation
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen process, the browser can ask httpd to run the 'remote
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variant selection algorithm' defined in RFC 2296.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </ol>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="dimensions"><title>Dimensions of Negotiation</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <table>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <columnspec><column width=".15"/><column width=".85"/></columnspec>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <tr valign="top">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <th>Dimension</th>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <th>Notes</th>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </tr>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <tr valign="top">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Media Type</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Browser indicates preferences with the <code>Accept</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen header field. Each item can have an associated quality factor.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Variant description can also have a quality factor (the "qs"
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen parameter).</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </tr>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <tr valign="top">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Language</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Browser indicates preferences with the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>Accept-Language</code> header field. Each item can have
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen a quality factor. Variants can be associated with none, one or
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen more than one language.</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </tr>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <tr valign="top">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Encoding</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Browser indicates preference with the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>Accept-Encoding</code> header field. Each item can have
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen a quality factor.</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </tr>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <tr valign="top">
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Charset</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <td>Browser indicates preference with the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <code>Accept-Charset</code> header field. Each item can have a
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen quality factor. Variants can indicate a charset as a parameter
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen of the media type.</td>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </tr>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen </table>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen</section>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen<section id="algorithm"><title>httpd Negotiation Algorithm</title>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <p>httpd can use the following algorithm to select the 'best'
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen variant (if any) to return to the browser. This algorithm is
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen not further configurable. It operates as follows:</p>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <ol>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>First, for each dimension of the negotiation, check the
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen appropriate <em>Accept*</em> header field and assign a
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen quality to each variant. If the <em>Accept*</em> header for
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen any dimension implies that this variant is not acceptable,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen eliminate it. If no variants remain, go to step 4.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen Select the 'best' variant by a process of elimination. Each
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen of the following tests is applied in order. Any variants
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen not selected at each test are eliminated. After each test,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen if only one variant remains, select it as the best match
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen and proceed to step 3. If more than one variant remains,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen move on to the next test.
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <ol>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>Multiply the quality factor from the <code>Accept</code>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen header with the quality-of-source factor for this variants
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen media type, and select the variants with the highest
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen value.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>Select the variants with the highest language quality
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen factor.</li>
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen <li>Select the variants with the best language match,
eac684ef1c29684b1bcd27a89c38c202e568e469Tom Gundersen using either the order of languages in the
<code>Accept-Language</code> header (if present), or else
the order of languages in the <code>LanguagePriority</code>
directive (if present).</li>
<li>Select the variants with the highest 'level' media
parameter (used to give the version of text/html media
types).</li>
<li>Select variants with the best charset media
parameters, as given on the <code>Accept-Charset</code>
header line. Charset ISO-8859-1 is acceptable unless
explicitly excluded. Variants with a <code>text/*</code>
media type but not explicitly associated with a particular
charset are assumed to be in ISO-8859-1.</li>
<li>Select those variants which have associated charset
media parameters that are <em>not</em> ISO-8859-1. If
there are no such variants, select all variants
instead.</li>
<li>Select the variants with the best encoding. If there
are variants with an encoding that is acceptable to the
user-agent, select only these variants. Otherwise if
there is a mix of encoded and non-encoded variants,
select only the unencoded variants. If either all
variants are encoded or all variants are not encoded,
select all variants.</li>
<li>Select the variants with the smallest content
length.</li>
<li>Select the first variant of those remaining. This
will be either the first listed in the type-map file, or
when variants are read from the directory, the one whose
file name comes first when sorted using ASCII code
order.</li>
</ol>
</li>
<li>The algorithm has now selected one 'best' variant, so
return it as the response. The HTTP response header
<code>Vary</code> is set to indicate the dimensions of
negotiation (browsers and caches can use this information when
caching the resource). End.</li>
<li>To get here means no variant was selected (because none
are acceptable to the browser). Return a 406 status (meaning
"No acceptable representation") with a response body
consisting of an HTML document listing the available
variants. Also set the HTTP <code>Vary</code> header to
indicate the dimensions of variance.</li>
</ol>
</section>
</section>
<section id="better"><title>Fiddling with Quality
Values</title>
<p>httpd sometimes changes the quality values from what would
be expected by a strict interpretation of the httpd
negotiation algorithm above. This is to get a better result
from the algorithm for browsers which do not send full or
accurate information. Some of the most popular browsers send
<code>Accept</code> header information which would otherwise
result in the selection of the wrong variant in many cases. If a
browser sends full and correct information these fiddles will not
be applied.</p>
<section id="wildcards"><title>Media Types and Wildcards</title>
<p>The <code>Accept:</code> request header indicates preferences
for media types. It can also include 'wildcard' media types, such
as "image/*" or "*/*" where the * matches any string. So a request
including:</p>
<example>Accept: image/*, */*</example>
<p>would indicate that any type starting "image/" is acceptable,
as is any other type.
Some browsers routinely send wildcards in addition to explicit
types they can handle. For example:</p>
<example>
Accept: text/html, text/plain, image/gif, image/jpeg, */*
</example>
<p>The intention of this is to indicate that the explicitly listed
types are preferred, but if a different representation is
available, that is ok too. Using explicit quality values,
what the browser really wants is something like:</p>
<example>
Accept: text/html, text/plain, image/gif, image/jpeg, */*; q=0.01
</example>
<p>The explicit types have no quality factor, so they default to a
preference of 1.0 (the highest). The wildcard */* is given a
low preference of 0.01, so other types will only be returned if
no variant matches an explicitly listed type.</p>
<p>If the <code>Accept:</code> header contains <em>no</em> q
factors at all, httpd sets the q value of "*/*", if present, to
0.01 to emulate the desired behavior. It also sets the q value of
wildcards of the format "type/*" to 0.02 (so these are preferred
over matches against "*/*". If any media type on the
<code>Accept:</code> header contains a q factor, these special
values are <em>not</em> applied, so requests from browsers which
send the explicit information to start with work as expected.</p>
</section>
<section id="exceptions"><title>Language Negotiation Exceptions</title>
<p>New in httpd 2.0, some exceptions have been added to the
negotiation algorithm to allow graceful fallback when language
negotiation fails to find a match.</p>
<p>When a client requests a page on your server, but the server
cannot find a single page that matches the
<code>Accept-language</code> sent by
the browser, the server will return either a "No Acceptable
Variant" or "Multiple Choices" response to the client. To avoid
these error messages, it is possible to configure httpd to ignore
the <code>Accept-language</code> in these cases and provide a
document that does not explicitly match the client's request. The
<directive
module="mod_negotiation">ForceLanguagePriority</directive>
directive can be used to override one or both of these error
messages and substitute the servers judgement in the form of the
<directive module="mod_negotiation">LanguagePriority</directive>
directive.</p>
<p>The server will also attempt to match language-subsets when no
other match can be found. For example, if a client requests
documents with the language <code>en-GB</code> for British
English, the server is not normally allowed by the HTTP/1.1
standard to match that against a document that is marked as simply
<code>en</code>. (Note that it is almost surely a configuration
error to include <code>en-GB</code> and not <code>en</code> in the
<code>Accept-Language</code> header, since it is very unlikely
that a reader understands British English, but doesn't understand
English in general. Unfortunately, many current clients have
default configurations that resemble this.) However, if no other
language match is possible and the server is about to return a "No
Acceptable Variants" error or fallback to the <directive
module="mod_negotiation">LanguagePriority</directive>, the server
will ignore the subset specification and match <code>en-GB</code>
against <code>en</code> documents. Implicitly, httpd will add
the parent language to the client's acceptable language list with
a very low quality value. But note that if the client requests
"en-GB; q=0.9, fr; q=0.8", and the server has documents
designated "en" and "fr", then the "fr" document will be returned.
This is necessary to maintain compliance with the HTTP/1.1
specification and to work effectively with properly configured
clients.</p>
<p>In order to support advanced techniques (such as cookies or
special URL-paths) to determine the user's preferred language,
since httpd 2.0.47 <module>mod_negotiation</module> recognizes
the <a href="env.html">environment variable</a>
<code>prefer-language</code>. If it exists and contains an
appropriate language tag, <module>mod_negotiation</module> will
try to select a matching variant. If there's no such variant,
the normal negotiation process applies.</p>
<example><title>Example</title>
<highlight language="config">
SetEnvIf Cookie "language=(.+)" prefer-language=$1
Header append Vary cookie
</highlight>
</example>
</section>
</section>
<section id="extensions"><title>Extensions to Transparent Content
Negotiation</title>
<p>httpd extends the transparent content negotiation protocol (RFC
2295) as follows. A new <code>{encoding ..}</code> element is used in
variant lists to label variants which are available with a specific
content-encoding only. The implementation of the RVSA/1.0 algorithm
(RFC 2296) is extended to recognize encoded variants in the list, and
to use them as candidate variants whenever their encodings are
acceptable according to the <code>Accept-Encoding</code> request
header. The RVSA/1.0 implementation does not round computed quality
factors to 5 decimal places before choosing the best variant.</p>
</section>
<section id="naming"><title>Note on hyperlinks and naming conventions</title>
<p>If you are using language negotiation you can choose between
different naming conventions, because files can have more than
one extension, and the order of the extensions is normally
irrelevant (see the <a
href="mod/mod_mime.html#multipleext">mod_mime</a> documentation
for details).</p>
<p>A typical file has a MIME-type extension (<em>e.g.</em>,
<code>html</code>), maybe an encoding extension (<em>e.g.</em>,
<code>gz</code>), and of course a language extension
(<em>e.g.</em>, <code>en</code>) when we have different
language variants of this file.</p>
<p>Examples:</p>
<ul>
<li>foo.en.html</li>
<li>foo.html.en</li>
<li>foo.en.html.gz</li>
</ul>
<p>Here some more examples of filenames together with valid and
invalid hyperlinks:</p>
<table border="1" cellpadding="8" cellspacing="0">
<columnspec><column width=".2"/><column width=".2"/>
<column width=".2"/></columnspec>
<tr>
<th>Filename</th>
<th>Valid hyperlink</th>
<th>Invalid hyperlink</th>
</tr>
<tr>
<td><em>foo.html.en</em></td>
<td>foo<br />
foo.html</td>
<td>-</td>
</tr>
<tr>
<td><em>foo.en.html</em></td>
<td>foo</td>
<td>foo.html</td>
</tr>
<tr>
<td><em>foo.html.en.gz</em></td>
<td>foo<br />
foo.html</td>
<td>foo.gz<br />
foo.html.gz</td>
</tr>
<tr>
<td><em>foo.en.html.gz</em></td>
<td>foo</td>
<td>foo.html<br />
foo.html.gz<br />
foo.gz</td>
</tr>
<tr>
<td><em>foo.gz.html.en</em></td>
<td>foo<br />
foo.gz<br />
foo.gz.html</td>
<td>foo.html</td>
</tr>
<tr>
<td><em>foo.html.gz.en</em></td>
<td>foo<br />
foo.html<br />
foo.html.gz</td>
<td>foo.gz</td>
</tr>
</table>
<p>Looking at the table above, you will notice that it is always
possible to use the name without any extensions in a hyperlink
(<em>e.g.</em>, <code>foo</code>). The advantage is that you
can hide the actual type of a document rsp. file and can change
it later, <em>e.g.</em>, from <code>html</code> to
<code>shtml</code> or <code>cgi</code> without changing any
hyperlink references.</p>
<p>If you want to continue to use a MIME-type in your
hyperlinks (<em>e.g.</em> <code>foo.html</code>) the language
extension (including an encoding extension if there is one)
must be on the right hand side of the MIME-type extension
(<em>e.g.</em>, <code>foo.html.en</code>).</p>
</section>
<section id="caching"><title>Note on Caching</title>
<p>When a cache stores a representation, it associates it with
the request URL. The next time that URL is requested, the cache
can use the stored representation. But, if the resource is
negotiable at the server, this might result in only the first
requested variant being cached and subsequent cache hits might
return the wrong response. To prevent this, httpd normally
marks all responses that are returned after content negotiation
as non-cacheable by HTTP/1.0 clients. httpd also supports the
HTTP/1.1 protocol features to allow caching of negotiated
responses.</p>
<p>For requests which come from a HTTP/1.0 compliant client
(either a browser or a cache), the directive <directive
module="mod_negotiation">CacheNegotiatedDocs</directive> can be
used to allow caching of responses which were subject to
negotiation. This directive can be given in the server config or
virtual host, and takes no arguments. It has no effect on requests
from HTTP/1.1 clients.</p>
<p>For HTTP/1.1 clients, httpd sends a <code>Vary</code> HTTP
response header to indicate the negotiation dimensions for the
response. Caches can use this information to determine whether a
subsequent request can be served from the local copy. To
encourage a cache to use the local copy regardless of the
negotiation dimensions, set the <code>force-no-vary</code> <a
href="env.html#special">environment variable</a>.</p>
</section>
</manualpage>