Browse code

userblacklist Minor typo fixes in README

Olle E. Johansson authored on 02/01/2015 21:42:57
Showing 2 changed files
... ...
@@ -142,17 +142,18 @@ Chapter 1. Admin Guide
142 142
 
143 143
    An additional functionality that this module provides is the ability to
144 144
    handle global blacklists. This lists are loaded on startup into memory,
145
-   thus providing a better performance then in the userblacklist case.
146
-   These global blacklists are useful to only allow calls to certain
145
+   thus providing a better performance than the userblacklist case. These
146
+   global blacklists are useful to allow only calls to certain
147 147
    international destinations, i.e. block all not whitelisted numbers.
148
-   They could also used to prevent the blacklisting of important numbers,
149
-   as whitelisting is supported too. This is useful for example to prevent
150
-   the customer from blocking emergency call number or service hotlines.
148
+   They could also be used to prevent the blacklisting of important
149
+   numbers, as whitelisting is supported too. This is useful for example
150
+   to prevent the customer from blocking emergency call number or service
151
+   hotlines.
151 152
 
152 153
    The module exports four functions, check_blacklist, check_whitelist,
153
-   check_user_blacklist and check_user_whitelist for usage in the config
154
-   file. Furthermore its provides a MI function to reload the global
155
-   blacklist cache.
154
+   check_user_blacklist and check_user_whitelist for usage in the
155
+   configuration file. Furthermore it provides a MI function to reload the
156
+   global blacklist cache.
156 157
 
157 158
    Please note that only numerical strings for matching are supported at
