Module: sip-router Branch: master Commit: 7eb41a8e6f5e89c67dedb60903f0e6119f115851 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7eb41a8… Author: oej &lt;oej(a)edvina.net&gt; Committer: oej &lt;oej(a)edvina.net&gt; Date: Sat Oct 10 14:23:09 2009 +0200 Fixing typos, changing names --- COPYING | 16 +++++++++------- modules/topoh/README | 24 ++++++++++++------------ modules/topoh/doc/topoh_admin.xml | 22 +++++++++++----------- 3 files changed, 32 insertions(+), 30 deletions(-) diff --git a/COPYING b/COPYING index 21550e8..5d1f230 100644 --- a/COPYING +++ b/COPYING @@ -2,18 +2,19 @@ ------------------------------------------------------------------------- IMPORTANT NOTES -1) The GPL applies to this copy of SIP Express Router software (ser). +1) The GPL applies to this copy of SIP Router software (sip-router). -2) ser software allows programmers to plug-in external modules to the +2) SIP-router software allows programmers to plug-in external modules to the core part. Note that GPL mandates all plug-ins developed for the - ser software released under GPL license to be GPL-ed or use a GPL - compatible free software license. + SIP-router software are to be released under GPL license to be GPL-ed or + use a GPL compatible free software license. (see http://www.gnu.org/copyleft/gpl-faq.html#GPLAndPlugins for a detailed explanation) 3) Note that the GPL bellow is copyrighted by the Free Software Foundation, - but the ser software is copyrighted by FhG + but the SIP-router software is copyrighted by multiple individuals and + companies. ------------------------------------------------------------------------- @@ -22,11 +23,12 @@ GNU Licence FAQ This FAQ provides answers to most frequently asked questions. To fully understand implications of the GNU license, read it. -- you can run SER for any purpose +- you can run SIP-router for any purpose - you can redistribute it as long as you include source code and license conditions with the distribution -- you cannot release programs derived from SER without releasing +- you cannot release programs derived from SIP-router without releasing their source code +- you can not change the copyright of any part of SIP-router ------------------------------------------------------------------------- diff --git a/modules/topoh/README b/modules/topoh/README index 7582106..f6bb788 100644 --- a/modules/topoh/README +++ b/modules/topoh/README @@ -71,17 +71,17 @@ Chapter 1. Admin Guide 1. Overview This module hides the routing headers that show topology details. It it - is not affected by the server being transaction statless or stateful. + is not affected by the server being transaction stateless or stateful. The script interpretor gets the SIP messages decoded, so all functionality existing so far is preserved. - The module is transparent for config writer. It only needs to be loaded - (tune the parameters if wanted). The SIP server can be restarted - whitout affecting ongoing calls - once it is up, can encode/decode - topology details, thus no call is lost. + The module is transparent for the configuration writer. It only needs + to be loaded (tune the parameters if needed). The SIP server can be + restarted whitout affecting ongoing calls - once it is up, can + encode/decode topology details, thus no call will be lost. By using same mask_key, many SIP servers can decode the message, for - examlple, applicable for servers behind load balancers. + example, applicable for servers behind load balancers. 2. Dependencies @@ -123,10 +123,10 @@ modparam("topoh", "mask_key", "some secret here") 3.2. mask_callid (integer) - Whether to encode or not the call-id. Some SIP extensions include the - call-id in SIP message payload or header, so it is safe to not encode - call-id in such cases. Well-known extensions such as call transfer or - conference join will be added to work with encoded call-id. + Whether to encode the Call-id: header. Some SIP extensions include the + Call-id in the SIP message payload or header, so it is safe to not + encode Call-id in such cases. Well-known extensions such as call + transfer or conference join will be added to work with encoded Call-id. Default value is 0 (do not mask). @@ -159,7 +159,7 @@ modparam("topoh", "uparam_prefix", "xyz") 3.5. vparam_name (str) - Name of Via param where to store encoded value. + Name of Via: parameter where to store encoded value. Default value is "branch". @@ -170,7 +170,7 @@ modparam("topoh", "vparam_name", "myv") 3.6. vparam_prefix (str) - Prefix to be added in encoded Via params. + Prefix to be added in encoded Via: parameters. Default value is "z9hG4bKsr-". diff --git a/modules/topoh/doc/topoh_admin.xml b/modules/topoh/doc/topoh_admin.xml index 85648df..4da3862 100644 --- a/modules/topoh/doc/topoh_admin.xml +++ b/modules/topoh/doc/topoh_admin.xml @@ -17,19 +17,19 @@ <title>Overview</title> <para> This module hides the routing headers that show topology details. - It it is not affected by the server being transaction statless or + It it is not affected by the server being transaction stateless or stateful. The script interpretor gets the SIP messages decoded, so all functionality existing so far is preserved. </para> <para> - The module is transparent for config writer. It only needs to be - loaded (tune the parameters if wanted). The SIP server can be restarted + The module is transparent for the configuration writer. It only needs to be + loaded (tune the parameters if needed). The SIP server can be restarted whitout affecting ongoing calls - once it is up, can encode/decode - topology details, thus no call is lost. + topology details, thus no call will be lost. </para> <para> By using same mask_key, many SIP servers can decode the message, - for examlple, applicable for servers behind load balancers. + for example, applicable for servers behind load balancers. </para> </section> <section> @@ -88,11 +88,11 @@ modparam("topoh", "mask_key", "some secret here") <section> <title><varname>mask_callid</varname> (integer)</title> <para> - Whether to encode or not the call-id. Some SIP extensions include - the call-id in SIP message payload or header, so it is safe to - not encode call-id in such cases. Well-known extensions such as + Whether to encode the Call-id: header. Some SIP extensions include + the Call-id in the SIP message payload or header, so it is safe to + not encode Call-id in such cases. Well-known extensions such as call transfer or conference join will be added to work with encoded - call-id. + Call-id. </para> <para> <emphasis> @@ -149,7 +149,7 @@ modparam("topoh", "uparam_prefix", "xyz") <section> <title><varname>vparam_name</varname> (str)</title> <para> - Name of Via param where to store encoded value. + Name of Via: parameter where to store encoded value. </para> <para> <emphasis> @@ -168,7 +168,7 @@ modparam("topoh", "vparam_name", "myv") <section> <title><varname>vparam_prefix</varname> (str)</title> <para> - Prefix to be added in encoded Via params. + Prefix to be added in encoded Via: parameters. </para> <para> <emphasis>