Module: kamailio
Branch: master
Commit: 294427ca8343391616b1db6be670a7acb66b069c
URL: 
https://github.com/kamailio/kamailio/commit/294427ca8343391616b1db6be670a7acb66b069c

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date: 2015-04-28T15:21:58+02:00

mi_fifo: updated documentation for fifo_name parameter

---

Modified: modules/mi_fifo/README
Modified: modules/mi_fifo/doc/mi_fifo_admin.xml

---

Diff:  
https://github.com/kamailio/kamailio/commit/294427ca8343391616b1db6be670a7acb66b069c.diff
Patch: 
https://github.com/kamailio/kamailio/commit/294427ca8343391616b1db6be670a7acb66b069c.patch

---

diff --git a/modules/mi_fifo/README b/modules/mi_fifo/README
index ed42377..a9a8303 100644
--- a/modules/mi_fifo/README
+++ b/modules/mi_fifo/README
@@ -111,9 +111,15 @@ Chapter 1. Admin Guide
 4.1. fifo_name (string)
 
    The name of the FIFO file to be created for listening and reading
-   external commands.
+   external commands. If the value is a file name or does not start with
+   '/', the FIFO file is created in the 'run_dir'. The 'run_dir' is a core
+   parameter that can specify where to create runtime files, its default
+   value is '/var/run/kamailio/'.
 
-   Default value is NONE.
+   Default value is 'Kamailio_fifo'.
+
+   The full path used by default for FIFO file is
+   '/var/run/kamailio/Kamailio_fifo'
 
    Example 1.1. Set fifo_name parameter
 ...
diff --git a/modules/mi_fifo/doc/mi_fifo_admin.xml 
b/modules/mi_fifo/doc/mi_fifo_admin.xml
index 714772d..4b25035 100644
--- a/modules/mi_fifo/doc/mi_fifo_admin.xml
+++ b/modules/mi_fifo/doc/mi_fifo_admin.xml
@@ -86,13 +86,20 @@
                <title><varname>fifo_name</varname> (string)</title>
                <para>
                The name of the FIFO file to be created for listening and 
-               reading external commands.
+               reading external commands. If the value is a file name or does
+               not start with '/', the FIFO file is created in the 'run_dir'. 
The
+               'run_dir' is a core parameter that can specify where to create
+               runtime files, its default value is '/var/run/kamailio/'.
                </para>
                <para>
                <emphasis>
-                       Default value is NONE.
+                       Default value is '&kamailio;_fifo'.
                </emphasis>
                </para>
+               <para>
+                       The full path used by default for FIFO file is
+                       '/var/run/kamailio/&kamailio;_fifo'
+               </para>
                <example>
                <title>Set <varname>fifo_name</varname> parameter</title>
                <programlisting format="linespecific">


_______________________________________________
sr-dev mailing list
[email protected]
http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to