registrar Fix typo in README
authorOlle E. Johansson <oej@edvina.net>
Fri, 15 Apr 2016 20:50:42 +0000 (22:50 +0200)
committerOlle E. Johansson <oej@edvina.net>
Fri, 15 Apr 2016 20:50:42 +0000 (22:50 +0200)
modules/registrar/README
modules/registrar/doc/registrar_admin.xml

index 3023d39..3dca05e 100644 (file)
@@ -20,7 +20,7 @@ Edited by
 
 Bogdan-Andre Iancu
 
-   Copyright (c) 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
      __________________________________________________________________
 
    Table of Contents
@@ -792,7 +792,7 @@ modparam("registrar", "flow_timer", 25)
    4.7. reg_fetch_contacts(domain, uri, profile)
    4.8. reg_free_contacts(profile)
 
-4.1.  save(domain, [, flags [, uri]])
+4.1. save(domain, [, flags [, uri]])
 
    The function processes a REGISTER message. It can add, remove or modify
    location records (in usrloc) depending on Contact and Expires HFs in
@@ -837,7 +837,7 @@ save("location", "0x01");
 save("location", "0x00", "sip:test@kamailio.org");
 ...
 
-4.2.  lookup(domain [, uri])
+4.2. 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
@@ -877,7 +877,7 @@ switch ($retcode) {
 };
 ...
 
-4.3.  lookup_branches(domain)
+4.3. lookup_branches(domain)
 
    The function performs lookup(domain) on r-uri and additional branches
    (only branches that have no other attributes set than uri).
