Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Feb 16, 2020
1 parent d2f6529 commit 57e4dee
Show file tree
Hide file tree
Showing 157 changed files with 1,909 additions and 1,909 deletions.
24 changes: 12 additions & 12 deletions modules/aaa_radius/README
View file
Expand Up @@ -216,14 +216,14 @@ modparam("aaa_radius", "fetch_all_values", 1)

The first parameter represents the name of the set that
contains the list of attributes and pvars that will form the
authentication request (see the “sets” module parameter).
authentication request (see the "sets" module parameter).

The second parameter represents the name of the set that
contains the list of attributes and pvars that will be
extracted form the authentication reply (see the “sets” module
extracted form the authentication reply (see the "sets" module
parameter).

The sets must be defined using the “sets” exported parameter.
The sets must be defined using the "sets" exported parameter.

The function return TRUE (retcode 1) if authentication was
successful, FALSE (retcode -1) if an error (any kind of error)
Expand Down Expand Up @@ -282,14 +282,14 @@ radius_send_acct("set1");

The first parameter represents the name of the set that
contains the list of attributes and pvars that will form the
authentication request (see the “sets” module parameter).
authentication request (see the "sets" module parameter).

The second parameter represents the name of the set that
contains the list of attributes and pvars that will be
extracted form the authentication reply (see the “sets” module
extracted form the authentication reply (see the "sets" module
parameter).

The sets must be defined using the “sets” exported parameter.
The sets must be defined using the "sets" exported parameter.

The function return TRUE (retcode 1) if authentication was
successful, FALSE (retcode -1) if an error (any kind of error)
Expand Down Expand Up @@ -399,10 +399,10 @@ Chapter 3. Contributors
6. Boris Ratner 4 2 38 5
7. Anca Vamanu 4 2 5 3
8. Matt Lehner 3 1 32 3
9. Авдиенко Михаил 3 1 7 17
9. Avdienko Mihail 3 1 7 17
10. Alex Massover 3 1 6 1

All remaining contributors: Julián Moreno Patiño, Walter Doekes
All remaining contributors: Juli�n Moreno Pati�o, Walter Doekes
(@wdoekes), Vlad Patrascu (@rvlad-patrascu).

(1) DevScore = author_commits + author_lines_added /
Expand Down Expand Up @@ -430,13 +430,13 @@ Chapter 3. Contributors
3. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Jun 2018
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2017
5. Ionut Ionita (@ionutrazvanionita) Jun 2015 - Apr 2017
6. Julián Moreno Patiño Feb 2016 - Feb 2016
6. Juli�n Moreno Pati�o Feb 2016 - Feb 2016
7. Walter Doekes (@wdoekes) Jun 2014 - Jun 2014
8. Boris Ratner Mar 2012 - Jan 2013
9. Matt Lehner Aug 2010 - Aug 2010
10. Irina-Maria Stanescu Jul 2009 - Jul 2010

All remaining contributors: Авдиенко Михаил, Alex Massover,
All remaining contributors: Avdienko Mihail, Alex Massover,
Anca Vamanu.

(1) including any documentation-related commits, excluding
Expand All @@ -453,6 +453,6 @@ Chapter 4. Documentation

doc copyrights:

Copyright © 2009 Irina-Maria Stanescu
Copyright � 2009 Irina-Maria Stanescu

Copyright © 2009 Voice Sistem SRL
Copyright � 2009 Voice Sistem SRL
48 changes: 24 additions & 24 deletions modules/acc/README
View file
Expand Up @@ -147,8 +147,8 @@ Chapter 1. Admin Guide
The accounting module will log by default a fixed set of
attributes for the transaction - if you customize your
accounting by adding more information to be logged, please see
the next chapter about extra accounting - Section 1.2, “Extra
accounting”.
the next chapter about extra accounting - Section 1.2, "Extra
accounting".

The fixed minimal accounting information is:
* Request Method name
Expand Down Expand Up @@ -368,10 +368,10 @@ Note
the listed modules must be loaded before this module):
* tm -- Transaction Manager
* a database module -- If SQL support is used.
* rr -- Record Route, if “detect_direction” module parameter
* rr -- Record Route, if "detect_direction" module parameter
is enabled.
* an aaa module
* dialog -- Dialog, if “cdr” option is used
* dialog -- Dialog, if "cdr" option is used

1.5.2. External Libraries or Applications

Expand Down Expand Up @@ -421,7 +421,7 @@ modparam("acc", "detect_direction", 1)
1.6.4. extra_fields (string)

Defines the tag-log_value set to be used in extra fields
accounting. See Section 1.2, “Extra accounting” for a detailed
accounting. See Section 1.2, "Extra accounting" for a detailed
description of the Extra accounting.

If empty, extra accounting support will be disabled.
Expand All @@ -444,7 +444,7 @@ modparam("acc", "extra_fields","a->2345;b->2346")
1.6.5. leg_fields (string)

Defines the tag-log_value set to be used in multi-leg
accounting. See Section 1.3, “Multi Call-Legs accounting” for a
accounting. See Section 1.3, "Multi Call-Legs accounting" for a
detailed description of the Multi Call-Legs accounting.

If empty, multi-leg accounting support will be disabled.
Expand Down Expand Up @@ -492,7 +492,7 @@ modparam("acc", "log_facility", "LOG_DAEMON")
If the parameter is set to empty string, the AAA accounting
support will be disabled.

Default value is “NULL”.
Default value is "NULL".

Example 1.8. Set aaa_url parameter
...
Expand All @@ -514,7 +514,7 @@ modparam("acc", "service_type", 15)

Table name of accounting successful calls -- database specific.

Default value is “acc”
Default value is "acc"

Example 1.10. db_table_acc example
modparam("acc", "db_table_acc", "myacc_table")
Expand All @@ -523,7 +523,7 @@ modparam("acc", "db_table_acc", "myacc_table")

Table name for accounting missed calls -- database specific.

Default value is “missed_calls”
Default value is "missed_calls"

Example 1.11. db_table_missed_calls example
modparam("acc", "db_table_missed_calls", "myMC_table")
Expand All @@ -533,7 +533,7 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
SQL address -- database specific. If is set to NULL or empty
string, the SQL support is disabled.

Default value is “NULL” (SQL disabled).
Default value is "NULL" (SQL disabled).

Example 1.12. db_url example
modparam("acc", "db_url", "mysql://user:password@localhost/opensips")
Expand All @@ -543,7 +543,7 @@ modparam("acc", "db_url", "mysql://user:password@localhost/opensips")
Column name in accounting table to store the request's method
name as string.

Default value is “method”.
Default value is "method".

Example 1.13. acc_method_column example
modparam("acc", "acc_method_column", "method")
Expand All @@ -553,7 +553,7 @@ modparam("acc", "acc_method_column", "method")
Column name in accounting table to store the From header TAG
parameter.

Default value is “from_tag”.
Default value is "from_tag".

Example 1.14. acc_from_tag_column example
modparam("acc", "acc_from_tag_column", "from_tag")
Expand All @@ -563,7 +563,7 @@ modparam("acc", "acc_from_tag_column", "from_tag")
Column name in accounting table to store the To header TAG
parameter.

Default value is “to_tag”.
Default value is "to_tag".

Example 1.15. acc_to_tag_column example
modparam("acc", "acc_to_tag_column", "to_tag")
Expand All @@ -573,7 +573,7 @@ modparam("acc", "acc_to_tag_column", "to_tag")
Column name in accounting table to store the request's Callid
value.

Default value is “callid”.
Default value is "callid".

Example 1.16. acc_callid_column example
modparam("acc", "acc_callid_column", "callid")
Expand All @@ -583,7 +583,7 @@ modparam("acc", "acc_callid_column", "callid")
Column name in accounting table to store the final reply's
numeric code value in string format.

Default value is “sip_code”.
Default value is "sip_code".

Example 1.17. acc_sip_code_column example
modparam("acc", "acc_sip_code_column", "sip_code")
Expand All @@ -593,7 +593,7 @@ modparam("acc", "acc_sip_code_column", "sip_code")
Column name in accounting table to store the final reply's
reason phrase value.

Default value is “sip_reason”.
Default value is "sip_reason".

Example 1.18. acc_sip_reason_column example
modparam("acc", "acc_sip_reason_column", "sip_reason")
Expand All @@ -603,7 +603,7 @@ modparam("acc", "acc_sip_reason_column", "sip_reason")
Column name in accounting table to store the time stamp of the
transaction completion in date-time format.

Default value is “time”.
Default value is "time".

Example 1.19. acc_time_column example
modparam("acc", "acc_time_column", "time")
Expand Down Expand Up @@ -794,7 +794,7 @@ acc_log_request("403 Destination not allowed");
1.8.4. acc_db_request(comment, table)

Like acc_log_request, acc_db_request reports on a request. The
report is sent to database at “db_url”, in the table referred
report is sent to database at "db_url", in the table referred
to in the second action parameter.

Meaning of the parameters is as follows:
Expand All @@ -816,7 +816,7 @@ acc_db_request("$T_reply_code $(<reply>rr)","acc");
1.8.5. acc_aaa_request(comment)

Like acc_log_request, acc_aaa_request reports on a request. It
reports to aaa server as configured in “aaa_url”.
reports to aaa server as configured in "aaa_url".

Meaning of the parameters is as follows:
* comment - Comment describing how the request completed -
Expand Down Expand Up @@ -1033,7 +1033,7 @@ Chapter 3. Contributors
(@juha-h), Elena-Ramona Modroiu, Ryan Bullock (@rrb3942),
Ovidiu Sas (@ovidiusas), Sergio Gutierrez, Peter Nixon, Alex
Massover, Nils Ohlmeier, Konstantin Bokarius, Jesus Rodrigues,
Julien Blache, Julián Moreno Patiño, Dusan Klinec, Edson
Julien Blache, Juli�n Moreno Pati�o, Dusan Klinec, Edson
Gellert Schubert.

(1) DevScore = author_commits + author_lines_added /
Expand Down Expand Up @@ -1062,7 +1062,7 @@ Chapter 3. Contributors
4. Razvan Crainea (@razvancrainea) Aug 2010 - Sep 2019
5. Dan Pascu (@danpascu) Jul 2004 - Sep 2018
6. Ionut Ionita (@ionutrazvanionita) Feb 2015 - May 2017
7. Julián Moreno Patiño Feb 2016 - Feb 2016
7. Juli�n Moreno Pati�o Feb 2016 - Feb 2016
8. Dusan Klinec Dec 2015 - Dec 2015
9. Vlad Paiu (@vladpaiu) Jun 2011 - Oct 2015
10. Ryan Bullock (@rrb3942) Mar 2012 - Sep 2012
Expand Down Expand Up @@ -1095,8 +1095,8 @@ Chapter 4. Documentation

doc copyrights:

Copyright © 2009-2013 OpenSIPS Solutions
Copyright � 2009-2013 OpenSIPS Solutions

Copyright © 2004-2009 Voice Sistem SRL
Copyright � 2004-2009 Voice Sistem SRL

Copyright © 2002-2003 FhG FOKUS
Copyright � 2002-2003 FhG FOKUS
16 changes: 8 additions & 8 deletions modules/alias_db/README
View file
Expand Up @@ -90,7 +90,7 @@ Chapter 1. Admin Guide
Database URL.

Default value is
“mysql://opensipsro:opensipsro@localhost/opensips”.
"mysql://opensipsro:opensipsro@localhost/opensips".

Example 1.1. Set db_url parameter
...
Expand All @@ -102,7 +102,7 @@ me")

Name of the column storing username.

Default value is “username”.
Default value is "username".

Example 1.2. Set user_column parameter
...
Expand All @@ -113,7 +113,7 @@ modparam("alias_db", "user_column", "susername")

Name of the column storing user's domain.

Default value is “domain”.
Default value is "domain".

Example 1.3. Set domain_column parameter
...
Expand All @@ -124,7 +124,7 @@ modparam("alias_db", "domain_column", "sdomain")

Name of the column storing alias username.

Default value is “alias_username”.
Default value is "alias_username".

Example 1.4. Set alias_user_column parameter
...
Expand All @@ -135,7 +135,7 @@ modparam("alias_db", "alias_user_column", "auser")

Name of the column storing alias domain.

Default value is “alias_domain”.
Default value is "alias_domain".

Example 1.5. Set alias_domain_column parameter
...
Expand All @@ -147,7 +147,7 @@ modparam("alias_db", "alias_domain_column", "adomain")
Specifies the prefix to be stripped from the domain in R-URI
before doing the search.

Default value is “NULL”.
Default value is "NULL".

Example 1.6. Set domain_prefix parameter
...
Expand All @@ -159,7 +159,7 @@ modparam("alias_db", "domain_prefix", "sip.")
If the alias resolves to many SIP IDs, the first is replacing
the R-URI, the rest are added as branches.

Default value is “0” (0 - don't add branches; 1 - add
Default value is "0" (0 - don't add branches; 1 - add
branches).

Example 1.7. Set append_branches parameter
Expand Down Expand Up @@ -331,4 +331,4 @@ Chapter 4. Documentation

doc copyrights:

Copyright © 2005-2009 Voice Sistem SRL
Copyright � 2005-2009 Voice Sistem SRL

0 comments on commit 57e4dee

Please sign in to comment.