Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-24 16:23:40 +01:00
Code Releases Activity

Use specific syntax so modules and top-level will be links

Browse Source 
If we use _`whatever`_ here in ejabberd man pages,
it is converted to *`whatever`* in markdown,
and docs.ejabberd.im/Makefile converts to the proper links
This commit is contained in:
Badlop 2021-08-21 18:31:21 +02:00
parent 30ae66e99e
commit 506e2f3b97
32 changed files with 186 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
src/ejabberd_options_doc.erl
View File

@ -64,8 +64,8 @@ doc() ->
"erased from cache. The default value is 'one hour'. " "erased from cache. The default value is 'one hour'. "
"Several modules have a similar option; and some core " "Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see " "ejabberd parts support similar options too, see "
"'auth_cache_life_time', 'oauth_cache_life_time', " "_`auth_cache_life_time`_, _`oauth_cache_life_time`_, "
"'router_cache_life_time', and 'sm_cache_life_time'.")}}, "_`router_cache_life_time`_, and _`sm_cache_life_time`_.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
@ -73,12 +73,12 @@ doc() ->
"an attempt to lookup for a value in a database and " "an attempt to lookup for a value in a database and "
"this value is not found and the option is set to 'true', " "this value is not found and the option is set to 'true', "
"this attempt will be cached and no attempts will be " "this attempt will be cached and no attempts will be "
"performed until the cache expires (see 'cache_life_time'). " "performed until the cache expires (see _`cache_life_time`_). "
"Usually you don't want to change it. Default is 'true'. " "Usually you don't want to change it. Default is 'true'. "
"Several modules have a similar option; and some core " "Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see " "ejabberd parts support similar options too, see "
"'auth_cache_missed', 'oauth_cache_missed', " "_`auth_cache_missed`_, _`oauth_cache_missed`_, "
"'router_cache_missed', and 'sm_cache_missed'.")}}, "_`router_cache_missed`_, and _`sm_cache_missed`_.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
@ -93,16 +93,16 @@ doc() ->
"performance. The default value is '1000'. " "performance. The default value is '1000'. "
"Several modules have a similar option; and some core " "Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see " "ejabberd parts support similar options too, see "
"'auth_cache_size', 'oauth_cache_size', " "_`auth_cache_size`_, _`oauth_cache_size`_, "
"'router_cache_size', and 'sm_cache_size'.")}}, "_`router_cache_size`_, and _`sm_cache_size`_.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Enable or disable cache. The default is 'true'. " ?T("Enable or disable cache. The default is 'true'. "
"Several modules have a similar option; and some core " "Several modules have a similar option; and some core "
"ejabberd parts support similar options too, see " "ejabberd parts support similar options too, see "
"'auth_use_cache', 'oauth_use_cache', 'router_use_cache', " "_`auth_use_cache`_, _`oauth_use_cache`_, _`router_use_cache`_, "
"and 'sm_use_cache'.")}}, "and _`sm_use_cache`_.")}},
{default_db, {default_db,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
@ -122,14 +122,14 @@ doc() ->
"Modules may have its own value of the option. " "Modules may have its own value of the option. "
"The value of 'ram' means that queues will be kept in memory. " "The value of 'ram' means that queues will be kept in memory. "
"If value 'file' is set, you may also specify directory " "If value 'file' is set, you may also specify directory "
"in 'queue_dir' option where file queues will be placed. " "in _`queue_dir`_ option where file queues will be placed. "
"The default value is 'ram'.")}}, "The default value is 'ram'.")}},
{version, {version,
#{value => "string()", #{value => "string()",
desc => desc =>
?T("The option can be used to set custom ejabberd version, " ?T("The option can be used to set custom ejabberd version, "
"that will be used by different parts of ejabberd, for " "that will be used by different parts of ejabberd, for "
"example by 'mod_version' module. The default value is " "example by _`mod_version`_ module. The default value is "
"obtained at compile time from the underlying version " "obtained at compile time from the underlying version "
"control system.")}}, "control system.")}},
{acl, {acl,
@ -141,7 +141,7 @@ doc() ->
"has name 'ACLName': it can be any string except 'all' or 'none' " "has name 'ACLName': it can be any string except 'all' or 'none' "
"(those are predefined names for the rules that match all or nothing " "(those are predefined names for the rules that match all or nothing "
"respectively). The name 'ACLName' can be referenced from other " "respectively). The name 'ACLName' can be referenced from other "
"parts of the configuration file, for example in 'access_rules' " "parts of the configuration file, for example in _`access_rules`_ "
"option. The rules of 'ACLName' are represented by mapping " "option. The rules of 'ACLName' are represented by mapping "
"'pass:[{ACLType: ACLValue}]'. These can be one of the following:")}, "'pass:[{ACLType: ACLValue}]'. These can be one of the following:")},
[{user, [{user,
@ -225,7 +225,7 @@ doc() ->
"of the configuration file (mostly from 'access' options of " "of the configuration file (mostly from 'access' options of "
"ejabberd modules). Each rule definition may contain " "ejabberd modules). Each rule definition may contain "
"arbitrary number of 'allow' or 'deny' sections, and each " "arbitrary number of 'allow' or 'deny' sections, and each "
"section may contain any number of ACL rules (see 'acl' option). " "section may contain any number of ACL rules (see _`acl`_ option). "
"There are no access rules defined by default."), "There are no access rules defined by default."),
example => example =>
["access_rules:", ["access_rules:",
@ -336,18 +336,18 @@ doc() ->
{auth_cache_life_time, {auth_cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as 'cache_life_time', but applied to authentication cache " ?T("Same as _`cache_life_time`_, but applied to authentication cache "
"only. If not set, the value from 'cache_life_time' will be used.")}}, "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{auth_cache_missed, {auth_cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'cache_missed', but applied to authentication cache " ?T("Same as _`cache_missed`_, but applied to authentication cache "
"only. If not set, the value from 'cache_missed' will be used.")}}, "only. If not set, the value from _`cache_missed`_ will be used.")}},
{auth_cache_size, {auth_cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as 'cache_size', but applied to authentication cache " ?T("Same as _`cache_size`_, but applied to authentication cache "
"only. If not set, the value from 'cache_size' will be used.")}}, "only. If not set, the value from _`cache_size`_ will be used.")}},
{auth_method, {auth_method,
#{value => "[mnesia | sql | anonymous | external | jwt | ldap | pam, ...]", #{value => "[mnesia | sql | anonymous | external | jwt | ldap | pam, ...]",
desc => desc =>
@ -393,8 +393,8 @@ doc() ->
{auth_use_cache, {auth_use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'use_cache', but applied to authentication cache " ?T("Same as _`use_cache`_, but applied to authentication cache "
"only. If not set, the value from 'use_cache' will be used.")}}, "only. If not set, the value from _`use_cache`_ will be used.")}},
{c2s_cafile, {c2s_cafile,
#{value => ?T("Path"), #{value => ?T("Path"),
desc => desc =>
@ -464,7 +464,7 @@ doc() ->
"from CAPTCHA DoS. The default value is 'infinity'.")}}, "from CAPTCHA DoS. The default value is 'infinity'.")}},
{captcha_host, {captcha_host,
#{value => "String", #{value => "String",
desc => ?T("Deprecated. Use 'captcha_url' instead.")}}, desc => ?T("Deprecated. Use _`captcha_url`_ instead.")}},
{captcha_url, {captcha_url,
#{value => ?T("URL"), #{value => ?T("URL"),
desc => desc =>
@ -688,7 +688,7 @@ doc() ->
#{value => "[Host, ...]", #{value => "[Host, ...]",
desc => desc =>
?T("A list of IP addresses or DNS names of LDAP backup servers. " ?T("A list of IP addresses or DNS names of LDAP backup servers. "
"When no servers listed in 'ldap_servers' option are reachable, " "When no servers listed in _`ldap_servers`_ option are reachable, "
"ejabberd will try to connect to these backup servers. " "ejabberd will try to connect to these backup servers. "
"The default is an empty list, i.e. no backup servers specified. " "The default is an empty list, i.e. no backup servers specified. "
"WARNING: ejabberd doesn't try to reconnect back to the main " "WARNING: ejabberd doesn't try to reconnect back to the main "
@ -795,7 +795,7 @@ doc() ->
"the result set. There is no default value, which means the " "the result set. There is no default value, which means the "
"result is not filtered. WARNING: Since this filter makes " "result is not filtered. WARNING: Since this filter makes "
"additional LDAP lookups, use it only as the last resort: " "additional LDAP lookups, use it only as the last resort: "
"try to define all filter rules in 'ldap_filter' option if possible."), "try to define all filter rules in _`ldap_filter`_ option if possible."),
example => example =>
["ldap_dn_filter:", ["ldap_dn_filter:",
" \"(&(name=%s)(owner=%D)(user=%u@%d))\": [sn]"]}}, " \"(&(name=%s)(owner=%D)(user=%u@%d))\": [sn]"]}},
@ -866,13 +866,13 @@ doc() ->
{oauth_cache_life_time, {oauth_cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as 'cache_life_time', but applied to OAuth cache " ?T("Same as _`cache_life_time`_, but applied to OAuth cache "
"only. If not set, the value from 'cache_life_time' will be used.")}}, "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{oauth_cache_missed, {oauth_cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'cache_missed', but applied to OAuth cache " ?T("Same as _`cache_missed`_, but applied to OAuth cache "
"only. If not set, the value from 'cache_missed' will be used.")}}, "only. If not set, the value from _`cache_missed`_ will be used.")}},
{oauth_cache_rest_failure_life_time, {oauth_cache_rest_failure_life_time,
#{value => "timeout()", #{value => "timeout()",
note => "added in 21.01", note => "added in 21.01",
@ -882,8 +882,8 @@ doc() ->
{oauth_cache_size, {oauth_cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as 'cache_size', but applied to OAuth cache " ?T("Same as _`cache_size`_, but applied to OAuth cache "
"only. If not set, the value from 'cache_size' will be used.")}}, "only. If not set, the value from _`cache_size`_ will be used.")}},
{oauth_client_id_check, {oauth_client_id_check,
#{value => "allow | db | deny", #{value => "allow | db | deny",
desc => desc =>
@ -893,13 +893,13 @@ doc() ->
{oauth_use_cache, {oauth_use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'use_cache', but applied to OAuth cache " ?T("Same as _`use_cache`_, but applied to OAuth cache "
"only. If not set, the value from 'use_cache' will be used.")}}, "only. If not set, the value from _`use_cache`_ will be used.")}},
{oauth_db_type, {oauth_db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Database backend to use for OAuth authentication. " ?T("Database backend to use for OAuth authentication. "
"The default value is picked from 'default_db' option, or " "The default value is picked from _`default_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}}, "if it's not set, 'mnesia' will be used.")}},
{oauth_expire, {oauth_expire,
#{value => "timeout()", #{value => "timeout()",
@ -913,7 +913,7 @@ doc() ->
desc => desc =>
?T("Enable or disable OOM (out-of-memory) killer. " ?T("Enable or disable OOM (out-of-memory) killer. "
"When system memory raises above the limit defined in " "When system memory raises above the limit defined in "
"'oom_watermark' option, ejabberd triggers OOM killer " "_`oom_watermark`_ option, ejabberd triggers OOM killer "
"to terminate most memory consuming Erlang processes. " "to terminate most memory consuming Erlang processes. "
"Note that in order to maintain functionality, ejabberd only " "Note that in order to maintain functionality, ejabberd only "
"attempts to kill transient processes, such as those managing " "attempts to kill transient processes, such as those managing "
@ -924,14 +924,14 @@ doc() ->
desc => desc =>
?T("Trigger OOM killer when some of the running Erlang processes " ?T("Trigger OOM killer when some of the running Erlang processes "
"have messages queue above this 'Size'. Note that " "have messages queue above this 'Size'. Note that "
"such processes won't be killed if 'oom_killer' option is set " "such processes won't be killed if _`oom_killer`_ option is set "
"to 'false' or if 'oom_watermark' is not reached yet.")}}, "to 'false' or if 'oom_watermark' is not reached yet.")}},
{oom_watermark, {oom_watermark,
#{value => ?T("Percent"), #{value => ?T("Percent"),
desc => desc =>
?T("A percent of total system memory consumed at which " ?T("A percent of total system memory consumed at which "
"OOM killer should be activated with some of the processes " "OOM killer should be activated with some of the processes "
"possibly be killed (see 'oom_killer' option). Later, when " "possibly be killed (see _`oom_killer`_ option). Later, when "
"memory drops below this 'Percent', OOM killer is deactivated. " "memory drops below this 'Percent', OOM killer is deactivated. "
"The default value is '80' percents.")}}, "The default value is '80' percents.")}},
{outgoing_s2s_families, {outgoing_s2s_families,
@ -984,7 +984,7 @@ doc() ->
{queue_dir, {queue_dir,
#{value => ?T("Directory"), #{value => ?T("Directory"),
desc => desc =>
?T("If 'queue_type' option is set to 'file', use this 'Directory' " ?T("If _`queue_type`_ option is set to 'file', use this 'Directory' "
"to store file queues. The default is to keep queues inside " "to store file queues. The default is to keep queues inside "
"Mnesia directory.")}}, "Mnesia directory.")}},
{redis_connect_timeout, {redis_connect_timeout,
@ -1014,8 +1014,8 @@ doc() ->
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("The type of request queue for the Redis server. " ?T("The type of request queue for the Redis server. "
"See description of 'queue_type' option for the explanation. " "See description of _`queue_type`_ option for the explanation. "
"The default value is the value defined in 'queue_type' " "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}}, "or 'ram' if the latter is not set.")}},
{redis_server, {redis_server,
#{value => ?T("Hostname"), #{value => ?T("Hostname"),
@ -1025,7 +1025,7 @@ doc() ->
{registration_timeout, {registration_timeout,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("This is a global option for module 'mod_register'. " ?T("This is a global option for module _`mod_register`_. "
"It limits the frequency of registrations from a given " "It limits the frequency of registrations from a given "
"IP or username. So, a user that tries to register a " "IP or username. So, a user that tries to register a "
"new account from the same IP address or JID during " "new account from the same IP address or JID during "
@ -1048,29 +1048,29 @@ doc() ->
{router_cache_life_time, {router_cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as 'cache_life_time', but applied to routing table cache " ?T("Same as _`cache_life_time`_, but applied to routing table cache "
"only. If not set, the value from 'cache_life_time' will be used.")}}, "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{router_cache_missed, {router_cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'cache_missed', but applied to routing table cache " ?T("Same as _`cache_missed`_, but applied to routing table cache "
"only. If not set, the value from 'cache_missed' will be used.")}}, "only. If not set, the value from _`cache_missed`_ will be used.")}},
{router_cache_size, {router_cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as 'cache_size', but applied to routing table cache " ?T("Same as _`cache_size`_, but applied to routing table cache "
"only. If not set, the value from 'cache_size' will be used.")}}, "only. If not set, the value from _`cache_size`_ will be used.")}},
{router_db_type, {router_db_type,
#{value => "mnesia | redis | sql", #{value => "mnesia | redis | sql",
desc => desc =>
?T("Database backend to use for routing information. " ?T("Database backend to use for routing information. "
"The default value is picked from 'default_ram_db' option, or " "The default value is picked from _`default_ram_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}}, "if it's not set, 'mnesia' will be used.")}},
{router_use_cache, {router_use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'use_cache', but applied to routing table cache " ?T("Same as _`use_cache`_, but applied to routing table cache "
"only. If not set, the value from 'use_cache' will be used.")}}, "only. If not set, the value from _`use_cache`_ will be used.")}},
{rpc_timeout, {rpc_timeout,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
@ -1147,8 +1147,8 @@ doc() ->
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("The type of a queue for s2s packets. " ?T("The type of a queue for s2s packets. "
"See description of 'queue_type' option for the explanation. " "See description of _`queue_type`_ option for the explanation. "
"The default value is the value defined in 'queue_type' " "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}}, "or 'ram' if the latter is not set.")}},
{s2s_timeout, {s2s_timeout,
#{value => "timeout()", #{value => "timeout()",
@ -1176,7 +1176,7 @@ doc() ->
desc => desc =>
?T("The option defines a set of shapers. Every shaper is assigned " ?T("The option defines a set of shapers. Every shaper is assigned "
"a name 'ShaperName' that can be used in other parts of the " "a name 'ShaperName' that can be used in other parts of the "
"configuration file, such as 'shaper_rules' option. The shaper " "configuration file, such as _`shaper_rules`_ option. The shaper "
"itself is defined by its 'Rate', where 'Rate' stands for the " "itself is defined by its 'Rate', where 'Rate' stands for the "
"maximum allowed incoming rate in **bytes** per second. " "maximum allowed incoming rate in **bytes** per second. "
"When a connection exceeds this limit, ejabberd stops reading " "When a connection exceeds this limit, ejabberd stops reading "
@ -1192,9 +1192,9 @@ doc() ->
#{value => "{ShaperRuleName: {Number|ShaperName: ACLRule|ACLName}}", #{value => "{ShaperRuleName: {Number|ShaperName: ACLRule|ACLName}}",
desc => desc =>
?T("An entry allowing to declaring shaper to use for matching user/hosts. " ?T("An entry allowing to declaring shaper to use for matching user/hosts. "
"Semantics is similar to 'access_rules' option, the only difference is " "Semantics is similar to _`access_rules`_ option, the only difference is "
"that instead using 'allow' or 'deny', a name of a shaper (defined in " "that instead using 'allow' or 'deny', a name of a shaper (defined in "
"'shaper' option) or a positive number should be used."), "_`shaper`_ option) or a positive number should be used."),
example => example =>
["shaper_rules:", ["shaper_rules:",
" connections_limit:", " connections_limit:",
@ -1210,29 +1210,29 @@ doc() ->
{sm_cache_life_time, {sm_cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as 'cache_life_time', but applied to client sessions table cache " ?T("Same as _`cache_life_time`_, but applied to client sessions table cache "
"only. If not set, the value from 'cache_life_time' will be used.")}}, "only. If not set, the value from _`cache_life_time`_ will be used.")}},
{sm_cache_missed, {sm_cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'cache_missed', but applied to client sessions table cache " ?T("Same as _`cache_missed`_, but applied to client sessions table cache "
"only. If not set, the value from 'cache_missed' will be used.")}}, "only. If not set, the value from _`cache_missed`_ will be used.")}},
{sm_cache_size, {sm_cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as 'cache_size', but applied to client sessions table cache " ?T("Same as _`cache_size`_, but applied to client sessions table cache "
"only. If not set, the value from 'cache_size' will be used.")}}, "only. If not set, the value from _`cache_size`_ will be used.")}},
{sm_db_type, {sm_db_type,
#{value => "mnesia | redis | sql", #{value => "mnesia | redis | sql",
desc => desc =>
?T("Database backend to use for client sessions information. " ?T("Database backend to use for client sessions information. "
"The default value is picked from 'default_ram_db' option, or " "The default value is picked from _`default_ram_db`_ option, or "
"if it's not set, 'mnesia' will be used.")}}, "if it's not set, 'mnesia' will be used.")}},
{sm_use_cache, {sm_use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as 'use_cache', but applied to client sessions table cache " ?T("Same as _`use_cache`_, but applied to client sessions table cache "
"only. If not set, the value from 'use_cache' will be used.")}}, "only. If not set, the value from _`use_cache`_ will be used.")}},
{sql_type, {sql_type,
#{value => "mssql | mysql | odbc | pgsql | sqlite", #{value => "mssql | mysql | odbc | pgsql | sqlite",
desc => desc =>
@ -1258,7 +1258,7 @@ doc() ->
note => "added in 20.12", note => "added in 20.12",
desc => desc =>
?T("Path to the ODBC driver to use to connect to a Microsoft SQL " ?T("Path to the ODBC driver to use to connect to a Microsoft SQL "
"Server database. This option is only valid if the 'sql_type' " "Server database. This option is only valid if the _`sql_type`_ "
"option is set to 'mssql'. " "option is set to 'mssql'. "
"The default value is: 'libtdsodbc.so'")}}, "The default value is: 'libtdsodbc.so'")}},
{sql_password, {sql_password,
@ -1293,8 +1293,8 @@ doc() ->
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("The type of a request queue for the SQL server. " ?T("The type of a request queue for the SQL server. "
"See description of 'queue_type' option for the explanation. " "See description of _`queue_type`_ option for the explanation. "
"The default value is the value defined in 'queue_type' " "The default value is the value defined in _`queue_type`_ "
"or 'ram' if the latter is not set.")}}, "or 'ram' if the latter is not set.")}},
{sql_server, {sql_server,
#{value => ?T("Host"), #{value => ?T("Host"),
@ -1312,15 +1312,15 @@ doc() ->
#{value => ?T("Path"), #{value => ?T("Path"),
desc => desc =>
?T("A path to a file with CA root certificates that will " ?T("A path to a file with CA root certificates that will "
"be used to verify SQL connections. Implies 'sql_ssl' " "be used to verify SQL connections. Implies _`sql_ssl`_ "
"and 'sql_ssl_verify' options are set to 'true'. " "and _`sql_ssl_verify`_ options are set to 'true'. "
"There is no default which means " "There is no default which means "
"certificate verification is disabled.")}}, "certificate verification is disabled.")}},
{sql_ssl_certfile, {sql_ssl_certfile,
#{value => ?T("Path"), #{value => ?T("Path"),
desc => desc =>
?T("A path to a certificate file that will be used " ?T("A path to a certificate file that will be used "
"for SSL connections to the SQL server. Implies 'sql_ssl' " "for SSL connections to the SQL server. Implies _`sql_ssl`_ "
"option is set to 'true'. There is no default which means " "option is set to 'true'. There is no default which means "
"ejabberd won't provide a client certificate to the SQL " "ejabberd won't provide a client certificate to the SQL "
"server.")}}, "server.")}},
@ -1328,8 +1328,8 @@ doc() ->
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Whether to verify SSL connection to the SQL server against " ?T("Whether to verify SSL connection to the SQL server against "
"CA root certificates defined in 'sql_ssl_cafile' option. " "CA root certificates defined in _`sql_ssl_cafile`_ option. "
"Implies 'sql_ssl' option is set to 'true'. " "Implies _`sql_ssl`_ option is set to 'true'. "
"The default value is 'false'.")}}, "The default value is 'false'.")}},
{sql_start_interval, {sql_start_interval,
#{value => "timeout()", #{value => "timeout()",

2
src/mod_admin_update_sql.erl
View File

@ -366,4 +366,4 @@ mod_doc() ->
"from the default to the new schema. Check the section " "from the default to the new schema. Check the section "
"http://../database/#default-and-new-schemas[Default and New Schemas] for details. " "http://../database/#default-and-new-schemas[Default and New Schemas] for details. "
"Please note that only PostgreSQL is supported. " "Please note that only PostgreSQL is supported. "
"When the module is loaded use 'update_sql' ejabberdctl command.")}. "When the module is loaded use _`update_sql`_ API.")}.

