Browse Source

uac: docs - fixed types of some params and removed trailing white spaces

Daniel-Constantin Mierla 7 years ago
parent
commit
84f30a2207
1 changed files with 20 additions and 20 deletions
  1. 20 20
      src/modules/uac/doc/uac_admin.xml

+ 20 - 20
src/modules/uac/doc/uac_admin.xml

@@ -90,7 +90,7 @@
 		<section>
 			<title>External Libraries or Applications</title>
 			<para>
-				The following libraries or applications must be installed 
+				The following libraries or applications must be installed
 				before running &kamailio; with this module loaded:
 				<itemizedlist>
 				<listitem>
@@ -108,12 +108,12 @@
 		<section id="uac.p.rr_from_store_param">
 			<title><varname>rr_from_store_param</varname> (string)</title>
 			<para>
-			Name of Record-Route header parameter that will be used to store 
+			Name of Record-Route header parameter that will be used to store
 			an encoded version of the original FROM URI.
 			</para>
 			<para>
 				<emphasis>
-					This parameter is optional, it's default value being 
+					This parameter is optional, it's default value being
 					<quote>vsf</quote>.
 				</emphasis>
 			</para>
@@ -129,12 +129,12 @@ modparam("uac","rr_from_store_param","my_param")
 		<section id="uac.p.rr_to_store_param">
 			<title><varname>rr_to_store_param</varname> (string)</title>
 			<para>
-			Name of Record-Route header parameter that will be used to store 
+			Name of Record-Route header parameter that will be used to store
 			(encoded) the original TO URI.
 			</para>
 			<para>
 				<emphasis>
-					This parameter is optional, it's default value being 
+					This parameter is optional, it's default value being
 					<quote>vst</quote>.
 				</emphasis>
 			</para>
@@ -154,20 +154,20 @@ modparam("uac","rr_to_store_param","my_param")
 			<itemizedlist>
 			<listitem>
 				<para>
-				<quote>none</quote> - no information about original URI is 
+				<quote>none</quote> - no information about original URI is
 				stored; restoration is not possible.
 				</para>
 			</listitem>
 			<listitem>
 				<para>
 				<quote>manual</quote> - all following replies will be restored,
-				but not also the sequential requests - this must be manually 
+				but not also the sequential requests - this must be manually
 				updated based on original URI.
 				</para>
 			</listitem>
 			<listitem>
 				<para>
-				<quote>auto</quote> - all sequential requests and replies will 
+				<quote>auto</quote> - all sequential requests and replies will
 				be automatically updated based on stored original URI. For this
 				option you have to set <quote>modparam("rr", "append_fromtag", 1)</quote>.
 				</para>
@@ -176,7 +176,7 @@ modparam("uac","rr_to_store_param","my_param")
 			</para>
 			<para>
 				<emphasis>
-					This parameter is optional, it's default value being 
+					This parameter is optional, it's default value being
 					<quote>auto</quote>.
 				</emphasis>
 			</para>
@@ -263,7 +263,7 @@ modparam("uac","restore_from_avp","$avp(original_uri_from)")
 			If defined and restore_mode is manual or auto, the avp is used to save
 			the original To URI in order to be able to restore it in replies.
 			That makes sense if the original-uri can not be extracted from the original
-			request, e.g. if msg_apply_changes() was used after calling uac_replace_to()  
+			request, e.g. if msg_apply_changes() was used after calling uac_replace_to()
 			</para>
 			<para>
 				If you create a dialog ( with dlg_manage() ) before calling or uac_replace_to(),
@@ -314,10 +314,10 @@ modparam("uac","credential","username:domain:password")
 			This can be used if the realm upstream will be using is not known in advance.
 			</para>
 			<para><emphasis>
-				If you define it, you also need to define 
-				<quote>auth_username_avp</quote> 
-				(<xref linkend="uac.p.auth-username-avp-id"/>) and 
-				<quote>auth_username_avp</quote> 
+				If you define it, you also need to define
+				<quote>auth_username_avp</quote>
+				(<xref linkend="uac.p.auth-username-avp-id"/>) and
+				<quote>auth_username_avp</quote>
 				(<xref linkend="uac.p.auth-password-avp-id"/>).
 			</emphasis></para>
 			<example>
@@ -336,10 +336,10 @@ modparam("uac","auth_realm_avp","$avp(i:10)")
 			to perform authentication.
 			</para>
 			<para><emphasis>
-				If you define it, you also need to define 
-				<quote>auth_realm_avp</quote> 
-				(<xref linkend="uac.p.auth-realm-avp-id"/>) and 
-				<quote>auth_username_avp</quote> 
+				If you define it, you also need to define
+				<quote>auth_realm_avp</quote>
+				(<xref linkend="uac.p.auth-realm-avp-id"/>) and
+				<quote>auth_username_avp</quote>
 				(<xref linkend="uac.p.auth-password-avp-id"/>).
 			</emphasis></para>
 			<example>
@@ -392,7 +392,7 @@ modparam("uac", "reg_db_url",
 		</section>
 
 		<section id="uac.p.reg_timer_interval">
-			<title><varname>reg_timer_interval</varname> (string)</title>
+			<title><varname>reg_timer_interval</varname> (int)</title>
 			<para>
 			Timer interval (in seconds) at which registrations are managed, e.g. renewed as needed.
 			</para>
@@ -488,7 +488,7 @@ modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
 		</section>
 
 		<section id="uac.p.reg_keep_callid">
-			<title><varname>reg_keep_callid</varname> (string)</title>
+			<title><varname>reg_keep_callid</varname> (int)</title>
 			<para>
 			If set to 0 (default), a new Call-Id will be generated for each
 			registration attempt.