[sr-dev] git:master: Fix some typos and capitalisation in INSTALL

Module: sip-router Branch: master Commit: 2824e49d4c2d64918a3d8c00f37498caec445b83 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=2824e49… Author: Sven Neuhaus <neuhaus(a)users.noreply.github.com> Committer: Daniel-Constantin Mierla <miconda(a)gmail.com> Date: Fri Aug 29 13:14:18 2014 +0200 Fix some typos and capitalisation in INSTALL --- INSTALL | 76 +++++++++++++++++++++++++++++++------------------------------- 1 files changed, 38 insertions(+), 38 deletions(-) diff --git a/INSTALL b/INSTALL index dcf8766..5200f96 100644 --- a/INSTALL +++ b/INSTALL @@ -23,23 +23,23 @@ Table of Contents ================= -1. SIP Server Flavours -2. Supported Architectures and Requirements -3. Howto Build SIP Server From the Source Distribution - 3.1 Kamailio Fast Track Installation - 3.2 Details Installing from Source Code - A) Set SIP Server Flavour - B) Build Commands -4. Quick-Start Installation Guide - A) Getting Help +1. SIP server flavours +2. Supported architectures and requirements +3. Howto Build SIP server from the source distribution + 3.1 Kamailio fast track installation + 3.2 Details installing from source code + A) Set SIP server flavour + B) Build commands +4. Quick-Start installation guide + A) Getting help B) Disclaimers - C) Quick Start - D) SIP Server with Persistent Data Storage + C) Quick start + D) SIP server with persistent data storage 5. Troubleshooting -1. SIP Server Flavours +1. SIP server flavours ---------------------- The two major SIP server flavours are: @@ -69,7 +69,7 @@ Several installation tutorials for Kamailio are available on the web wiki: - http://www.kamailio.org/wiki/ -2. Supported Architectures and Requirements +2. Supported architectures and requirements ------------------------------------------- Supported operating systems: @@ -97,7 +97,7 @@ Requirements: - gcc or icc : gcc >= 2.9x; 3.[12] recommended (it will work with older version but it might require some options tweaking for best performance) -- bison or yacc (Berkley yacc) +- bison or yacc (Berkley Yacc) - flex - GNU make (on Linux this is the standard "make", on *BSD and Solaris it is called "gmake") version >= 3.80 (recommended 3.81). @@ -105,10 +105,10 @@ Requirements: - GNU tar ("gtar" on Solaris) and gzip if you want "make tar" to work - GNU install, BSD install or Solaris install if you want "make install", "make bin", "make sunpkg" to work -- libmysqlclient & libz (zlib) if you want Mysql support (the db_mysql module) +- libmysqlclient & libz (zlib) if you want MySQL support (the db_mysql module) - libxml2 if you want to compile the cpl-c (CPL support) or pa (presence) modules -- libradiusclient-ng (> 5.0) if you need radius support (the auth_radius, +- libradiusclient-ng (> 5.0) if you need RADIUS support (the auth_radius, group_radius, uri_radius and avp_radius modules) - libpq if you need PostgreSQL support (the db_postgres module) - libexpat if you want the jabber gateway support (the jabber module) or the @@ -120,19 +120,19 @@ Requirements: - unixodbc - libs and devel headers - if you want UNIXODBC support as DB underlayer - libxmlrpc-c3 - libs and devel headers - if you want to have XML-RPC support - for the Management interface (MI) -- libperl - libs and devel headers - if you want PERL connector to support - perl scripting from you config file (perl module) + for the management interface (MI) +- libperl - libs and devel headers - if you want the perl connector to support + perl scripting from your config file (perl module) - libsnmp9 - libs and devel headers - if you want SNMP client functionality (SNMP AgentX subagent) for Kamailio - libldap libs and devel headers v2.1 or greater - if you want LDAP support - libpcre libs and devel headers - if you want to compile the lcr and dialplan modules - libsctp devel headers - if you want to compile the SCTP transport in the core -- libssl devel headers (openssl project) - if you want to compule the TLS module -- linunistring - for the Websockets module -- python and devel headers for python module -- jdk and gcj for java module +- libssl devel headers (openssl project) - if you want to compile the TLS module +- libunistring - for the WebSocket module +- python and devel headers for the Python module +- jdk and gcj for Java module OS Notes: @@ -234,8 +234,8 @@ OS Notes: .................................... -If you are familiar with Unix/Linux build tools aready and you installed -required dependency, then you can just follow this section, otherwise +If you are familiar with Unix/Linux build tools aready and you installed +the required dependencies, then you can just follow this section, otherwise skip over it. To get the SIP server installed, in the folder with source code run: @@ -255,7 +255,7 @@ tls, run: ....................................... -A) Set SIP Server Flavour +A) Set SIP server Flavour If you don't have a clean source tree, first do: make proper @@ -269,7 +269,7 @@ To build SER flavour, you have to run first: The parameter 'FLAVOUR=ser' must be given all the time when make target is 'cfg'. -B) Build Commands +B) Build commands The SIP server is split in four main parts: The core, the modules, the 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: There are also in addition some "convenience" groups: - mysql - Include all the db modules dependent and the mysql db driver - postgres - Include all the db modules and the postgres db driver + mysql - Include all the db modules dependent and the MySQL db driver + postgres - Include all the db modules and the PostgreSQL db driver radius - Include all modules on radiusclient presence - Include all the presence modules - Ex. to make a standard installation with Mysql, use: + Ex. to make a standard installation with MySQL, use: make group_include="standard mysql" all In addition to group_include (or instead), you can use @@ -419,7 +419,7 @@ Configure: All future make invocations will include the mysql module and will build in debug mode - Note: if config.mak doesn't exist (e.g. initial checkout or after a make + Note: If config.mak doesn't exist (e.g. initial checkout or after a make proper) or if Makefile.defs was changed, the config will be re-generated automatically by the first make command. For example: make cfg include_modules=db_mysql; make all @@ -514,9 +514,9 @@ Install: Note: If you use prefix parameter in make install then you also need to use this parameter in previous make commands, i.e. make, make modules, - or make all. If you fail to do this then SIP Router will look for the default + or make all. If you fail to do this then SIP server will look for the default configuration file in a wrong directory, because the directory of the - default configuration file is hard coded into SIP server during compile time. + default configuration file is hardcoded into SIP server during compile time. When you use a different prefix parameter when installing then the directory hard coded in SIP server and the directory in which the file will be installed by make install will not match. (You can specify exact location @@ -532,7 +532,7 @@ Install: /usr/local/etc/kamailio/kamailio.cfg (because there was no prefix parameter make all and /usr/local is the default value of prefix). - Workaround is trivial, use the same parameters in all make commands: + The workaround is trivial, use the same parameters in all make commands: make prefix=/ all make prefix=/ install or save the desired prefix in the make config (e.g.: make cfg prefix=/). @@ -541,10 +541,10 @@ Install: "modules" or "excluded_modules"). -4. Quick-Start Installation Guide +4. Quick-Start installation guide --------------------------------- -A) Getting Help +A) Getting help This guide gives you instructions on how to set up the SIP server (SER or Kamailio) on your box quickly. In case the default configuration @@ -566,7 +566,7 @@ B) Disclaimers any name with the server. (This is on purpose to avoid installation dependencies on a database, which is needed for storing user credentials.) -C) Quick Start +C) Quick start The following step-by step guide gives you instructions how to install the SQL-free distribution of SIP server. If you need persistence and @@ -655,7 +655,7 @@ C) Quick Start Auth user: the ID used for authentication Secret/Password: The configured authentication password -D) SIP Server with Persistent Data Storage +D) SIP Server with persistent data storage ------------------------------------------ The default configuration is very simple and features many simplifications.