diff --git a/src/modules/registrar/doc/registrar.xml b/src/modules/registrar/doc/registrar.xml
index 7e425dc6c90..a761ed41eae 100644
--- a/src/modules/registrar/doc/registrar.xml
+++ b/src/modules/registrar/doc/registrar.xml
@@ -54,8 +54,8 @@
-
+
-
+
diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml
index a83607423e4..848e5ae40e1 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -21,35 +21,35 @@
PATH support
- The Register module includes Path support (according to RFC 3327)
+ The Register module includes Path support (according to RFC 3327)
for usage in registrars and home-proxies.
If path support is enabled in the registrar module, a call to save(...)
- stores the values of the Path Header(s) along with the contact into usrloc.
+ stores the values of the Path Header(s) along with the contact into usrloc.
There are three modes regarding the reply to a REGISTER including
one or more Path header fields:
- off - stores the value of the
- Path headers into usrloc without passing it back to
+ off - stores the value of the
+ Path headers into usrloc without passing it back to
the UAC in the reply.
- lazy - stores the Path header and
- passes it back to the UAC if Path-support is indicated
+ lazy - stores the Path header and
+ passes it back to the UAC if Path-support is indicated
by the path
param in the Supported header field.
- strict - rejects the registration
- with 420 Bad Extension
if there's a Path
- header but no support for it is indicated by the UAC.
+ strict - rejects the registration
+ with 420 Bad Extension
if there's a Path
+ header but no support for it is indicated by the UAC.
Otherwise it's stored and passed back to the UAC.
@@ -66,7 +66,7 @@
The whole process is transparent to the user, so no
config changes are required beside setting the
- registrar-parameters use_path
and
+ registrar-parameters use_path
and
path_mode
.
@@ -86,7 +86,7 @@
contact validity.
-
+
@@ -113,7 +113,7 @@
External Libraries or Applications
- The following libraries or applications must be installed before
+ The following libraries or applications must be installed before
running &kamailio; with this module loaded:
@@ -130,9 +130,9 @@
default_expires (integer)
- If the processed message contains neither Expires
- header fields nor expires contact parameters, this value
- will be used for newly created usrloc records. The parameter contains
+ If the processed message contains neither Expires
+ header fields nor expires contact parameters, this value
+ will be used for newly created usrloc records. The parameter contains
number of second to expire (for example use 3600 for one hour). If it
is set to a lower value than the min_expires
parameter
then it will be ignored. This parameter can be modified via ser config framework.
@@ -180,7 +180,7 @@ modparam("registrar", "default_expires_range", 30) # +- 30% from default_expires
expires_range (integer)
Similar to default_expires_range, but it applies to the incoming expires
- value. Default in 0, meaning the expires is left unmodified.
+ value. Default in 0, meaning the expires is left unmodified.
This parameter can be modified via the &kamailio; config framework.
@@ -246,8 +246,8 @@ modparam("registrar", "min_expires_mode", 1)
max_expires (integer)
- The maximum accepted expires value of a Contact
, values higher than this
- maximum will be automatically set to the maximum. Value 0 disables
+ The maximum accepted expires value of a Contact
, values higher than this
+ maximum will be automatically set to the maximum. Value 0 disables
the checking. This parameter can be modified via the &kamailio; config framework.
@@ -268,10 +268,10 @@ modparam("registrar", "max_expires", 120)
default_q (integer)
- The parameter represents default q
value for new contacts. Because
- &kamailio; doesn't support float parameter types, the value in the parameter
- is divided by 1000 and stored as float. For example, if you want
- default_q to be 0.38, use value 380 here. This parameter can be modified via
+ The parameter represents default q
value for new contacts. Because
+ &kamailio; doesn't support float parameter types, the value in the parameter
+ is divided by 1000 and stored as float. For example, if you want
+ default_q to be 0.38, use value 380 here. This parameter can be modified via
the &kamailio; config framework.
@@ -292,12 +292,12 @@ modparam("registrar", "default_q", 1000)
realm_prefix (string)
- Prefix to be automatically stripped from realm. As an alternative to
- SRV records (not all SIP clients support SRV lookup), a subdomain of
- the master domain can be defined for SIP purposes (like
- sip.mydomain.net pointing to same IP address as the SRV record for
+ Prefix to be automatically stripped from realm. As an alternative to
+ SRV records (not all SIP clients support SRV lookup), a subdomain of
+ the master domain can be defined for SIP purposes (like
+ sip.mydomain.net pointing to same IP address as the SRV record for
mydomain.net). By ignoring the realm_prefix "sip.", at registration,
- sip.mydomain.net will be equivalent to mydomain.net. This parameter
+ sip.mydomain.net will be equivalent to mydomain.net. This parameter
can be modified via the &kamailio; config framework.
@@ -319,12 +319,12 @@ modparam("registrar", "realm_prefix", "sip.")
append_branches (integer)
- The parameter controls how lookup function processes multiple
- contacts. If there are multiple contacts for the given username in
- usrloc and this parameter is set to 1, Request-URI will be
- overwritten with the highest-q rated contact. The rest will be
+ The parameter controls how lookup function processes multiple
+ contacts. If there are multiple contacts for the given username in
+ usrloc and this parameter is set to 1, Request-URI will be
+ overwritten with the highest-q rated contact. The rest will be
appended to sip_msg structure and can be later used by tm for forking.
- If the parameter is set to 0, only Request-URI will be overwritten
+ If the parameter is set to 0, only Request-URI will be overwritten
with the highest-q rated contact and the rest will be left unprocessed.
This parameter can be modified via &kamailio; config framework.
@@ -377,15 +377,15 @@ modparam("registrar", "case_sensitive", 1)
received_avp (str)
- Registrar will store the value of the AVP configured by this
- parameter in the received column in the user location database.
- It will leave the column empty if the AVP is empty. The AVP should
+ Registrar will store the value of the AVP configured by this
+ parameter in the received column in the user location database.
+ It will leave the column empty if the AVP is empty. The AVP should
contain a SIP URI consisting of the source IP, port,
and transport protocol of the REGISTER message being processed.
- The value of this parameter should be the same as the value of
+ The value of this parameter should be the same as the value of
corresponding parameter of nathelper module.
@@ -407,7 +407,7 @@ modparam("registrar", "received_avp", "$avp(s:rcv)")
received_param (string)
- The name of the parameter that will be appended to Contact URI's of
+ The name of the parameter that will be appended to Contact URI's of
200 OK when the received URI was set by the nathelper
module. If the
value is an empty string, then the parameter is not appended anymore.
@@ -429,11 +429,11 @@ modparam("registrar", "received_param", "rcv")
- 0x02 - do not generate a SIP
+ 0x02 - do not generate a SIP
reply to the current REGISTER request. When used in
ONREPLY_ROUTE, this parameter is obsolete.
@@ -1265,7 +1265,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
0x08 - Do not apply
- expires_range or
+ expires_range or
default_expires_range to this
registration.
@@ -1334,18 +1334,18 @@ save("location", "0x00", "sip:test@kamailio.org");
lookup(domain [, uri])
- The lookup function extracts username and/or domain from Request-URI and tries to find
- all contacts for the username in usrloc. If there are no such
- contacts, -1 will be returned. If there are such contacts,
+ The lookup function extracts username and/or domain from Request-URI and tries to find
+ all contacts for the username in usrloc. If there are no such
+ contacts, -1 will be returned. If there are such contacts,
Request-URI will be overwritten with the contact that has
- the highest q value and optionally the rest will be appended to
+ the highest q value and optionally the rest will be appended to
the message (depending on append_branches parameter value).
As a side effect, also branch flags are restored from usrloc.
If the method_filtering option is enabled and
request is initial request without to-tag, the
- lookup function
+ lookup function
will return only the contacts that support the method of the
processed request.
@@ -1353,7 +1353,7 @@ save("location", "0x00", "sip:test@kamailio.org");
- domain - Name of table that should be used
+ domain - Name of table that should be used
for the lookup.
@@ -1443,7 +1443,7 @@ lookup_to_dset("location");
- domain - Name of table that should be used
+ domain - Name of table that should be used
for the lookup.
@@ -1546,9 +1546,9 @@ xinfo("first contact record - socket: $xavp(cul>socket)\n");
registered(domain [, uri [, match_option [, match_action]]])
- The function returns true if the AOR in the URI is
- registered, false otherwise. The function does not modify the
- message being processed, it neither rewrites the Request-URI if a
+ The function returns true if the AOR in the URI is
+ registered, false otherwise. The function does not modify the
+ message being processed, it neither rewrites the Request-URI if a
contact is found nor append branches. If uri parameter is not
provided, then it considered to be the Request-URI for SIP requests
and To-URI for SIP replies.
@@ -1557,7 +1557,7 @@ xinfo("first contact record - socket: $xavp(cul>socket)\n");
- domain - Name of table that should be
+ domain - Name of table that should be
used for the lookup.
@@ -1629,7 +1629,7 @@ if (registered("location","$rz:$Au", 2)) {
add_sock_hdr(hdr_name)
- Adds a new header to the current REGISTER request with
+ Adds a new header to the current REGISTER request with
hdr_name
which contains the description of the
received socket (proto:ip:port)
@@ -1664,7 +1664,7 @@ add_sock_hdr("Sock-Info");
The function removes contacts associated with 'uri' from the location
database. If 'ruid' is provided a specific contact is removed,
- if 'ruid' is not provided all the current contacts are removed.
+ if 'ruid' is not provided all the current contacts are removed.
If 'ruid' is provided and the usrloc
module is
using db_mode=3
, 'uri' does not need to be given and can be
empty string.
@@ -1673,7 +1673,7 @@ add_sock_hdr("Sock-Info");
- domain - Name of table that should be
+ domain - Name of table that should be
used for the lookup or contact addresses.
@@ -1744,7 +1744,7 @@ unregister("location", "", "$ruid");
- domain - Name of table that should be
+ domain - Name of table that should be
used for the lookup of contact addresses.
@@ -1938,7 +1938,7 @@ event_route[usrloc:contact-expired] {
Pseudo Variables
-
+
$ulc(profile=>attr)
@@ -1957,11 +1957,11 @@ event_route[usrloc:contact-expired] {
aor - address of record
-
+
domain - used location domain/table name
-
+
aorhash - hash id for the record
@@ -1969,71 +1969,71 @@ event_route[usrloc:contact-expired] {
addr - contact address
-
+
path - path vector
-
+
received - received address
-
+
expires - expires value
-
+
callid - call-id header value
-
+
q - the q value
-
+
cseq - the cseq value
-
+
flags - flags value
-
+
cflags - cflags value
-
+
user_agent - user agent
-
+
socket - local socket
-
+
modified - last modified time
-
+
methods - methods value
-
+
count - number of contacts
-
+
ruid - record unique ID
-
+
regid - reg-id value
-
+
instance - instance value
-
+
conid - TCP socket internal connection ID ($null if UDP)
diff --git a/src/modules/registrar/doc/registrar_faq.xml b/src/modules/registrar/doc/registrar_faq.xml
index 325700966eb..3c74919cfd7 100644
--- a/src/modules/registrar/doc/registrar_faq.xml
+++ b/src/modules/registrar/doc/registrar_faq.xml
@@ -10,7 +10,7 @@
-
+
&faqguide;
@@ -46,7 +46,7 @@
- There functions were merged into the new
+ There functions were merged into the new
save(domain,flags)
functions. If a reply should be
sent or if the DB should be updated also is controlled via the
flags.
@@ -71,7 +71,7 @@
First at all check if your question was already answered on one of
- our mailing lists:
+ our mailing lists:
@@ -82,7 +82,7 @@
- E-mails regarding any stable &kamailio; release should be sent to
+ E-mails regarding any stable &kamailio; release should be sent to
&kamailiousersmail; and e-mails regarding development versions
should be sent to &kamailiodevmail;.