158 159
    the moment (the used library supports this already, but its not yet
... ...
@@ -169,7 +170,7 @@ Chapter 1. Admin Guide
169 170
 
170 171
    The module depends on the following modules (in the other words the
171 172
    listed modules must be loaded before this module):
172
-     * database -- Any database module
173
+     * database -- Any db_* database module
173 174
 
174 175
 2.2. External Libraries or Applications
175 176
 
... ...
@@ -196,14 +197,14 @@ Chapter 1. Admin Guide
196 197
 
197 198
 3.1. use_domain (integer)
198 199
 
199
-   If set to non-zero value, the domain column in the userblacklist is
200
-   used.
200
+   If set to non-zero value, the domain column in the userblacklist table
201
+   is used.
201 202
 
202 203
    Default value is "0".
203 204
 
204 205
    Example 1.1. Set use_domain parameter
205 206
 ...
206
-modparam("userblacklist", "use_domain", 0)
207
+modparam("userblacklist", "use_domain", 1)
207 208
 ...
208 209
 
209 210
 3.2. match_mode (integer)
... ...
@@ -21,10 +21,10 @@
21 21
 	<para>
22 22
 	An additional functionality that this module provides is the ability
23 23
 	to handle global blacklists. This lists are loaded on startup into
24
-	memory, thus providing a better performance then in the userblacklist
25
-	case. These global blacklists are useful to only allow calls to certain 
24
+	memory, thus providing a better performance than the userblacklist
25
+	case. These global blacklists are useful to allow only calls to certain 
26 26
 	international destinations, i.e. block all not whitelisted numbers.
27
-	They could also used to prevent the blacklisting of important	
27
+	They could also be used to prevent the blacklisting of important	
28 28
 	numbers, as whitelisting is supported too. This is useful for example
29 29
 	to prevent the customer from blocking emergency call number or service
30 30
 	hotlines.
... ...
@@ -33,7 +33,7 @@
33 33
 	The module exports four functions, <function>check_blacklist</function>,
34 34
 	<function>check_whitelist</function>,
35 35
 	<function>check_user_blacklist</function> and <function>check_user_whitelist</function>
36
-	for usage in the config file. Furthermore its provides a MI function to
36
+	for usage in the configuration file. Furthermore it provides a MI function to
37 37
 	reload the global blacklist cache.
38 38
 	</para>
39 39
 	<para>
... ...
@@ -54,7 +54,8 @@
54 54
 			</para>
55 55
 			<itemizedlist>
56 56
 			<listitem>
57
-				<para><emphasis>database</emphasis> -- Any database module</para>
57
+				<para><emphasis>database</emphasis> 
58
+				-- Any db_* database module</para>
58 59
 			</listitem>
59 60
 			</itemizedlist>
60 61
 		</section>
... ...
@@ -75,10 +76,11 @@
75 76
 
76 77
 	<section  xmlns:xi="http://www.w3.org/2001/XInclude">
77 78
 	<title>Parameters</title>
78
-    <section id="userblacklist.p.use_domain">
79
+    	<section id="userblacklist.p.use_domain">
79 80
 	    <title><varname>use_domain</varname> (integer)</title>
80 81
 	    <para>
81
-			If set to non-zero value, the domain column in the userblacklist is used.
82
+			If set to non-zero value, the domain column in the
83
+			userblacklist table is used.
82 84
 	    </para>
83 85
 	    <para>
84 86
 		    <emphasis>
... ...
@@ -89,7 +91,7 @@
89 91
 		    <title>Set <varname>use_domain</varname> parameter</title>
90 92
 		    <programlisting format="linespecific">
91 93
 ...
92
-modparam("userblacklist", "use_domain", 0)
94
+modparam("userblacklist", "use_domain", 1)
93 95
 ...
94 96
 		    </programlisting>
95 97
 	    </example>
... ...
@@ -101,7 +103,8 @@ modparam("userblacklist", "use_domain", 0)
101 103
 		Valid values are 10 or 128. When you specifiy 10, only digits will be used for matching, 
102 104
 		this operation mode is equivalent to the old behaviour. When configured with 128, 
103 105
 		all standard ASCII chars are available for matching. Please be aware that memory 
104
-		requirements for storing the routing tree in shared memory will also increase by a factor of 12.8.
106
+		requirements for storing the routing tree in shared memory will also
107
+		increase by a factor of 12.8.
105 108
 	    </para>
106 109
 	    <para>
107 110
 		    <emphasis>
... ...
@@ -211,7 +214,8 @@ modparam("userblacklist", "userblacklist_whitelist_col", "whitelist")
211 214
   <section>
212 215
     <title><varname>globalblacklist_table</varname> (String)</title>
213 216
     <para>Name of the globalblacklist table for the userblacklist module.
214
-    Please note that this table is used when the check_blacklist function is called with no parameters.</para>
217
+    Please note that this table is used when the check_blacklist
218
+	function is called with no parameters.</para>
215 219
     <para>
216 220
       <emphasis>Default value is <quote>globalblacklist</quote>.</emphasis>
217 221
     </para>
... ...
@@ -279,7 +283,8 @@ modparam("userblacklist", "globalblacklist_description_col", "description")
279 283
 	<title>Functions</title>
280 284
     	<section id="userblacklist.f.check_user_blacklist">
281 285
 	    <title>
282
-		<function moreinfo="none">check_user_blacklist (string user, string domain, string number, string table)</function>
286
+		<function moreinfo="none">check_user_blacklist
287
+		(string user, string domain, string number, string table)</function>
283 288
 	    </title>
284 289
 	    <para>
285 290
 		Finds the longest prefix that matches the request URI user (or the number
... ...
@@ -306,7 +311,8 @@ if (!check_user_blacklist("$avp(i:80)", "$avp(i:82)")) {
306 311
 	</section>
307 312
     	<section id="userblacklist.f.check_user_whitelist">
308 313
 	    <title>
309
-		<function moreinfo="none">check_user_whitelist (string user, string domain, string number, string table)</function>
314
+		<function moreinfo="none">check_user_whitelist
315
+		(string user, string domain, string number, string table)</function>
310 316
 	    </title>
311 317
 	    <para>
312 318
 		Finds the longest prefix that matches the request URI user (or the number
... ...
@@ -401,10 +407,11 @@ if (!check_whitelist("globalblacklist")) {
401 407
 	<section>
402 408
 		<title>Database setup</title>
403 409
 		<para>
404
-			Before running &kamailio; with the userblacklist module, you have to setup the database 
405
-			table where the module will read the blacklist data. For that, if 
406
-			the table was not created by the installation script or you choose
407
-			to install everything by yourself you can use the userblacklist-create.sql
410
+			Before running &kamailio; with the userblacklist module,
411
+			you have to setup the database table where the module will
412
+			read the blacklist data. For that, if the table was not created
413
+			by the installation script or you choose to install everything
414
+			by yourself you can use the <emphasis>userblacklist-create.sql</emphasis>
408 415
 			<acronym>SQL</acronym> script in the database directories in the 
409 416
 			kamailio/scripts folder as template. 
410 417
 			Database and table name can be set with module parameters so they