<?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="uac.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
	<revhistory>
	    <revision>
		<revnumber>$Revision: 1.2 $</revnumber>
		<date>$Date: 2005/08/24 13:24:35 $</date>
	    </revision>
	</revhistory>
    </sectioninfo>

    <title>Parameters</title>

    <section id="from_store_param">
	<title><varname>from_store_param</varname> (string)</title>
	<para>
	    Name of FROM header parameter that will be used to store (encoded)
	    the original FROM URI.
	</para>
	<para>
	    This parameter is optional, it's default value being "vsf".
	</para>
	<example>
	    <title>Set <varname>from_store_param</varname> parameter</title>
	    <programlisting>
...
modparam("uac","from_store_param","my_param")
...
	    </programlisting>
	</example>
    </section>

    <section id="from_restore_mode">
	<title><varname>from_restore_mode</varname> (integer)</title>
	<para>
	    There are 3 mode of restoring the original FROM URI:
	    <itemizedlist>
		<listitem>
		    <para>
			0 - NO RESTORE - no information about original URI is stored.
		    </para>
		</listitem>
		<listitem>
		    <para>
			1 - AUTO RESTORE - all sequential request will be 
			automatically updated based on stored original URI.
		    </para>
		</listitem>
		<listitem>
		    <para>
			2 - MANUAL RESTORE - all sequential requests/replies must 
			be manually updated based on original URI.
		    </para>
		</listitem>
	    </itemizedlist>
	</para>
	<para>
	    This parameter is optional, it's default value being 0.
	</para>
	<example>
	    <title>Set <varname>from_restore_mode</varname> parameter
	    </title>
	    <programlisting>
...
modparam("uac","from_restore_mode","1")
...
	    </programlisting>
	</example>
    </section>

    <section id="credentials">
	<title><varname>credential</varname> (string)</title>
	<para>
	    Contains a multiple definition of credentials used to perform
	    authentication.
	</para>
	<para>
	    This parameter is required if UAC authentication is used.
	</para>
	<example>
	    <title>Set <varname>credential</varname> parameter</title>
	    <programlisting>
...
modparam("uac","credential","username:domain:password")
...
	    </programlisting>
	</example>
    </section>

</section>
