srm.conf - Detailed Explanation


The following is a detailed explanation of the directives found in srm.conf. The links take you to the NCSA documentation for each directive.


DocumentRoot

Possible values: a complete pathname, specified from root
NCSA default: /usr/local/etc/httpd/htdocs
Recommended value: your ServerRoot directory

This is the directory where all of your HTML documents will be placed. Files outside this directory can be accessed by using:


UserDir

Possible values: a partial pathname, relative to user home directories
NCSA default: public_html
Recommended value: public_html

If you would like any user to be able to make documents available on your server without placing them in the DocumentRoot directory, define this directive. Then any file placed in a directory named UserDir in the user's home directory could be accessed with a URL like http://WebRoot/~Username/UserDir. To disable this feature, set this directive to "DISABLED".


DirectoryIndex

Possible values: a filename
NCSA default: index.html
Recommended value: index.html

When responding to a query that points to a filesystem, the server can either generate an index automatically, or return a prewritten index. If you want to write prewritten indexes, create HTML files with the same name as the value of this directive.


AccessFileName

Possible values: a filename
NCSA default: .htaccess
Recommended value: .htaccess

This directive sets the name for the per-directory Access Control Files (ACFs) that the server will look for. Use ACFs to override the access configuration found in access.conf.


AddType

Possible values: type/subtype extension
NCSA default: in mime.types
Recommended value: use as needed

Use this directive to extend the types information in the MIME types configuration file. It associates a type with a file based on the filename extension.

You may use as many AddType directives as you wish.


AddEncoding

Possible values: type extension
NCSA default: none
Recommended value: use as needed

Use this directive to associate an encoding type with a file. It associates an encoding with a file based on the filename extension.

You may use as many AddEncoding directives as you wish.


DefaultType

Possible values: type/subtype
NCSA default: text/html
Recommended value: text/html

If the server cannot determine the type of a file through any other means, it assumes the file is of the type specified by this directive.


Redirect

Possible values: virtual URL
NCSA default: none
Recommended value: use as needed

Use this directive when a document of directory on your server moves to another location. Set virtual to the document that moved, and URL to the new URL for the document.

You may use as many Redirect directives as you wish.


Alias

Possible values: virtual path
NCSA default: none
Recommended value: /icons/ /Web/httpd/icons/

This directive creates virtual directories or files on your server. Think of it as a "symbolic link" interpreted by the server instead of the filesystem. You will want to create at least one of these to refer to the directory where your icons are stored.

You may use as many Alias directives as you wish.


ScriptAlias

Possible values: virtual path
NCSA default: none
Recommended value: /cgi-bin/ /Web/httpd/cgi-bin/

This directive creates a virtual directory on your server. Accesses to files in this directory will return the output of the named CGI script. You will want to create at least one of these to refer to the directory where your CGI scripts are stored.

You may use as many ScriptAlias directives as you wish.


OldScriptAlias

Possible values: virtual path
NCSA default: none
Recommended value: use as needed

This directive creates a virtual directory on your server. Accesses to files in this directory will return the output of the named NCSA server script. If you use NCSA server scripts, create one of these to refer to the directory where they are stored.

You may use as many OldScriptAlias directives as you wish.


FancyIndexing

Possible values: on or off
NCSA default: off
Recommended value: on

This directive determines whether the server returns directory indexes with icons and file sizes, or plain directory listings. For local or NFS filesystems, set this directive to on. For AFS filesystems, turn this directive off.


DefaultIcon

Possible values: a virtual path
NCSA default: none
Recommended value: /icons/unknown.xbm

This directive determines what icon is used in automatically generated directory listings when there is no other icon information for the file.


ReadmeName

Possible values: a filename
NCSA default: none
Recommended value: README

When generating automatic directory listings, the server will look for a file with this name, first with the suffix .html added, then without. Its contents will added to the end of the directory listing.


HeaderName

Possible values: a filename
NCSA default: none
Recommended value: HEADER

When generating automatic directory listings, the server will look for a file with this name, first with the suffix .html added, then without. Its contents will added to the beginning of the directory listing.


AddDescription

Possible values: "text" fileid
NCSA default: none
Recommended value: use as needed

This directive gives the server descriptions to use in automatically generated directory listings.

You may use as many AddDescription directives as you wish.


AddIcon

Possible values: icon name1 name2 ...
NCSA default: none
Recommended value: use as needed

This directive sets the icons to use for files in automatically generated directory listings, based on the files name or location. The icon field is a virtual path to the icon, and the names are one of the following:

You may use as many AddIcon directives as you wish.


AddIconByType

Possible values: icon type1 type2 ...
NCSA default: none
Recommended value: use as needed

This directive sets the icons to use for files in automatically generated directory listings, based on the MIME type of the file. icon is a virtual path to an icon. types are the MIME types for which to apply this icon.

You may use as many AddIconByType directives as you wish.


AddIconByEncoding

Possible values: icon name1 name2 ...
NCSA default: none
Recommended value: use as needed

This directive sets the icons to use for files in automatically generated directory listings, based on the encoding of the file. icon is a virtual path to an icon. Alternately, use the syntax (alt,icon) to specify an ALT tag to be inserted for text-mode browsers. names are encoding types for which to apply this icon.

You may use as many AddIconByEncoding directives as you wish.


IndexIgnore

Possible values: pat1pat2 ...
NCSA default: .
Recommended value: .

This directive specifies filenames file names or name patterns to ignore when creating automatically generated directory listings.


IndexOptions

Possible values: one of several options
NCSA default: none
Recommended value: FancyIndexing

This directive sets options for automatically generated directory listings. Use one or more of the following:


Nathan C. Bush / httpd/srm.conf.d.html / srm.conf - Detailed Explanation
Last revision date: July 28, 1994