Browse code

Fixing typos, changing names

oej authored on 10/10/2009 12:23:09
Showing 3 changed files
... ...
@@ -2,18 +2,19 @@
2 2
 -------------------------------------------------------------------------
3 3
 IMPORTANT NOTES
4 4
 
5
-1) The GPL applies to this copy of SIP Express Router software (ser).
5
+1) The GPL applies to this copy of SIP Router software (sip-router).
6 6
 
7
-2) ser software allows programmers to plug-in external modules to the
7
+2) SIP-router software allows programmers to plug-in external modules to the
8 8
    core part. Note that GPL mandates all plug-ins developed for the
9
-   ser software released under GPL license to be GPL-ed or use a GPL
10
-   compatible free software license.
9
+   SIP-router software are to be released under GPL license to be GPL-ed or 
10
+   use a GPL compatible free software license.
11 11
 
12 12
    (see http://www.gnu.org/copyleft/gpl-faq.html#GPLAndPlugins
13 13
     for a detailed explanation)
14 14
 
15 15
 3) Note that the GPL bellow is copyrighted by the Free Software Foundation,
16
-   but the ser software is copyrighted by FhG
16
+   but the SIP-router software is copyrighted by multiple individuals and
17
+   companies.
17 18
 
18 19
 -------------------------------------------------------------------------
19 20
 
... ...
@@ -22,11 +23,12 @@ GNU Licence FAQ
22 22
 This FAQ provides answers to most frequently asked questions. To fully
23 23
 understand implications of the GNU license, read it.
24 24
 
25
-- you can run SER for any purpose
25
+- you can run SIP-router for any purpose
26 26
 - you can redistribute it as long as you include source code and
27 27
   license conditions with the distribution
28
-- you cannot release programs derived from SER without releasing
28
+- you cannot release programs derived from SIP-router without releasing
29 29
   their source code
30
+- you can not change the copyright of any part of SIP-router
30 31
 
31 32
 
32 33
 -------------------------------------------------------------------------
... ...
@@ -71,17 +71,17 @@ Chapter 1. Admin Guide
71 71
 1. Overview
72 72
 
73 73
    This module hides the routing headers that show topology details. It it
74
-   is not affected by the server being transaction statless or stateful.
74
+   is not affected by the server being transaction stateless or stateful.
75 75
    The script interpretor gets the SIP messages decoded, so all
76 76
    functionality existing so far is preserved.
77 77
 
78
-   The module is transparent for config writer. It only needs to be loaded
79
-   (tune the parameters if wanted). The SIP server can be restarted
80
-   whitout affecting ongoing calls - once it is up, can encode/decode
81
-   topology details, thus no call is lost.
78
+   The module is transparent for the configuration writer. It only needs
79
+   to be loaded (tune the parameters if needed). The SIP server can be
80
+   restarted whitout affecting ongoing calls - once it is up, can
81
+   encode/decode topology details, thus no call will be lost.
82 82
 
83 83
    By using same mask_key, many SIP servers can decode the message, for
84
-   examlple, applicable for servers behind load balancers.
84
+   example, applicable for servers behind load balancers.
85 85
 
86 86
 2. Dependencies
87 87
 
... ...
@@ -123,10 +123,10 @@ modparam("topoh", "mask_key", "some secret here")
123 123
 
124 124
 3.2. mask_callid (integer)
125 125
 
126
-   Whether to encode or not the call-id. Some SIP extensions include the
127
-   call-id in SIP message payload or header, so it is safe to not encode
128
-   call-id in such cases. Well-known extensions such as call transfer or
129
-   conference join will be added to work with encoded call-id.
126
+   Whether to encode the Call-id: header. Some SIP extensions include the
127
+   Call-id in the SIP message payload or header, so it is safe to not
128
+   encode Call-id in such cases. Well-known extensions such as call
129
+   transfer or conference join will be added to work with encoded Call-id.
130 130
 
131 131
    Default value is 0 (do not mask).
132 132
 
... ...
@@ -159,7 +159,7 @@ modparam("topoh", "uparam_prefix", "xyz")
159 159
 
160 160
 3.5. vparam_name (str)
161 161
 
162
-   Name of Via param where to store encoded value.
162
+   Name of Via: parameter where to store encoded value.
163 163
 
164 164
    Default value is "branch".
165 165
 
... ...
@@ -170,7 +170,7 @@ modparam("topoh", "vparam_name", "myv")
170 170
 
171 171
 3.6. vparam_prefix (str)
172 172
 
173
-   Prefix to be added in encoded Via params.
173
+   Prefix to be added in encoded Via: parameters.
174 174
 
175 175
    Default value is "z9hG4bKsr-".
176 176
 
... ...
@@ -17,19 +17,19 @@
17 17
 	<title>Overview</title>
18 18
 	<para>
19 19
 		This module hides the routing headers that show topology details.
20
-		It it is not affected by the server being transaction statless or
20
+		It it is not affected by the server being transaction stateless or
21 21
 		stateful. The script interpretor gets the SIP messages decoded,
22 22
 		so all functionality existing so far is preserved.
23 23
 	</para>
24 24
 	<para>
25
-		The module is transparent for config writer. It only needs to be
26
-		loaded (tune the parameters if wanted). The SIP server can be restarted
25
+		The module is transparent for the configuration writer. It only needs to be
26
+		loaded (tune the parameters if needed). The SIP server can be restarted
27 27
 		whitout affecting ongoing calls - once it is up, can encode/decode
28
-		topology details, thus no call is lost.
28
+		topology details, thus no call will be lost.
29 29
 	</para>
30 30
 	<para>
31 31
 		By using same mask_key, many SIP servers can decode the message,
32
-		for examlple, applicable for servers behind load balancers.
32
+		for example, applicable for servers behind load balancers.
33 33
 	</para>
34 34
 	</section>
35 35
 	<section>
... ...
@@ -88,11 +88,11 @@ modparam("topoh", "mask_key", "some secret here")
88 88
 	<section>
89 89
 		<title><varname>mask_callid</varname> (integer)</title>
90 90
 		<para>
91
-			Whether to encode or not the call-id. Some SIP extensions include
92
-			the call-id in SIP message payload or header, so it is safe to
93
-			not encode call-id in such cases. Well-known extensions such as
91
+			Whether to encode the Call-id: header. Some SIP extensions include
92
+			the Call-id in the SIP message payload or header, so it is safe to
93
+			not encode Call-id in such cases. Well-known extensions such as
94 94
 			call transfer or conference join will be added to work with encoded
95
-			call-id.
95
+			Call-id.
96 96
 		</para>
97 97
 		<para>
98 98
 		<emphasis>
... ...
@@ -149,7 +149,7 @@ modparam("topoh", "uparam_prefix", "xyz")
149 149
 		<section>
150 150
 		<title><varname>vparam_name</varname> (str)</title>
151 151
 		<para>
152
-		Name of Via param where to store encoded value.
152
+		Name of Via: parameter where to store encoded value.
153 153
 		</para>
154 154
 		<para>
155 155
 		<emphasis>
... ...
@@ -168,7 +168,7 @@ modparam("topoh", "vparam_name", "myv")
168 168
 	<section>
169 169
 		<title><varname>vparam_prefix</varname> (str)</title>
170 170
 		<para>
171
-		Prefix to be added in encoded Via params.
171
+		Prefix to be added in encoded Via: parameters.
172 172
 		</para>
173 173
 		<para>
174 174
 		<emphasis>