previous next

Appendix B: Configuration File Syntax

This appendix describes the structure of the configuration file.

Configuration File Components

The configuration file is constructed entirely of tags. There are four types of tags in this file: the XML declaration tag, optional comment tags, list tags, and variable tags.

Of these four types, only two make up the instructions to RealServer: lists and variables. Lists are used for instructions that have several parts, such as the MIME types or the multicast instructions. A list tag is followed by one or more list tags or variable tags.

All values for lists and variables are enclosed in double quotation marks.

XML Declaration Tag

The XML declaration tag indicates which version of XML is in use. RealServer 8 uses XML version 1.0. The declaration tag looks like this:


<?XML Version="1.0" ?>

Comment Tags

Comment tags are used in the configuration file to identify the functions of tags, but the comments aren't required. XML comment tags are just like those in HTML: they begin with <!-- and end with -->. RealServer ignores these tags; they are for your benefit.

For example, this comment tag lets the administrator know that the parameters after it refer to the path settings:


<!-- P A T H S -->

Tip
To disable a feature, convert the feature's tag or tags to a comment. Rather than converting each tag to a comment, edit only the feature's first opening tag and last closing tag.

Do not nest comment tags within other comment tags.

List Tags

The list tag uses the following syntax:


<List Name="name">

...

</List>

where name is the list title. Using the correct capitalization for name is important.

Other lists or variables follow the list. The </List> tag signifies the end of the list. If other lists are inside the original list, they must also have closing </List> tags. The MIMETypes list is an example of a list that contains other lists.

Tip
Indenting list items is not required, but is recommended for clarity.

Variable Tags

Variable tags use the following syntax:


<Var name="value"/>

where name is the variable title, and value is a string or a number, depending on the variable. Capitalization for both name and value is important.

Unlike lists, variables do not have a closing tag; instead, a forward slash mark (/) appears before the closing angle bracket (>).

Tip
If you've restarted RealServer and it's not responding to a change you've made to a variable, make sure the variable has a closing forward slash mark, and that there is no space between them.

Variables can be independent elements (such as LogPath) or they may appear inside a list. When variables appear within a list, their meaning is determined by the value of the list name, although they may be apparently identical in syntax to variables that are not inside lists. If there are multiple variables within a list that do similar things, their names must be unique. For example, the Extension variables within each MIMETypes list must have different names; this is accomplished by adding a number to the end of each (Extension_01, Extension_02, and so on).


Copyright © 2000 RealNetworks
For information on RealNetworks' technical support, click here.
Comments on this document? Click here.
This file last updated on 11/28/00 at 17:35:17.
previous next