kamailio/misc/obsolete/options/doc/params.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="options.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
    </sectioninfo>

    <title>Parameters</title>

    <section id="accept">
	<title><varname>accept</varname> (string)</title>
	<para>
	    This parameter is the content of the Accept header field.  Note: it
	    is not clearly written in RFC3261 if a proxy should accept any
	    content (the default "*/*") because it does not care
	    about content. Or if it does not accept any content, which is
	    "".
	</para>
	<para>
	    Default value is "*/*".
	</para>
	<example>
	    <title>Set <varname>accept</varname> parameter</title>
	    <programlisting>
...
modparam("options", "accept", "application/*")
...
	    </programlisting>
	</example>
    </section>

    <section id="accept_encoding">
	<title><varname>accept_encoding</varname> (string)</title>
	<para>
	    This parameter is the content of the Accept-Encoding header field.
	    Please do not change the default value because SER does not support
	    any encodings yet.
	</para>
	<para>
	    Default value is "".
	</para>
	<example>
	    <title>Set <varname>accept_encoding</varname> parameter</title>
	    <programlisting>
...
modparam("options", "accept_encoding", "gzip")
...
	    </programlisting>
	</example>
    </section>

    <section id="accept_language">
	<title><varname>accept_language</varname> (string)</title>
	<para>
	    This parameter is the content of the Accept-Language header field.
	    You can set any language code which you prefer for error
	    descriptions from other devices, but presumably there are not much
	    devices around which support other languages then the default
	    English.
	</para>
	<para>
	    Default value is "en".
	</para>
	<example>
	    <title>Set <varname>accept_language</varname> parameter</title>
	    <programlisting>
...
modparam("options", "accept_language", "de")
...
	    </programlisting>
	</example>
    </section>
    
    <section id="options.supported">
	<title><varname>supported</varname> (string)</title>
	<para>
	    This parameter is the content of the Supported header field  Here
	    you can enter the extensions which are supported by your SER config.
	    Normally you should only use values here which are registered with the
	    IANA.
	</para>
	<para>
	    Default value is "".
	</para>
	<example>
	    <title>Set <varname>supported</varname> parameter</title>
	    <programlisting>
...
modparam("options", "supported", "100rel")
...
	    </programlisting>
	</example>
    </section>

    <section id="options.contact">
	<title><varname>contact</varname> (string)</title>
	<para>
	    The content of this parameter will be inserted into the reply as the
		URI of the Contact header. If this parameter is empty (default case)
		then no Contact header in included in the reply. If this parameter
		is set to "dstip" the reply contains a Contact header with the
		IP, port and transport of the socket where the request was sent to.
		If this parameter is set to "ruri" the reply contains a Contact header
		with the same URI as the request URI of the original OPTIONS request.
	</para>
	<para>
	    Default value is "".
	</para>
	<example>
	    <title>Set <varname>contact</varname> parameter</title>
	    <programlisting>
...
modparam("options", "contact", "example.com")
...
	    </programlisting>
	</example>
    </section>

    <section id="options.contact_param">
	<title><varname>contact_param</varname> (string)</title>
	<para>
	    This parameter is appended to the value of the Contact header is
		case it is set. If just this parameter is set but the contact module
		parameter not, then the contact parameter is automatically set to
		dstip.
	</para>
	<para>
	    Default value is "".
	</para>
	<example>
	    <title>Set <varname>contact_param</varname> parameter</title>
	    <programlisting>
...
modparam("options", "contact_param", "lr=on")
...
	    </programlisting>
	</example>
    </section>

</section>