Module: sip-router
Branch: master
Commit: 63653d7d18a7124ff3a33991f3db4cd8271a9e24
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=63653d7…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Fri Feb 8 20:56:06 2013 +0100
mi_fifo Typo fixes mostly
---
modules/mi_fifo/README | 18 +++++++++---------
modules/mi_fifo/doc/mi_fifo_admin.xml | 18 +++++++++---------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/modules/mi_fifo/README b/modules/mi_fifo/README
index 82875dc..ed42377 100644
--- a/modules/mi_fifo/README
+++ b/modules/mi_fifo/README
@@ -70,11 +70,11 @@ Chapter 1. Admin Guide
1. Overview
This is a module which provides a FIFO transport layer implementation
- for Management Interface.
+ for the Management Interface.
2. FIFO command syntax
- The external commands issued via FIFO interface must follow the
+ The external commands issued via the FIFO interface must follow the
following syntax:
* request = first_line argument*
* first_line = ':'command_name':'reply_fifo'\n'
@@ -117,7 +117,7 @@ Chapter 1. Admin Guide
Example 1.1. Set fifo_name parameter
...
-modparam("mi_fifo", "fifo_name", "/tmp/openser_fifo")
+modparam("mi_fifo", "fifo_name", "/tmp/kamailio_fifo")
...
4.2. fifo_mode (integer)
@@ -134,9 +134,9 @@ modparam("mi_fifo", "fifo_mode", 0600)
4.3. fifo_group (integer) fifo_group (string)
- Group to be used for creating the listening FIFO file.
+ System Group to be used for creating the listening FIFO file.
- Default value is the inherited one.
+ Default value is the inherited one (process group).
Example 1.3. Set fifo_group parameter
...
@@ -146,9 +146,9 @@ modparam("mi_fifo", "fifo_group",
"root")
4.4. fifo_user (integer) fifo_group (string)
- User to be used for creating the listening FIFO file.
+ System User to be used for creating the listening FIFO file.
- Default value is the inherited one.
+ Default value is the inherited one (process user).
Example 1.4. Set fifo_user parameter
...
@@ -170,7 +170,7 @@ modparam("mi_fifo", "reply_dir",
"/home/kamailio/tmp/")
4.6. reply_indent (string)
Strings to be used for line indentation. As the MI data structure is
- tree oriendeted, the depth level will printed as indentation.
+ tree oriented, the depth level will be printed as indentation.
Default value is ""\t" (TAB)".
@@ -186,7 +186,7 @@ modparam("mi_fifo", "reply_indent", "
")
6. Example
This is an example showing the FIFO format for the "get_statistics
- dialog: tm:" MI commad: response.
+ dialog: tm:" MI command response.
Example 1.7. FIFO request
:get_statistics:reply_fifo\n
diff --git a/modules/mi_fifo/doc/mi_fifo_admin.xml
b/modules/mi_fifo/doc/mi_fifo_admin.xml
index 0227144..714772d 100644
--- a/modules/mi_fifo/doc/mi_fifo_admin.xml
+++ b/modules/mi_fifo/doc/mi_fifo_admin.xml
@@ -17,14 +17,14 @@
<title>Overview</title>
<para>
This is a module which provides a FIFO transport layer
- implementation for Management Interface.
+ implementation for the Management Interface.
</para>
</section>
<section>
<title>FIFO command syntax</title>
<para>
- The external commands issued via FIFO interface must follow the
+ The external commands issued via the FIFO interface must follow the
following syntax:
<itemizedlist>
<listitem><para><emphasis>
@@ -97,7 +97,7 @@
<title>Set <varname>fifo_name</varname> parameter</title>
<programlisting format="linespecific">
...
-modparam("mi_fifo", "fifo_name", "/tmp/openser_fifo")
+modparam("mi_fifo", "fifo_name", "/tmp/kamailio_fifo")
...
</programlisting>
</example>
@@ -128,11 +128,11 @@ modparam("mi_fifo", "fifo_mode", 0600)
<title><varname>fifo_group</varname> (integer)
<varname>fifo_group</varname> (string)</title>
<para>
- Group to be used for creating the listening FIFO file.
+ System Group to be used for creating the listening FIFO file.
</para>
<para>
<emphasis>
- Default value is the inherited one.
+ Default value is the inherited one (process group).
</emphasis>
</para>
<example>
@@ -150,11 +150,11 @@ modparam("mi_fifo", "fifo_group",
"root")
<title><varname>fifo_user</varname> (integer)
<varname>fifo_group</varname> (string)</title>
<para>
- User to be used for creating the listening FIFO file.
+ System User to be used for creating the listening FIFO file.
</para>
<para>
<emphasis>
- Default value is the inherited one.
+ Default value is the inherited one (process user).
</emphasis>
</para>
<example>
@@ -192,7 +192,7 @@ modparam("mi_fifo", "reply_dir",
"/home/kamailio/tmp/")
<title><varname>reply_indent</varname> (string)</title>
<para>
Strings to be used for line indentation. As the MI data structure
- is tree oriendeted, the depth level will printed as indentation.
+ is tree oriented, the depth level will be printed as indentation.
</para>
<para>
<emphasis>
@@ -222,7 +222,7 @@ modparam("mi_fifo", "reply_indent", "
")
<title>Example</title>
<para>
This is an example showing the FIFO format for the
- <quote>get_statistics dialog: tm:</quote> MI commad:
+ <quote>get_statistics dialog: tm:</quote> MI command
response.
</para>
<example>