From 0702a904ee07ba248aa23290cf57b77a96715137 Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Mon, 13 Nov 2023 15:36:05 +0100 Subject: [PATCH] group: docs - removed trailing spaces --- src/modules/group/doc/group.xml | 6 ++--- src/modules/group/doc/group_admin.xml | 36 +++++++++++++-------------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/modules/group/doc/group.xml b/src/modules/group/doc/group.xml index 5942471293d..b6e6f1ba3a5 100644 --- a/src/modules/group/doc/group.xml +++ b/src/modules/group/doc/group.xml @@ -44,8 +44,8 @@ - + - - + + diff --git a/src/modules/group/doc/group_admin.xml b/src/modules/group/doc/group_admin.xml index 25f65737b14..0fbfad4518f 100644 --- a/src/modules/group/doc/group_admin.xml +++ b/src/modules/group/doc/group_admin.xml @@ -10,19 +10,19 @@ - + &adminguide; - +
Overview - This module provides functionality for two different methods of group + This module provides functionality for two different methods of group membership checking.
Strict membership checking - The module uses a database table that contains a list of users and groups + The module uses a database table that contains a list of users and groups they belong to. The module provides the possibility to check if a specific user belongs to a specific group. @@ -33,14 +33,14 @@
Regular Expression based checking - Another database table contains list of regular expressions and + Another database table contains list of regular expressions and group IDs. A matching occurs if the user URI match the regular - expression. This type of matching may be used to fetch the + expression. This type of matching may be used to fetch the group ID(s) the user belongs to (via RE matching) . Due to performance reasons (regular expression evaluation), DB cache - support is available: the table content is loaded into memory at + support is available: the table content is loaded into memory at startup and all regular expressions are compiled.
@@ -64,7 +64,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: @@ -86,7 +86,7 @@ - Default value is + Default value is &defaultrodb;. @@ -103,7 +103,7 @@ modparam("group", "db_url", "&exampledb;")
<varname>table</varname> (string) - Name of the table holding strict definitions of groups and + Name of the table holding strict definitions of groups and their members. @@ -185,7 +185,7 @@ modparam("group", "group_column", "grp") <varname>use_domain</varname> (integer) If enabled (set to a non zero value) then the domain will be used also used - for strict group matching; otherwise only the username part will be + for strict group matching; otherwise only the username part will be used. @@ -206,7 +206,7 @@ modparam("group", "use_domain", 1)
<varname>re_table</varname> (string) - Name of the table holding definitions for regular-expression + Name of the table holding definitions for regular-expression based groups. If no table is defined, the regular-expression support is disabled. @@ -296,18 +296,18 @@ modparam("group", "multiple_gid", 0) is_user_in(URI, group) - This function is to be used for script group membership. The function + This function is to be used for script group membership. The function returns true if username in the given &uri; is a member of the given group and false if not. Meaning of the parameters is as follows: - &uri; - &uri; whose username and + &uri; - &uri; whose username and optionally domain to be used, this can be one of: - Request-URI - Use Request-URI username and + Request-URI - Use Request-URI username and (optionally) domain. @@ -351,8 +351,8 @@ if (is_user_in("Request-URI", "ld")) { get_user_group(URI, AVP) - This function is to be used for regular expression based group - membership. The function returns true if username in the given &uri; + This function is to be used for regular expression based group + membership. The function returns true if username in the given &uri; belongs to at least one group; the group ID(s) are returned as AVPs. Meaning of the parameters is as follows: @@ -371,7 +371,7 @@ if (is_user_in("Request-URI", "ld")) { From - Use From URI - Credentials - Use digest credentials username + Credentials - Use digest credentials username and realm.