Add comment information (bug #3537)
authorMark Spencer <markster@digium.com>
Thu, 10 Feb 2005 07:21:26 +0000 (07:21 +0000)
committerMark Spencer <markster@digium.com>
Thu, 10 Feb 2005 07:21:26 +0000 (07:21 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@4999 65c4cc65-6c06-0410-ace0-fbb531ad65f3

doc/README.configuration

index e7dd2c1..81f607b 100755 (executable)
@@ -44,6 +44,42 @@ templates. Any object can be used as a template.
 
 No whitespace is allowed between the closing "]" and the parenthesis "(".
 
+Comments
+--------
+All lines that starts with semi-colon ";" is treated as comments
+and is not parsed.
+
+The ";--" is a marker for a multi-line comment. Everything after
+that marker will be treated as a comment until the end-marker "--;"
+is found. Parsing begins directly after the end-marker.
+
+       ;This is a comment
+       label = value
+       ;-- This is 
+       a comment --;
+       
+       ;-- Comment --; exten=> 1000,1,dial(SIP/lisa)   
+
+Including other files
+---------------------
+In all of the configuration files, you may include the content of another
+file with the #include statement. The content of the other file will be
+included at the row that the #include statement occured.
+       
+       #include myusers.conf
+
+You may also include the output of a program with the #exec directive,
+if you enable it in asterisk.conf
+       
+In asterisk.conf, add the execincludes = yes statement in the options
+section:
+       [options]
+       execincludes=yes
+
+The exec directive is used like this:
+       
+       #exec /usr/local/bin/myasteriskconfigurator.sh
+
 Including other files
 ---------------------
 In all of the configuration files, you may include the content of another