Differences

This shows you the differences between two versions of the page.

--- cookbooks:4.0.x:core:cfg [2013/06/26 06:42] – [C-Style Control Directives] poing
+++ cookbooks:4.0.x:core:cfg [2013/06/26 07:39] (current) – [Configuration Directives] poing
@@ Line 1: / Line 1: @@
-<fc #FF0000>**This is a work in progress**</fc>
 ====== The Configuration File ======
@@ Line 18: / Line 16: @@
 There are five (5) types of configuration directives used with Kamailio.\\
-<fc #AA0000>**Each type of configuration directive uses its own syntax!**</fc>
+^  <fc #800000>**Each type of configuration directive uses its own syntax!**</fc>  |
   - C-Style Control Directives
@@ Line 30: / Line 28: @@
 ==== Comments ====
-<fc #FF0000>**The first thing you should understand is the comment syntax used in the configuration file.\\ \\ **</fc>
+^  <fc #800000>**The first thing you should understand is the comment syntax used in the configuration file.**</fc>  |
 Comments in the configuration file are a mixture of C-Style (**not C++**) and scripting language syntaxes.\\
 It closely resembles the PHP style, **//except//** you **can not use** double-slash ( ⁄ ⁄ ) for line comments.  Only the hash (#) may be used for line comments.\\ \\
-It can be confusing seeing the C-Style Control Directives ([[cfg#c-style_control_directives|explained later]]) that begin with a hash-bang (#!) mixed with line comments begin with a hash (#).
+It can be confusing seeing the C-Style Control Directives ([[cfg#c-style_control_directives|explained later]]) that begin with a hash-bang (#!) mixed with line comments beginning with a hash (#).
-<code>
+^ Examples:  |
+|Block Comment:<code c>
 /* This is a ...
-   block comment */
+   block comment */</code>  |
-// this is NOT a line comment
+|<fc #800000>**Not a Comment:**</fc><code> // this is NOT a line comment </code>|
-# this is a line comment
+|Line Comment:<code c># this is a line comment </code>|
-#!c_style_directive <-- VALID CONFIGURATION DIRECTIVE / NOT A COMMENT
+|**<fc #800000>Valid Configuration Directive:</fc>**<code>#!c_style_directive</code>|
-</code>
 -----
@@ Line 53: / Line 52: @@
 The general use is to allow for comments or additional configuration directives be placed on the same line.
-<code>
+^ Examples:  |
+|<code>
 configuration_directive_a
 configuration_directive_b;
 configuration_directive_c; configuration_directive_d
 configuration_directive_e; # comment about the configuration directive
-</code>
+</code>|
 -----
@@ Line 66: / Line 66: @@
 ^ Type ^ Format ^ Comment ^
-| C-Style Control Directives | #!directive NAME VALUE | Begins with hash-bang (#!) |
+| C-Style Control Directives | #!directive [ NAME [ VALUE ] ] | Begins with hash-bang (#!) |
 | Apache-Like Name/Value Pairs | name "value" | Delimited by a space & Value within quotes |
 | Normal Name/Value Pairs | name=value | Delimited by an equals sign |
@@ Line 96: / Line 96: @@
 #!endif
 </code>|
 -----
 ==== Apache Name/Value Pairs ====
@@ Line 104: / Line 105: @@
 <fc #FF0000>//The value MUST be enclosed in quotes.//</fc>
-  loadmodule "module_name.so"
+^ Examples  |
-  loadmodule "another_module.so"
+|<code>
-  include_file "file_to_include.cfg"
+loadmodule "module_name.so"
-  import_file "/path/to/file_to_import.cfg"
+loadmodule "another_module.so"
+include_file "file_to_include.cfg"
+import_file "/path/to/file_to_import.cfg"
+</code>|
------
+-------
 ==== Normal Name/Value Pairs ====
+These name/value pairs are normally delimited by an equal sign.
 ^ Syntax: |
 |<code c>name=value</code>|
- (delimited by an equals sign)
-[[../core#core_parameters|core_parameters]]
+<fc #FF0000>There are a couple situations where the value needs to be enclosed in quotes.</fc>\\
+Check the [[../core#core_parameters|core parameters]] for the required syntax.
-<code>
+^ Examples:  |
+|<code>
 memdbg=5
 memlog=5
@@ Line 127: / Line 134: @@
 auto_aliases=no
 alias="sip.mydomain.com"
-</code>
+</code>|
------
+------
 ==== Modify Parameter Procedure ====
@@ Line 138: / Line 146: @@
 <fc #800000>Strings should be enclosed in quotes.</fc>
+See the [[http://www.kamailio.org/docs/modules/4.0.x/|module documentation]] for support parameter settings.
 ^ Examples:  |
@@ Line 149: / Line 159: @@
 -----
 ==== Route Functions ====
+I will not go into too much detail here, the scripting methods, functions, and procdedures should be covered elsewhere in this wiki.\\
+^ Example:  |
+|<code c>request_route {
+        route(REQINIT); # Request Initial
+        route(NATDETECT); # NAT Detection
+        # CANCEL ??
+        if (is_method("CANCEL")) {
+         exit;
+        }
+        # OTHER SCRIPT CODE HERE
+}</code>|