Browse code

Fix some typos and capitalisation in INSTALL

Sven Neuhaus authored on 29/08/2014 11:14:18
Showing 1 changed files
... ...
@@ -23,23 +23,23 @@
23 23
 Table of Contents
24 24
 =================
25 25
 
26
-1. SIP Server Flavours
27
-2. Supported Architectures and Requirements
28
-3. Howto Build SIP Server From the Source Distribution
29
-   3.1 Kamailio Fast Track Installation
30
-   3.2 Details Installing from Source Code
31
-     A) Set SIP Server Flavour
32
-     B) Build Commands
33
-4. Quick-Start Installation Guide
34
-   A) Getting Help
26
+1. SIP server flavours
27
+2. Supported architectures and requirements
28
+3. Howto Build SIP server from the source distribution
29
+   3.1 Kamailio fast track installation
30
+   3.2 Details installing from source code
31
+     A) Set SIP server flavour
32
+     B) Build commands
33
+4. Quick-Start installation guide
34
+   A) Getting help
35 35
    B) Disclaimers
36
-   C) Quick Start
37
-   D) SIP Server with Persistent Data Storage
36
+   C) Quick start
37
+   D) SIP server with persistent data storage
38 38
 5. Troubleshooting
39 39
 
40 40
 
41 41
 
42
-1. SIP Server Flavours
42
+1. SIP server flavours
43 43
 ----------------------
44 44
 
45 45
 The two major SIP server flavours are:
... ...
@@ -69,7 +69,7 @@ Several installation tutorials for Kamailio are available on the web wiki:
69 69
   - http://www.kamailio.org/wiki/
70 70
 
71 71
 
72
-2. Supported Architectures and Requirements
72
+2. Supported architectures and requirements
73 73
 -------------------------------------------
74 74
 
75 75
 Supported operating systems:
... ...
@@ -97,7 +97,7 @@ Requirements:
97 97
 
98 98
 - gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version
99 99
   but it might require some options tweaking for best performance)
100
-- bison or yacc (Berkley yacc)
100
+- bison or yacc (Berkley Yacc)
101 101
 - flex
102 102
 - GNU make (on Linux this is the standard "make", on *BSD and Solaris it is
103 103
   called "gmake") version >= 3.80 (recommended 3.81).
... ...
@@ -105,10 +105,10 @@ Requirements:
105 105
 - GNU tar ("gtar" on Solaris) and gzip if you want "make tar" to work
106 106
 - GNU install, BSD install or Solaris install if you want "make
107 107
   install", "make bin", "make sunpkg" to work
108
-- libmysqlclient & libz (zlib) if you want Mysql support (the db_mysql module)
108
+- libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module)
109 109
 - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) 
110 110
    modules
111
-- libradiusclient-ng (> 5.0) if you need radius support (the auth_radius,
111
+- libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius,
112 112
   group_radius, uri_radius and avp_radius modules)
113 113
 - libpq if you need PostgreSQL support (the db_postgres module)
114 114
 - libexpat if you want the jabber gateway support (the jabber module) or the
... ...
@@ -120,19 +120,19 @@ Requirements:
120 120
 - unixodbc - libs and devel headers - if you want UNIXODBC support as
121 121
   DB underlayer
122 122
 - libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support
123
-  for the Management interface (MI)
124
-- libperl - libs and devel headers - if you want PERL connector to support
125
-  perl scripting from you config file (perl module)
123
+  for the management interface (MI)
124
+- libperl - libs and devel headers - if you want the perl connector to support
125
+  perl scripting from your config file (perl module)
126 126
 - libsnmp9 - libs and devel headers - if you want SNMP client functionality 
127 127
   (SNMP AgentX subagent) for Kamailio
128 128
 - libldap libs and devel headers v2.1 or greater - if you want LDAP support
129 129
 - libpcre libs and devel headers - if you want to compile the lcr and dialplan
130 130
   modules
131 131
 - libsctp devel headers - if you want to compile the SCTP transport in the core
132
-- libssl devel headers (openssl project) - if you want to compule the TLS module
133
-- linunistring - for the Websockets module
134
-- python and devel headers for python module
135
-- jdk and gcj for java module
132
+- libssl devel headers (openssl project) - if you want to compile the TLS module
133
+- libunistring - for the WebSocket module
134
+- python and devel headers for the Python module
135
+- jdk and gcj for Java module
136 136
 
137 137
 
138 138
 OS Notes:
... ...
@@ -234,8 +234,8 @@ OS Notes:
234 234
 ....................................
235 235
 
236 236
 
237
-If you are familiar with Unix/Linux  build tools aready and you installed
238
-required dependency, then you can just follow this section, otherwise
237
+If you are familiar with Unix/Linux build tools aready and you installed
238
+the required dependencies, then you can just follow this section, otherwise
239 239
 skip over it.