14
src/mod_announce.erl
View File

@ -930,7 +930,7 @@ mod_doc() ->
"should be disabled for instances of ejabberd with hundreds of " "should be disabled for instances of ejabberd with hundreds of "
"thousands users."), "", "thousands users."), "",
?T("The Ad-hoc Commands are listed in the Server Discovery. " ?T("The Ad-hoc Commands are listed in the Server Discovery. "
"For this feature to work, 'mod_adhoc' must be enabled."), "", "For this feature to work, _`mod_adhoc`_ must be enabled."), "",
?T("The specific JIDs where messages can be sent are listed below. " ?T("The specific JIDs where messages can be sent are listed below. "
"The first JID in each entry will apply only to the specified " "The first JID in each entry will apply only to the specified "
"virtual host example.org, while the JID between brackets " "virtual host example.org, while the JID between brackets "
@ -940,7 +940,7 @@ mod_doc() ->
"online and connected to several resources, only the resource " "online and connected to several resources, only the resource "
"with the highest priority will receive the message. " "with the highest priority will receive the message. "
"If the registered user is not connected, the message will be " "If the registered user is not connected, the message will be "
"stored offline in assumption that offline storage (see 'mod_offline') " "stored offline in assumption that offline storage (see _`mod_offline`_) "
"is enabled."), "is enabled."),
"- example.org/announce/online (example.org/announce/all-hosts/online)::", "- example.org/announce/online (example.org/announce/all-hosts/online)::",
?T("The message is sent to all connected users. If the user is " ?T("The message is sent to all connected users. If the user is "
@ -965,20 +965,20 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

4
src/mod_avatar.erl
View File

@ -469,8 +469,8 @@ mod_doc() ->
"[XEP-0398: User Avatar to vCard-Based Avatars Conversion]."), "", "[XEP-0398: User Avatar to vCard-Based Avatars Conversion]."), "",
?T("Also, the module supports conversion between avatar " ?T("Also, the module supports conversion between avatar "
"image formats on the fly."), "", "image formats on the fly."), "",
?T("The module depends on 'mod_vcard', 'mod_vcard_xupdate' and " ?T("The module depends on _`mod_vcard`_, _`mod_vcard_xupdate`_ and "
"'mod_pubsub'.")], "_`mod_pubsub`_.")],
opts => opts =>
[{convert, [{convert,
#{value => "{From: To}", #{value => "{From: To}",

12
src/mod_bosh.erl
View File

@ -240,27 +240,27 @@ mod_doc() ->
{queue_type, {queue_type,
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("Same as top-level 'queue_type' option, but applied to this module only.")}}, ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{ram_db_type, {ram_db_type,
#{value => "mnesia | sql | redis", #{value => "mnesia | sql | redis",
desc => desc =>
?T("Same as 'default_ram_db' but applied to this module only.")}}, ?T("Same as _`default_ram_db`_ but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}], ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example => example =>
["listen:", ["listen:",
" -", " -",

12
src/mod_caps.erl
View File

@ -595,25 +595,25 @@ mod_doc() ->
"https://xmpp.org/extensions/xep-0115.html" "https://xmpp.org/extensions/xep-0115.html"
"[XEP-0115: Entity Capabilities]."), "[XEP-0115: Entity Capabilities]."),
?T("The main purpose of the module is to provide " ?T("The main purpose of the module is to provide "
"PEP functionality (see 'mod_pubsub').")], "PEP functionality (see _`mod_pubsub`_).")],
opts => opts =>
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

2
src/mod_configure.erl
View File

@ -1564,4 +1564,4 @@ mod_doc() ->
?T("The module provides server configuration functionality via " ?T("The module provides server configuration functionality via "
"https://xmpp.org/extensions/xep-0050.html" "https://xmpp.org/extensions/xep-0050.html"
"[XEP-0050: Ad-Hoc Commands]. This module requires " "[XEP-0050: Ad-Hoc Commands]. This module requires "
"'mod_adhoc' to be loaded.")}. "_`mod_adhoc`_ to be loaded.")}.

2
src/mod_delegation.erl
View File

@ -95,7 +95,7 @@ mod_doc() ->
?T("WARNING: Security issue: Namespace delegation gives components " ?T("WARNING: Security issue: Namespace delegation gives components "
"access to sensitive data, so permission should be granted " "access to sensitive data, so permission should be granted "
"carefully, only if you trust the component."), "", "carefully, only if you trust the component."), "",
?T("NOTE: This module is complementary to 'mod_privilege' but can " ?T("NOTE: This module is complementary to _`mod_privilege`_ but can "
"also be used separately.")], "also be used separately.")],
opts => opts =>
[{namespaces, [{namespaces,

2
src/mod_http_upload.erl
View File

@ -331,7 +331,7 @@ mod_doc() ->
"replaced with the virtual host name. NOTE: if GET requests " "replaced with the virtual host name. NOTE: if GET requests "
"are handled by 'mod_http_upload', the 'get_url' must match the " "are handled by 'mod_http_upload', the 'get_url' must match the "
"'put_url'. Setting it to a different value only makes " "'put_url'. Setting it to a different value only makes "
"sense if an external web server or 'mod_http_fileserver' " "sense if an external web server or _`mod_http_fileserver`_ "
"is used to serve the uploaded files.")}}, "is used to serve the uploaded files.")}},
{service_url, {service_url,
#{desc => ?T("Deprecated.")}}, #{desc => ?T("Deprecated.")}},

10
src/mod_last.erl
View File

@ -344,20 +344,20 @@ mod_doc() ->
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

14
src/mod_mam.erl
View File

@ -1456,7 +1456,7 @@ mod_doc() ->
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("This option determines how ejabberd's " ?T("This option determines how ejabberd's "
"stream management code (see 'mod_stream_mgmt') " "stream management code (see _`mod_stream_mgmt`_) "
"handles unacknowledged messages when the " "handles unacknowledged messages when the "
"connection is lost. Usually, such messages are " "connection is lost. Usually, such messages are "
"either bounced or resent. However, neither is " "either bounced or resent. However, neither is "
@ -1495,28 +1495,28 @@ mod_doc() ->
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Whether to destroy message archive of a room " ?T("Whether to destroy message archive of a room "
"(see 'mod_muc') when it gets destroyed. " "(see _`mod_muc`_) when it gets destroyed. "
"The default value is 'true'.")}}, "The default value is 'true'.")}},
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}},
{user_mucsub_from_muc_archive, {user_mucsub_from_muc_archive,
#{value => "true | false", #{value => "true | false",
desc => desc =>

6
src/mod_mix.erl
View File

@ -106,12 +106,12 @@ mod_doc() ->
"experimental feature, updated in 19.02, and is not " "experimental feature, updated in 19.02, and is not "
"yet ready to use in production. It's asserted that " "yet ready to use in production. It's asserted that "
"the MIX protocol is going to replace the MUC protocol " "the MIX protocol is going to replace the MUC protocol "
"in the future (see 'mod_muc')."), "", "in the future (see _`mod_muc`_)."), "",
?T("To learn more about how to use that feature, you can refer to " ?T("To learn more about how to use that feature, you can refer to "
"our tutorial: https://docs.ejabberd.im/tutorials/mix-010/" "our tutorial: https://docs.ejabberd.im/tutorials/mix-010/"
"[Getting started with XEP-0369: Mediated Information " "[Getting started with XEP-0369: Mediated Information "
"eXchange (MIX) v0.1]."), "", "eXchange (MIX) v0.1]."), "",
?T("The module depends on 'mod_mam'.")], ?T("The module depends on _`mod_mam`_.")],
opts => opts =>
[{access_create, [{access_create,
#{value => ?T("AccessName"), #{value => ?T("AccessName"),
@ -136,7 +136,7 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}]}. ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}}]}.
-spec route(stanza()) -> ok. -spec route(stanza()) -> ok.
route(#iq{} = IQ) -> route(#iq{} = IQ) ->

10
src/mod_mix_pam.erl
View File

@ -120,23 +120,23 @@ mod_doc() ->
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
-spec bounce_sm_packet({term(), stanza()}) -> {term(), stanza()}. -spec bounce_sm_packet({term(), stanza()}) -> {term(), stanza()}.
bounce_sm_packet({_, #message{to = #jid{lresource = <<>>} = To, bounce_sm_packet({_, #message{to = #jid{lresource = <<>>} = To,

14
src/mod_mqtt.erl
View File

@ -327,37 +327,37 @@ mod_doc() ->
{queue_type, {queue_type,
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("Same as top-level 'queue_type' option, " ?T("Same as top-level _`queue_type`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{ram_db_type, {ram_db_type,
#{value => "mnesia", #{value => "mnesia",
desc => desc =>
?T("Same as top-level 'default_ram_db' option, " ?T("Same as top-level _`default_ram_db`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, " ?T("Same as top-level _`default_db`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, " ?T("Same as top-level _`use_cache`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, " ?T("Same as top-level _`cache_size`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, " ?T("Same as top-level _`cache_missed`_ option, "
"but applied to this module only.")}}, "but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, " ?T("Same as top-level _`cache_life_time`_ option, "
"but applied to this module only.")}}]}. "but applied to this module only.")}}]}.
%%%=================================================================== %%%===================================================================

4
src/mod_muc.erl
View File

@ -1517,7 +1517,7 @@ mod_doc() ->
{queue_type, {queue_type,
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("Same as top-level 'queue_type' option, but applied to this module only.")}}, ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{regexp_room_id, {regexp_room_id,
#{value => "string()", #{value => "string()",
desc => desc =>
@ -1634,7 +1634,7 @@ mod_doc() ->
{logging, {logging,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("The public messages are logged using 'mod_muc_log'. " ?T("The public messages are logged using _`mod_muc_log`_. "
"The default value is 'false'.")}}, "The default value is 'false'.")}},
{members_by_default, {members_by_default,
#{value => "true | false", #{value => "true | false",

2
src/mod_muc_admin.erl
View File

@ -1413,4 +1413,4 @@ mod_doc() ->
[?T("This module provides commands to administer local MUC " [?T("This module provides commands to administer local MUC "
"services and their MUC rooms. It also provides simple " "services and their MUC rooms. It also provides simple "
"WebAdmin pages to view the existing rooms."), "", "WebAdmin pages to view the existing rooms."), "",
?T("This module depends on 'mod_muc'.")]}. ?T("This module depends on _`mod_muc`_.")]}.

2
src/mod_muc_log.erl
View File

@ -1021,7 +1021,7 @@ mod_doc() ->
?T("- URLs on messages and subjects are converted to hyperlinks."), "", ?T("- URLs on messages and subjects are converted to hyperlinks."), "",
?T("- Timezone used on timestamps is shown on the log files."), "", ?T("- Timezone used on timestamps is shown on the log files."), "",
?T("- A custom link can be added on top of each page."), "", ?T("- A custom link can be added on top of each page."), "",
?T("The module depends on 'mod_muc'.")], ?T("The module depends on _`mod_muc`_.")],
opts => opts =>
[{access_log, [{access_log,
#{value => ?T("AccessName"), #{value => ?T("AccessName"),

8
src/mod_offline.erl
View File

@ -1325,19 +1325,19 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}], ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example => example =>
[{?T("This example allows power users to have as much as 5000 " [{?T("This example allows power users to have as much as 5000 "
"offline messages, administrators up to 2000, and all the " "offline messages, administrators up to 2000, and all the "

4
src/mod_ping.erl
View File

@ -317,8 +317,8 @@ mod_doc() ->
"server ping request in less than period defined " "server ping request in less than period defined "
"in 'ping_ack_timeout' option: " "in 'ping_ack_timeout' option: "
"'kill' means destroying the underlying connection, " "'kill' means destroying the underlying connection, "
"'none' means to do nothing. NOTE: when 'mod_stream_mgmt' " "'none' means to do nothing. NOTE: when _`mod_stream_mgmt`_ "
"module is loaded and stream management is enabled by " "is loaded and stream management is enabled by "
"a client, killing the client connection doesn't mean " "a client, killing the client connection doesn't mean "
"killing the client session - the session will be kept " "killing the client session - the session will be kept "
"alive in order to give the client a chance to resume it. " "alive in order to give the client a chance to resume it. "

12
src/mod_privacy.erl
View File

@ -887,25 +887,25 @@ mod_doc() ->
"https://xmpp.org/extensions/xep-0191.html" "https://xmpp.org/extensions/xep-0191.html"
"[XEP-0191: Blocking Command] which is implemented by " "[XEP-0191: Blocking Command] which is implemented by "
"'mod_blocking' module. However, you still need " "'mod_blocking' module. However, you still need "
"'mod_privacy' loaded in order for 'mod_blocking' to work.")], "'mod_privacy' loaded in order for _`mod_blocking`_ to work.")],
opts => opts =>
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

10
src/mod_private.erl
View File

@ -128,23 +128,23 @@ mod_doc() ->
[{db_type, [{db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
-spec get_sm_features({error, stanza_error()} | empty | {result, [binary()]}, -spec get_sm_features({error, stanza_error()} | empty | {result, [binary()]},
jid(), jid(), binary(), binary()) -> jid(), jid(), binary(), binary()) ->

2
src/mod_privilege.erl
View File

@ -106,7 +106,7 @@ mod_doc() ->
?T("WARNING: Security issue: Privileged access gives components " ?T("WARNING: Security issue: Privileged access gives components "
"access to sensitive data, so permission should be granted " "access to sensitive data, so permission should be granted "
"carefully, only if you trust a component."), "", "carefully, only if you trust a component."), "",
?T("NOTE: This module is complementary to 'mod_delegation', " ?T("NOTE: This module is complementary to _`mod_delegation`_, "
"but can also be used separately.")], "but can also be used separately.")],
opts => opts =>
[{roster, [{roster,

4
src/mod_pubsub.erl
View File

@ -4269,7 +4269,7 @@ mod_doc() ->
"(https://xmpp.org/extensions/xep-0163.html" "(https://xmpp.org/extensions/xep-0163.html"
"[XEP-0163: Personal Eventing via Pubsub]) " "[XEP-0163: Personal Eventing via Pubsub]) "
"is enabled in the default ejabberd configuration file, " "is enabled in the default ejabberd configuration file, "
"and it requires 'mod_caps'.")], "and it requires _`mod_caps`_.")],
opts => opts =>
[{access_createnode, [{access_createnode,
#{value => "AccessName", #{value => "AccessName",
@ -4282,7 +4282,7 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to " ?T("Same as top-level _`default_db`_ option, but applied to "
"this module only.")}}, "this module only.")}},
{default_node_config, {default_node_config,
#{value => "List of Key:Value", #{value => "List of Key:Value",

10
src/mod_push.erl
View File

@ -191,23 +191,23 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
%%-------------------------------------------------------------------- %%--------------------------------------------------------------------
%% ejabberd command callback. %% ejabberd command callback.

8
src/mod_push_keepalive.erl
View File

@ -94,13 +94,13 @@ mod_options(_Host) ->
mod_doc() -> mod_doc() ->
#{desc => #{desc =>
[?T("This module tries to keep the stream management " [?T("This module tries to keep the stream management "
"session (see 'mod_stream_mgmt') of a disconnected " "session (see _`mod_stream_mgmt`_) of a disconnected "
"mobile client alive if the client enabled push " "mobile client alive if the client enabled push "
"notifications for that session. However, the normal " "notifications for that session. However, the normal "
"session resumption timeout is restored once a push " "session resumption timeout is restored once a push "
"notification is issued, so the session will be closed " "notification is issued, so the session will be closed "
"if the client doesn't respond to push notifications."), "", "if the client doesn't respond to push notifications."), "",
?T("The module depends on 'mod_push'.")], ?T("The module depends on _`mod_push`_.")],
opts => opts =>
[{resume_timeout, [{resume_timeout,
#{value => "timeout()", #{value => "timeout()",
@ -109,8 +109,8 @@ mod_doc() ->
"the session of a disconnected push client times out. " "the session of a disconnected push client times out. "
"This timeout is only in effect as long as no push " "This timeout is only in effect as long as no push "
"notification is issued. Once that happened, the " "notification is issued. Once that happened, the "
"resumption timeout configured for the 'mod_stream_mgmt' " "resumption timeout configured for _`mod_stream_mgmt`_ "
"module is restored. " "is restored. "
"The default value is '72' hours.")}}, "The default value is '72' hours.")}},
{wake_on_start, {wake_on_start,
#{value => "true | false", #{value => "true | false",

14
src/mod_roster.erl
View File

@ -1345,29 +1345,29 @@ mod_doc() ->
"This option does not affect the client in any way. " "This option does not affect the client in any way. "
"This option is only useful if option 'versioning' is " "This option is only useful if option 'versioning' is "
"set to 'true'. The default value is 'false'. " "set to 'true'. The default value is 'false'. "
"IMPORTANT: if you use 'mod_shared_roster' or " "IMPORTANT: if you use _`mod_shared_roster`_ or "
"'mod_shared_roster_ldap', you must set the value " " _`mod_shared_roster_ldap`_, you must set the value "
"of the option to 'false'.")}}, "of the option to 'false'.")}},
{db_type, {db_type,
#{value => "mnesia | sql", #{value => "mnesia | sql",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}], ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example => example =>
["modules:", ["modules:",
" ...", " ...",

12
src/mod_shared_roster.erl
View File

@ -1266,7 +1266,7 @@ mod_doc() ->
?T("- Displayed: A list of groups that will be in the " ?T("- Displayed: A list of groups that will be in the "
"rosters of this group's members. A group of other vhost can " "rosters of this group's members. A group of other vhost can "
"be identified with 'groupid@vhost'."), "", "be identified with 'groupid@vhost'."), "",
?T("This module depends on 'mod_roster'. " ?T("This module depends on _`mod_roster`_. "
"If not enabled, roster queries will return 503 errors.")], "If not enabled, roster queries will return 503 errors.")],
opts => opts =>
[{db_type, [{db_type,
@ -1274,25 +1274,25 @@ mod_doc() ->
desc => desc =>
?T("Define the type of storage where the module will create " ?T("Define the type of storage where the module will create "
"the tables and store user information. The default is " "the tables and store user information. The default is "
"the storage defined by the global option 'default_db', " "the storage defined by the top-level _`default_db`_ option, "
"or 'mnesia' if omitted. If 'sql' value is defined, " "or 'mnesia' if omitted. If 'sql' value is defined, "
"make sure you have defined the database.")}}, "make sure you have defined the database.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}], ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}],
example => example =>
[{?T("Take the case of a computer club that wants all its members " [{?T("Take the case of a computer club that wants all its members "
"seeing each other in their rosters. To achieve this, they " "seeing each other in their rosters. To achieve this, they "

2
src/mod_shared_roster_ldap.erl
View File

@ -796,7 +796,7 @@ mod_doc() ->
"disable the check. Default value is 'true'.")}}] ++ "disable the check. Default value is 'true'.")}}] ++
[{Opt, [{Opt,
#{desc => #{desc =>
{?T("Same as top-level '~s' option, but " {?T("Same as top-level _`~s`_ option, but "
"applied to this module only."), [Opt]}}} "applied to this module only."), [Opt]}}}
|| Opt <- [ldap_backups, ldap_base, ldap_uids, ldap_deref_aliases, || Opt <- [ldap_backups, ldap_base, ldap_uids, ldap_deref_aliases,
ldap_encrypt, ldap_password, ldap_port, ldap_rootdn, ldap_encrypt, ldap_password, ldap_port, ldap_rootdn,

6
src/mod_stream_mgmt.erl
View File

@ -962,12 +962,12 @@ mod_doc() ->
{queue_type, {queue_type,
#{value => "ram | file", #{value => "ram | file",
desc => desc =>
?T("Same as top-level 'queue_type' option, but applied to this module only.")}}, ?T("Same as top-level _`queue_type`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

10
src/mod_vcard.erl
View File

@ -640,23 +640,23 @@ mod_doc() ->
{db_type, {db_type,
#{value => "mnesia | sql | ldap", #{value => "mnesia | sql | ldap",
desc => desc =>
?T("Same as top-level 'default_db' option, but applied to this module only.")}}, ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
{use_cache, {use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}},
{vcard, {vcard,
#{value => ?T("vCard"), #{value => ?T("vCard"),
desc => desc =>

2
src/mod_vcard_ldap.erl
View File

@ -571,7 +571,7 @@ mod_doc() ->
}]}}] ++ }]}}] ++
[{Opt, [{Opt,
#{desc => #{desc =>
{?T("Same as top-level '~s' option, but " {?T("Same as top-level _`~s`_ option, but "
"applied to this module only."), [Opt]}}} "applied to this module only."), [Opt]}}}
|| Opt <- [ldap_base, ldap_servers, ldap_uids, || Opt <- [ldap_base, ldap_servers, ldap_uids,
ldap_deref_aliases, ldap_encrypt, ldap_password, ldap_deref_aliases, ldap_encrypt, ldap_password,

12
src/mod_vcard_xupdate.erl
View File

@ -228,26 +228,26 @@ mod_doc() ->
"frequently their presence. However, the overhead is significantly " "frequently their presence. However, the overhead is significantly "
"reduced by the use of caching, so you probably don't want " "reduced by the use of caching, so you probably don't want "
"to set 'use_cache' to 'false'."), "", "to set 'use_cache' to 'false'."), "",
?T("The module depends on 'mod_vcard'."), "", ?T("The module depends on _`mod_vcard`_."), "",
?T("NOTE: Nowadays https://xmpp.org/extensions/xep-0153.html" ?T("NOTE: Nowadays https://xmpp.org/extensions/xep-0153.html"
"[XEP-0153] is used mostly as \"read-only\", i.e. modern " "[XEP-0153] is used mostly as \"read-only\", i.e. modern "
"clients don't publish their avatars inside vCards. Thus " "clients don't publish their avatars inside vCards. Thus "
"in the majority of cases the module is only used along " "in the majority of cases the module is only used along "
"with 'mod_avatar' module for providing backward compatibility.")], "with _`mod_avatar`_ for providing backward compatibility.")],
opts => opts =>
[{use_cache, [{use_cache,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'use_cache' option, but applied to this module only.")}}, ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
{cache_size, {cache_size,
#{value => "pos_integer() | infinity", #{value => "pos_integer() | infinity",
desc => desc =>
?T("Same as top-level 'cache_size' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
{cache_missed, {cache_missed,
#{value => "true | false", #{value => "true | false",
desc => desc =>
?T("Same as top-level 'cache_missed' option, but applied to this module only.")}}, ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
{cache_life_time, {cache_life_time,
#{value => "timeout()", #{value => "timeout()",
desc => desc =>
?T("Same as top-level 'cache_life_time' option, but applied to this module only.")}}]}. ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.