Text of httpd.apache.org › docs › trunk › content-negotiation.html as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Content Negotiation - Apache HTTP Server Version 2.5

Modules | Directives | FAQ | Glossary | Sitemap | Report a bug Apache HTTP Server Version 2.5 Apache > HTTP Server > Documentation > Version 2.5 Content Negotiation Available Languages: en | fr | ja | ko | tr Apache HTTPD supports content negotiation as described in the HTTP/1.1 specification. It can choose the best representation of a resource based on the browser-supplied preferences for media type, languages, character set and encoding.

It also implements a couple of features to give more intelligent handling of requests from browsers that send incomplete negotiation information. Content negotiation is provided by the mod_negotiation module, which is compiled in by default. About Content Negotiation Negotiation in httpd The Negotiation Methods Fiddling with Quality Values Extensions to Transparent Content Negotiation Note on hyperlinks and naming conventions Note on Caching About Content Negotiation ¶ A resource may be available in several different representations.

For example, it might be available in different languages or different media types, or a combination. One way of selecting the most appropriate choice is to give the user an index page, and let them select. However it is often possible for the server to choose automatically. This works because browsers can send, as part of each request, information about what representations they prefer. For example, a browser could indicate that it would like to see information in French, if possible, else English will do.

Browsers indicate their preferences by headers in the request. To request only French representations, the browser would send Accept-Language: fr Note that this preference will only be applied when there is a choice of representations and they vary by language. As an example of a more complex request, this browser has been configured to accept French and English, but prefer French, and to accept various media types, preferring HTML over plain text or other text types, and preferring GIF or JPEG over other media types, but also allowing any other media type as a last resort: Accept-Language: fr; q=1.0, en; q=0.5 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 httpd supports 'server driven' content negotiation, as defined in the HTTP/1.1 specification.

It fully supports the Accept , Accept-Language , Accept-Charset and Accept-Encoding request headers. httpd also supports 'transparent' content negotiation, which is an experimental negotiation protocol defined in RFC 2295 and RFC 2296. It does not offer support for 'feature negotiation' as defined in these RFCs. A resource is a conceptual entity identified by a URI (RFC 2396). An HTTP server like Apache HTTP Server provides access to representations of the resource(s) within its namespace, with each representation in the form of a sequence of bytes with a defined media type, character set, encoding, etc.

Each resource may be associated with zero, one, or more than one representation at any given time. If multiple representations are available, the resource is referred to as negotiable and each of its representations is termed a variant . The ways in which the variants for a negotiable resource vary are called the dimensions of negotiation. Negotiation in httpd ¶ In order to negotiate a resource, the server needs to be given information about each of the variants.

This is done in one of two ways: Using a type map ( i.e. , a *.var file) which names the files containing the variants explicitly, or Using a 'MultiViews' search, where the server does an implicit filename pattern match and chooses from among the results. Using a type-map file A type map is a document which is associated with the handler named type-map (or, for backwards-compatibility with older httpd configurations, the MIME-type application/x-type-map ).

Note that to use this feature, you must have a handler set in the configuration that defines a file suffix as type-map ; this is best done with AddHandler type-map .var in the server configuration file. Type map files should have the same name as the resource which they are describing, followed by the extension .var . In the examples shown below, the resource is named foo , so the type map file is named foo.var . This file should have an entry for each available variant; these entries consist of contiguous HTTP-format header lines.

Entries for different variants are separated by blank lines. Blank lines are illegal within an entry. It is conventional to begin a map file with an entry for the combined entity as a whole (although this is not required, and if present will be ignored). An example map file is shown below. URIs in this file are relative to the location of the type map file. Usually, these files will be located in the same directory as the type map file, but this is not required.

You may provide absolute or relative URIs for any file located on the same server as the map file. URI: foo URI: foo.en.html Content-type: text/html Content-language: en URI: foo.fr.de.html Content-type: text/html;charset=iso-8859-2 Content-language: fr, de Note also that a typemap file will take precedence over the filename's extension, even when Multiviews is on. If a .var type map file is found during a Multiviews directory scan, the server will use only the variants listed in that type map file.

Any other files in the directory that match the base name but are not listed in the type map will be ignored entirely. For example, if foo.var exists and lists only foo.en.html and foo.fr.de.html , then a file foo.mn.html present in the same directory will never be served through negotiation, even if the client requests Mongolian. To make such a variant available, it must be added to the type map file. This behavior is important for sites that are adding new language variants over time.

If you have an existing resource foo.html and later add translated variants with language extensions, you should list all variants (including the original) in the type map file. The original file can be assigned its language in the type map without being renamed: URI: foo URI: foo.html Content-type: text/html Content-language: en URI: foo.fr.html Content-type: text/html Content-language: fr If the variants have different source qualities, that may be indicated by the "qs" parameter to the media type, as in this picture (available as JPEG, GIF, or ASCII-art): URI: foo URI: foo.jpeg Content-type: image/jpeg; qs=0.8 URI: foo.gif Content-type: image/gif; qs=0.5 URI: foo.txt Content-type: text/plain; qs=0.01 qs values can vary in the range 0.000 to 1.000.

Note that any variant with a qs value of 0.000 will never be chosen. Variants with no 'qs' parameter value are given a qs factor of 1.0. The qs parameter indicates the relative 'quality' of this variant compared to the other available variants, independent of the client's capabilities. For example, a JPEG file is usually of higher source quality than an ASCII file if it is attempting to represent a photograph. However, if the resource being represented is an original ASCII art, then an ASCII representation would have a higher source quality than a JPEG representation.

A qs value is therefore specific to a given variant depending on the nature of the resource it represents. The full list of headers recognized is available in the mod_negotiation typemap documentation. Multiviews MultiViews is a per-directory option, meaning it can be set with an Options directive within a <Directory> , <Location> or <Files> section in httpd.conf , or (if AllowOverride is properly set) in .htaccess files.

Note that Options All does not set MultiViews ; you have to ask for it by name. The effect of MultiViews is as follows: if the server receives a request for /some/dir/foo , if /some/dir has MultiViews enabled, and /some/dir/foo does not exist, then the server reads the directory looking for files named foo.*, and effectively fakes up a type map which names all those files, as

The rest of this page is on the live site.