240 240
 
241 241
 To get the SIP server installed, in the folder with source code run:
... ...
@@ -255,7 +255,7 @@ tls, run:
255 255
 .......................................
256 256
 
257 257
 
258
-A) Set SIP Server Flavour
258
+A) Set SIP server Flavour
259 259
 
260 260
 If you don't have a clean source tree, first do:
261 261
    make proper
... ...
@@ -269,7 +269,7 @@ To build SER flavour, you have to run first:
269 269
 The parameter 'FLAVOUR=ser' must be given all the time when make target
270 270
 is 'cfg'.
271 271
 
272
-B) Build Commands
272
+B) Build commands
273 273
 
274 274
   The SIP server is split in four main parts: The core, the modules, the
275 275
   utilties, and scripts/examples.  When you build, you can decide to build
... ...
@@ -331,12 +331,12 @@ are grouped based on Debian packaging rules. For example:
331 331
 
332 332
   There are also in addition some "convenience" groups:
333 333
 
334
-	mysql 		- Include all the db modules dependent and the mysql db driver
335
-	postgres 	- Include all the db modules and the postgres db driver
334
+	mysql 		- Include all the db modules dependent and the MySQL db driver
335
+	postgres 	- Include all the db modules and the PostgreSQL db driver
336 336
 	radius 		- Include all modules on radiusclient
337 337
 	presence 	- Include all the presence modules
338 338
 
339
-  Ex. to make a standard installation with Mysql, use:
339
+  Ex. to make a standard installation with MySQL, use:
340 340
 	make group_include="standard mysql" all
341 341
 
342 342
   In addition to group_include (or instead), you can use 
... ...
@@ -419,7 +419,7 @@ Configure:
419 419
 
420 420
   All future make invocations will include the mysql module and will build in debug mode
421 421
 
422
-  Note: if config.mak doesn't exist (e.g. initial checkout or after a make 
422
+  Note: If config.mak doesn't exist (e.g. initial checkout or after a make 
423 423
   proper) or if Makefile.defs was changed, the config will be re-generated
424 424
   automatically by the first make command. For example:
425 425
   	make cfg  include_modules=db_mysql; make all
... ...
@@ -514,9 +514,9 @@ Install:
514 514
 
515 515
   Note: If you use prefix parameter in make install then you also need
516 516
   to use this parameter in previous make commands, i.e. make, make modules,
517
-  or make all. If you fail to do this then SIP Router will look for the default
517
+  or make all. If you fail to do this then SIP server will look for the default
518 518
   configuration file in a wrong directory, because the directory of the
519
-  default configuration file is hard coded into SIP server during compile time. 
519
+  default configuration file is hardcoded into SIP server during compile time. 
520 520
   When you use a different prefix parameter when installing then the 
521 521
   directory hard coded in SIP server and the directory in which the file will be 
522 522
   installed by make install will not match. (You can specify exact location
... ...
@@ -532,7 +532,7 @@ Install:
532 532
   /usr/local/etc/kamailio/kamailio.cfg (because there was no prefix parameter
533 533
   make all and /usr/local is the default value of prefix).
534 534
 
535
-  Workaround is trivial, use the same parameters in all make commands:
535
+  The workaround is trivial, use the same parameters in all make commands:
536 536
 	make prefix=/ all
537 537
 	make prefix=/ install
538 538
   or save the desired prefix in the make config (e.g.: make cfg prefix=/).
... ...
@@ -541,10 +541,10 @@ Install:
541 541
   "modules" or "excluded_modules").
542 542
 
543 543
 
544
-4. Quick-Start Installation Guide
544
+4. Quick-Start installation guide
545 545
 ---------------------------------
546 546
 
547
-A) Getting Help
547
+A) Getting help
548 548
 
549 549
   This guide gives you instructions on how to set up the SIP server
550 550
   (SER or Kamailio) on your box quickly. In case the default configuration
... ...
@@ -566,7 +566,7 @@ B) Disclaimers
566 566
   any name with the server. (This is on purpose to avoid installation 
567 567
   dependencies on a database, which is needed for storing user credentials.)
568 568
 
569
-C) Quick Start
569
+C) Quick start
570 570
 
571 571
   The following step-by step guide gives you instructions how to install the 
572 572
   SQL-free distribution of SIP server. If you need persistence and
... ...
@@ -655,7 +655,7 @@ C) Quick Start
655 655
 	Auth user:	the ID used for authentication
656 656
 	Secret/Password:	The configured authentication password
657 657
 
658
-D) SIP Server with Persistent Data Storage
658
+D) SIP Server with persistent data storage
659 659
 ------------------------------------------
660 660
 
661 661
   The default configuration is very simple and features many simplifications.