Many doc directory improvements, including:
[asterisk/asterisk.git] / doc / tex / cdrdriver.tex
index 9a90426..35c39df 100644 (file)
@@ -249,26 +249,29 @@ SQLite version 2 is supported in cdr\_sqlite.
 \subsection{Steps to follow in order to have RADIUS support}
 
 \subsubsection{Installation of the Radiusclient library}
-   Installation:
-\begin{verbatim}       
-       Download the sources from:
-               
-       http://developer.berlios.de/projects/radiusclient-ng/
+
+       Download the sources from       
+       \url{http://developer.berlios.de/projects/radiusclient-ng/}
                
-       Untar the source tarball.
-               root@localhost:/usr/local/src# tar xvfz radiusclient-ng-0.5.2.tar.gz
-
-       Compile and install the library.
-               root@localhost:/usr/local/src# cd radiusclient-ng-0.5.2
-               root@localhost:/usr/local/src/radiusclient-ng-0.5.2# ./configure
-               root@localhost:/usr/local/src/radiusclient-ng-0.5.2# make
-               root@localhost:/usr/local/src/radiusclient-ng-0.5.2# make install
+       Untar the source tarball:
+
+\begin{verbatim}
+       root@localhost:/usr/local/src# tar xvfz radiusclient-ng-0.5.2.tar.gz
+\end{verbatim}
+
+       Compile and install the library:
+
+\begin{verbatim}
+       root@localhost:/usr/local/src# cd radiusclient-ng-0.5.2
+       root@localhost:/usr/local/src/radiusclient-ng-0.5.2# ./configure
+       root@localhost:/usr/local/src/radiusclient-ng-0.5.2# make
+       root@localhost:/usr/local/src/radiusclient-ng-0.5.2# make install
 \end{verbatim}
 
 \subsubsection{Configuration of the Radiusclient library}
        
        By default all the configuration files of the radiusclient library will
-       be in /usr/local/etc/radiusclient-ng directory.
+       be in \path{/usr/local/etc/radiusclient-ng} directory.
                
        File "radiusclient.conf"
                Open the file and find lines containing the following:
@@ -280,11 +283,12 @@ SQLite version 2 is supported in cdr\_sqlite.
        running on the same host as your Asterisk PBX.
 
                        acctserver      localhost
+
        This is the hostname or IP address of the RADIUS server used for 
        accounting. You will have to change this unless the server is running
        on the same host as your Asterisk PBX.
 
-       File "servers" 
+       \textbf{File "servers"} 
                
        RADIUS protocol uses simple access control mechanism based on shared
        secrets that allows RADIUS servers to limit access from RADIUS clients.
@@ -294,25 +298,23 @@ SQLite version 2 is supported in cdr\_sqlite.
 
        You need to configure a shared secret for each server you have 
        configured in radiusclient.conf file in the previous step. The shared 
-       secrets are stored in /usr/local/etc/radiusclient-ng/servers file.
+       secrets are stored in \path{/usr/local/etc/radiusclient-ng/servers} file.
 
        Each line contains hostname of a RADIUS server and shared secret 
        used in communication with that server. The two values are separated 
        by white spaces. Configure shared secrets for every RADIUS server you 
        are going to use.
 
-       File "dictionary"
+       \textbf{File "dictionary"}
                        
        Asterisk uses some attributes that are not included in the 
        dictionary of radiusclient library, therefore it is necessary to add 
        them. A file called dictionary.digium (kept in the contrib dir)
        was created to list all new attributes used by Asterisk. 
        Add to the end of the main dictionary file
-       /usr/local/etc/radiusclient-ng/dictionary
-       the line:
-\begin{verbatim}
+       \path{/usr/local/etc/radiusclient-ng/dictionary} the line:
+
                \$INCLUDE /path/to/dictionary.digium
-\end{verbatim}
 
 \subsubsection{Install FreeRADIUS Server (Version 1.1.1)}
  
@@ -341,7 +343,7 @@ SQLite version 2 is supported in cdr\_sqlite.
 
        File "clients.conf"
                        
-       File /usr/local/etc/raddb/clients.conf contains description of 
+       File \path{/usr/local/etc/raddb/clients.conf} contains description of 
        RADIUS clients that are allowed to use the server. For each of the 
        clients you need to specify its hostname or IP address and also a 
        shared secret. The shared secret must be the same string you configured
@@ -363,15 +365,15 @@ SQLite version 2 is supported in cdr\_sqlite.
                
        File "dictionary"
                
-       Note : as of version 1.1.2, the dictionary.digium file ships with FreeRADIUS. 
+       Note: as of version 1.1.2, the dictionary.digium file ships with FreeRADIUS. 
        The following procedure brings the dictionary.digium file to previous versions 
        of FreeRADIUS.
        
-       File /usr/local/etc/raddb/dictionary contains the dictionary of 
+       File \path{/usr/local/etc/raddb/dictionary} contains the dictionary of 
        FreeRADIUS server. You have to add the same dictionary file 
        (dictionary.digium), which you added to the dictionary of radiusclient-ng
        library. You can include it into the main file, adding the following line at the
-       end of file '/usr/local/etc/raddb/dictionary':
+       end of file \path{/usr/local/etc/raddb/dictionary}:
                
        \$INCLUDE /path/to/dictionary.digium
 
@@ -388,17 +390,16 @@ SQLite version 2 is supported in cdr\_sqlite.
         library has been detected on your system.
        
        By default FreeRADIUS server will log all accounting requests into 
-       /usr/local/var/log/radius/radacct directory in form of plain text files. 
+       \path{/usr/local/var/log/radius/radacct} directory in form of plain text files. 
        The server will create one file for each hostname in the directory. The 
        following example shows how the log files look like. 
 
-       Asterisk now generates Call Detail Records. See /include/asterisk/cdr.h
+       Asterisk now generates Call Detail Records. See \path{/include/asterisk/cdr.h}
        for all the fields which are recorded. By default, records in comma 
-       separated values will be created in /var/log/asterisk/cdr-csv. 
-
-       The configuration file for cdr\_radius.so module is :
+       separated values will be created in \path{/var/log/asterisk/cdr-csv}. 
 
-        /etc/asterisk/cdr.conf 
+       The configuration file for cdr\_radius.so module is \path{/etc/asterisk/cdr.conf}
+        
        This is where you can set CDR related parameters as well as the path to
        the radiusclient-ng library configuration file.
 
@@ -423,7 +424,7 @@ SQLite version 2 is supported in cdr\_sqlite.
   "Asterisk-Bill-Sec",                 The duration that a call was up after other 
                                 end answered which will be <= to duration  
                                 "end time" minus "answer time" 
-  "Asterisk-Disposition",      ANSWERED, NO ANSWER, BUSY 
+  "Asterisk-Disposition",        ANSWERED, NO ANSWER, BUSY 
   "Asterisk-AMA-Flags",        DOCUMENTATION, BILL, IGNORE etc, specified on 
                                 a per channel basis like accountcode. 
   "Asterisk-Unique-ID",         Unique call identifier