@@ -894,7 +894,7 @@ switch ($retcode) {
 lookup_branches("location");
 ...
 
-4.4.  registered(domain [, uri [, match_option [, match_action]]])
+4.4. 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 process, it
@@ -933,7 +933,7 @@ if (registered("location","$rz:$Au", 2)) {
 };
 ...
 
-4.5.  add_sock_hdr(hdr_name)
+4.5. add_sock_hdr(hdr_name)
 
    Adds a new header to the current REGISTER request with "hdr_name" which
    contains the description of the received socket (proto:ip:port)
@@ -950,7 +950,7 @@ if (registered("location","$rz:$Au", 2)) {
 add_sock_hdr("Sock-Info");
 ...
 
-4.6.  unregister(domain, uri[, ruid])
+4.6. unregister(domain, uri[, ruid])
 
    The function removes contacts associated with 'uri' from the location
    database. If 'ruid' is provided a specific contact is removed, if
@@ -977,7 +977,7 @@ unregister("location", "$ru", "$ulc(caller=>ruid)");
 unregister("location", "", "$ruid");
 ...
 
-4.7.  reg_fetch_contacts(domain, uri, profile)
+4.7. reg_fetch_contacts(domain, uri, profile)
 
    The function fetches the contacts for 'uri' from table 'domain' to
    pseudo-variable $ulc(profile).
@@ -999,7 +999,7 @@ reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
 ...
 
-4.8.  reg_free_contacts(profile)
+4.8. reg_free_contacts(profile)
 
    The function frees the contacts from pseudo-variable $ulc(profile).
    Should be called to release the content of a profile. Anyhow, fetching
@@ -1092,7 +1092,7 @@ event_route[usrloc:contact-expired] {
      * methods - methods value
      * count - number of contacts
      * ruid - record unique ID
-     * reg-id - reg-id value
+     * regid - reg-id value
      * instance - instance value
      * conid - TCP socket internal connection ID ($null if UDP)
 
@@ -1116,6 +1116,7 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
     xlog("caller=>received:   $(ulc(caller=>received)[$var(i)])\n");
     xlog("caller=>expires:    $(ulc(caller=>expires)[$var(i)])\n");
     xlog("caller=>callid:     $(ulc(caller=>callid)[$var(i)])\n");
+    xlog("caller=>regid:      $(ulc(caller=>regid)[$var(i)])\n");
     xlog("caller=>q:          $(ulc(caller=>q)[$var(i)])\n");
     xlog("caller=>cseq:       $(ulc(caller=>cseq)[$var(i)])\n");
     xlog("caller=>flags:      $(ulc(caller=>flags)[$var(i)])\n");
@@ -1143,60 +1144,60 @@ Chapter 2. Frequently Asked Questions
 
    2.1.
 
-       What happend with the old "nat_flag" module parameter?
+   What happend with the old "nat_flag" module parameter?
 
-       In was removed, as the module internally loads this value from the
-       "USRLOC" module (see the "nat_bflag" USRLOC parameter).
+   In was removed, as the module internally loads this value from the
+   "USRLOC" module (see the "nat_bflag" USRLOC parameter).
 
    2.2.
 
-       What happend with the old "use_domain" module parameter?
+   What happend with the old "use_domain" module parameter?
 
-       In was removed, as the module internally loads this option from the
-       "USRLOC" module. This was done in order to simplify the configuration.
+   In was removed, as the module internally loads this option from the
+   "USRLOC" module. This was done in order to simplify the configuration.
 
    2.3.
 
-       What happened with the old "save_noreply" and "save_memory" functions?
+   What happened with the old "save_noreply" and "save_memory" functions?
 
-       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.
+   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.
 
    2.4.
 
-       Where can I find more about Kamailio?
+   Where can I find more about Kamailio?
 
-       Take a look at http://www.kamailio.org/.
+   Take a look at http://www.kamailio.org/.
 
    2.5.
 
-       Where can I post a question about this module?
+   Where can I post a question about this module?
 
-       First at all check if your question was already answered on one of our
-       mailing lists:
-         * User Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
-         * Developer Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
+   First at all check if your question was already answered on one of our
+   mailing lists:
+     * User Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
+     * Developer Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
 
-       E-mails regarding any stable Kamailio release should be sent to
-       <sr-users@lists.sip-router.org> and e-mails regarding development
-       versions should be sent to <sr-dev@lists.sip-router.org>.
+   E-mails regarding any stable Kamailio release should be sent to
+   <sr-users@lists.sip-router.org> and e-mails regarding development
+   versions should be sent to <sr-dev@lists.sip-router.org>.
 
-       If you want to keep the mail private, send it to
-       <sr-users@lists.sip-router.org>.
+   If you want to keep the mail private, send it to
+   <sr-users@lists.sip-router.org>.
 
    2.6.
 
-       How can I report a bug?
+   How can I report a bug?
 
-       Please follow the guidelines provided at:
-       http://sip-router.org/tracker.
+   Please follow the guidelines provided at:
+   http://sip-router.org/tracker.
 
    2.7.
 
-       What happened to the desc_time_order parameter?
+   What happened to the desc_time_order parameter?
 
-       It was removed, as its functionality was migrated into usrloc module,
-       were there is a parameter with the same name.
+   It was removed, as its functionality was migrated into usrloc module,
+   were there is a parameter with the same name.
index 8a9479d..11f6d21 100644 (file)
@@ -1511,7 +1511,7 @@ event_route[usrloc:contact-expired] {
                                </para>
                                </listitem>       
                                <listitem>
-                               <para><emphasis>reg-id</emphasis> - reg-id value
+                               <para><emphasis>regid</emphasis> - reg-id value
                                </para>
                                </listitem>       
                                <listitem>
@@ -1547,6 +1547,7 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
     xlog("caller=&gt;received:   $(ulc(caller=&gt;received)[$var(i)])\n");
     xlog("caller=&gt;expires:    $(ulc(caller=&gt;expires)[$var(i)])\n");
     xlog("caller=&gt;callid:     $(ulc(caller=&gt;callid)[$var(i)])\n");
+    xlog("caller=&gt;regid:      $(ulc(caller=&gt;regid)[$var(i)])\n");
     xlog("caller=&gt;q:          $(ulc(caller=&gt;q)[$var(i)])\n");
     xlog("caller=&gt;cseq:       $(ulc(caller=&gt;cseq)[$var(i)])\n");
     xlog("caller=&gt;flags:      $(ulc(caller=&gt;flags)[$var(i)])\n");