Skip to content

Commit

Permalink
siputils: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@miconda
miconda committed Nov 13, 2023
1 parent 0e4c3e1 commit e69484a
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
12 changes: 6 additions & 6 deletions src/modules/siputils/doc/siputils.xml
View file
Expand Up @@ -43,7 +43,7 @@
<email>jan@iptel.org</email>
</address>
</author>

<author>
<firstname>Daniel-Constantin</firstname>
<surname>Mierla</surname>
Expand Down Expand Up @@ -78,7 +78,7 @@
<email>jan@iptel.org</email>
</address>
</editor>

<editor>
<firstname>Bogdan-Andrei</firstname>
<surname>Iancu</surname>
Expand All @@ -94,7 +94,7 @@
<email>vasile@fokus.fraunhofer.de</email>
</address>
</editor>

</authorgroup>
<copyright>
<year>2008</year>
Expand All @@ -107,8 +107,8 @@

</bookinfo>
<toc></toc>

<xi:include href="siputils_admin.xml"/>


</book>
76 changes: 38 additions & 38 deletions src/modules/siputils/doc/siputils_admin.xml
View file
Expand Up @@ -71,8 +71,8 @@
<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 <quote>*/*</quote>) because
it does not care about content. Or if it does not accept
accept any content (the default <quote>*/*</quote>) because
it does not care about content. Or if it does not accept
any content, which is <quote></quote>.
</para>
<para>
Expand All @@ -93,7 +93,7 @@ modparam("siputils", "options_accept", "application/*")
<title><varname>options_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 &kamailio;
Please do not change the default value because &kamailio;
does not support any encodings yet.
</para>
<para>
Expand All @@ -114,13 +114,13 @@ modparam("siputils", "options_accept_encoding", "gzip")
<section id="siputils.p.contact_flds_separator">
<title><varname>contact_flds_separator</varname> (string)</title>
<para>
First char of this parameter is used as separator for encoding/decoding
First char of this parameter is used as separator for encoding/decoding
Contact header.
</para>
<warning>
<para>
First char of this field must be set to a value which is not used
inside username, password or other fields of contact. Otherwise it
First char of this field must be set to a value which is not used
inside username, password or other fields of contact. Otherwise it
is possible for the decoding step to fail/produce wrong results.
</para>
</warning>
Expand All @@ -138,7 +138,7 @@ modparam("siputils", "contact_flds_separator", "-")
</programlisting>
</example>
<para>
then an encoded uri might look
then an encoded uri might look
sip:user-password-ip-port-protocol@PublicIP
</para>
</section>
Expand All @@ -148,9 +148,9 @@ modparam("siputils", "contact_flds_separator", "-")
<title><varname>options_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
You can set any language code which you prefer for error
descriptions from other devices, but presumably there are not
many devices around which support other languages than the
many devices around which support other languages than the
default English.
</para>
<para>
Expand All @@ -172,7 +172,7 @@ modparam("siputils", "options_accept_language", "de")
<para>
This parameter is the content of the Support header field,
indicating SIP extensions.
Please do not change the default value, because &kamailio; currently
Please do not change the default value, because &kamailio; currently
does not support any of the SIP extensions registered at the IANA.
</para>
<para>
Expand All @@ -192,7 +192,7 @@ modparam("siputils", "options_support", "100rel")
<section id="siputils.p.rpid_prefix">
<title><varname>rpid_prefix</varname> (string)</title>
<para>
Prefix to be added to Remote-Party-ID header field just before
Prefix to be added to Remote-Party-ID header field just before
the URI returned from either radius or database.
</para>
<para>
Expand All @@ -208,11 +208,11 @@ modparam("siputils", "rpid_prefix", "Whatever &lt;")
<section id="siputils.p.rpid_suffix">
<title><varname>rpid_suffix</varname> (string)</title>
<para>
Suffix to be added to Remote-Party-ID header field after the URI
Suffix to be added to Remote-Party-ID header field after the URI
returned from either radius or database.
</para>
<para>
Default value is
Default value is
<quote>;party=calling;id-type=subscriber;screen=yes</quote>.
</para>
<example>
Expand All @@ -225,13 +225,13 @@ modparam("siputils", "rpid_suffix", "@1.2.3.4>")
<section id="siputils.p.rpid_avp">
<title><varname>rpid_avp</varname> (string)</title>
<para>
Full AVP specification for the AVP which
Full AVP specification for the AVP which
stores the RPID value. It used to transport the RPID value from
authentication backend modules (auth_db or auth_radius) or from
script to the auth function append_rpid_hf and is_rpid_user_e164.
</para>
<para>
If defined to NULL string, all RPID functions will fail at
If defined to NULL string, all RPID functions will fail at
runtime.
</para>
<para>
Expand Down Expand Up @@ -270,7 +270,7 @@ modparam("siputils", "e164_max_len", 20)
<para>
This function checks if the request method is OPTIONS and
if the request URI does not contain a username. If both
are true the request will be answered stateless with
are true the request will be answered stateless with
<quote>200 OK</quote> and the capabilities from the modules
parameters.
</para>
Expand Down Expand Up @@ -776,7 +776,7 @@ if (is_alphanumex("$rU", "+.-_")) {
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>encoding_prefix</emphasis> - Something to allow us
<para><emphasis>encoding_prefix</emphasis> - Something to allow us
to determine that a contact is encoded.
</para>
</listitem>
Expand All @@ -792,7 +792,7 @@ if (is_alphanumex("$rU", "+.-_")) {
<title><function>encode_contact</function> usage</title>
<programlisting format="linespecific">
...
if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4");
if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4");
...
</programlisting>
</example>
Expand Down Expand Up @@ -830,9 +830,9 @@ if (uri =~ "^sip:natted_client") { decode_contact(); }
<function moreinfo="none">decode_contact_header()</function>
</title>
<para>
This function will decode &uri;s inside Contact header. If the URI in the format
This function will decode &uri;s inside Contact header. If the URI in the format
sip:encoding_prefix*username*ip*port*protocol@hostpart it will be decoded to
sip:username:password@ip:port;transport=protocol. It uses the
sip:username:password@ip:port;transport=protocol. It uses the
default set parameter for contact encoding separator.
</para>
<para>
Expand Down Expand Up @@ -860,7 +860,7 @@ reply_route[2] {
<function moreinfo="none">cmp_uri(str1, str2)</function>
</title>
<para>
The function returns <emphasis>true</emphasis> if
The function returns <emphasis>true</emphasis> if
the two parameters matches as SIP URI.
</para>
<para>
Expand Down Expand Up @@ -931,9 +931,9 @@ if(cmp_hdr_name("$var(hname)", "From"))
<function moreinfo="none">append_rpid_hf()</function></title>
<para>
Appends to the message a Remote-Party-ID header that contains header
'Remote-Party-ID: ' followed by the saved value of the SIP URI
received from the database or radius server followed by the value of
module parameter radius_rpid_suffix. The function does nothing if
'Remote-Party-ID: ' followed by the saved value of the SIP URI
received from the database or radius server followed by the value of
module parameter radius_rpid_suffix. The function does nothing if
no saved SIP URI exists.
</para>
<para>
Expand All @@ -954,25 +954,25 @@ append_rpid_hf(); # Append Remote-Party-ID header field
<function moreinfo="none">append_rpid_hf(prefix, suffix)</function>
</title>
<para>
This function is the same as
This function is the same as
<xref linkend="siputils.f.append_rpid_hf"/>. The only difference is
that it accepts two parameters--prefix and suffix to be added to
Remote-Party-ID header field. This function ignores rpid_prefix and
rpid_suffix parameters, instead of that allows to set them in every
that it accepts two parameters--prefix and suffix to be added to
Remote-Party-ID header field. This function ignores rpid_prefix and
rpid_suffix parameters, instead of that allows to set them in every
call.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>prefix</emphasis> - Prefix of the
Remote-Party-ID URI. The string will be added at the beginning of
<para><emphasis>prefix</emphasis> - Prefix of the
Remote-Party-ID URI. The string will be added at the beginning of
the body of the header field, just before the URI.
</para>
</listitem>
<listitem>
<para><emphasis>suffix</emphasis> - Suffix of the Remote-Party-ID
header field. The string will be appended at the end of the
header field. It can be used to set various URI parameters,
<para><emphasis>suffix</emphasis> - Suffix of the Remote-Party-ID
header field. The string will be appended at the end of the
header field. It can be used to set various URI parameters,
for example.
</para>
</listitem>
Expand All @@ -996,10 +996,10 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
<function moreinfo="none">is_rpid_user_e164()</function>
</title>
<para>
The function checks if the SIP URI received from the database or
radius server and will potentially be used in Remote-Party-ID header
field contains an E164 number (+followed by up to 15 decimal digits)
in its user part. Check fails, if no such SIP URI exists
The function checks if the SIP URI received from the database or
radius server and will potentially be used in Remote-Party-ID header
field contains an E164 number (+followed by up to 15 decimal digits)
in its user part. Check fails, if no such SIP URI exists
(i.e. radius server or database didn't provide this information).
</para>
<para>
Expand Down Expand Up @@ -1140,7 +1140,7 @@ if(is_gruu()) { ... }
in Supported header(s) (if any) of the request.
Currently the following options are known: path,
100rel, timer, eventlist, gruu, and outbound.

</para>
<para>
This function can be used from ANY_ROUTE.
Expand Down

0 comments on commit e69484a

Please sign in to comment.