|
|
@@ -1,110 +1,110 @@
|
|
|
-<!-- Module User's Guide -->
|
|
|
-
|
|
|
-<chapter>
|
|
|
- <chapterinfo>
|
|
|
- <revhistory>
|
|
|
- <revision>
|
|
|
- <revnumber>$Revision$</revnumber>
|
|
|
- <date>$Date$</date>
|
|
|
- </revision>
|
|
|
- </revhistory>
|
|
|
- </chapterinfo>
|
|
|
- <title>User's Guide</title>
|
|
|
-
|
|
|
- <section>
|
|
|
- <title>Overview</title>
|
|
|
- <para>Module description</para>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>Dependencies</title>
|
|
|
- <section>
|
|
|
- <title>&ser; modules</title>
|
|
|
- <para>
|
|
|
- The next modules must be loaded before this module:
|
|
|
- <itemizedlist>
|
|
|
- <listitem>
|
|
|
- <para>
|
|
|
- <emphasis>none</emphasis>.
|
|
|
- </para>
|
|
|
- </listitem>
|
|
|
- </itemizedlist>
|
|
|
- </para>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>External libraries or applications</title>
|
|
|
- <para>
|
|
|
- The next libraries or applications must be installed before running
|
|
|
- &ser; with this module:
|
|
|
- <itemizedlist>
|
|
|
- <listitem>
|
|
|
- <para>
|
|
|
- <emphasis>none</emphasis>.
|
|
|
- </para>
|
|
|
- </listitem>
|
|
|
- </itemizedlist>
|
|
|
- </para>
|
|
|
- </section>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>Exported Parameters</title>
|
|
|
- <section>
|
|
|
- <title><varname>param_name</varname> (param_type)</title>
|
|
|
- <para>
|
|
|
- Param description.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- <emphasis>
|
|
|
- Default value is <quote>value</quote>.
|
|
|
- </emphasis>
|
|
|
- </para>
|
|
|
- <example>
|
|
|
- <title>Set the <quote>param_name</quote> parameter</title>
|
|
|
-<programlisting format="linespecific">
|
|
|
-...
|
|
|
-modparam("module", "param_name", "param_value")
|
|
|
-...
|
|
|
-</programlisting>
|
|
|
- </example>
|
|
|
- </section>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>Exported Functions</title>
|
|
|
- <section>
|
|
|
- <title>
|
|
|
- <function moreinfo="none">function_name(param1, param2)</function>
|
|
|
- </title>
|
|
|
- <para>
|
|
|
- Description
|
|
|
- </para>
|
|
|
- <para>Meaning of the parameters is as follows:</para>
|
|
|
- <itemizedlist>
|
|
|
- <listitem>
|
|
|
- <para><emphasis>param1</emphasis> - description.
|
|
|
- </para>
|
|
|
- </listitem>
|
|
|
- <listitem>
|
|
|
- <para><emphasis>param2</emphasis> - description.
|
|
|
- </para>
|
|
|
- </listitem>
|
|
|
- </itemizedlist>
|
|
|
- <example>
|
|
|
- <title>function_name usage</title>
|
|
|
-<programlisting format="linespecific">
|
|
|
-...
|
|
|
-function_name("sample_param1", "sample_param2");
|
|
|
-...
|
|
|
-</programlisting>
|
|
|
- </example>
|
|
|
- </section>
|
|
|
- </section>
|
|
|
- <section>
|
|
|
- <title>Installation & Running</title>
|
|
|
- <para>Notes about installation and running.</para>
|
|
|
- </section>
|
|
|
-</chapter>
|
|
|
-
|
|
|
-<!-- Keep this element at the end of the file
|
|
|
-Local Variables:
|
|
|
-sgml-parent-document: ("&parentsgml;" "Book" "chapter")
|
|
|
-End:
|
|
|
--->
|
|
|
+<!-- Module User's Guide -->
|
|
|
+
|
|
|
+<chapter>
|
|
|
+ <chapterinfo>
|
|
|
+ <revhistory>
|
|
|
+ <revision>
|
|
|
+ <revnumber>$Revision$</revnumber>
|
|
|
+ <date>$Date$</date>
|
|
|
+ </revision>
|
|
|
+ </revhistory>
|
|
|
+ </chapterinfo>
|
|
|
+ <title>User's Guide</title>
|
|
|
+
|
|
|
+ <section>
|
|
|
+ <title>Overview</title>
|
|
|
+ <para>Module description</para>
|
|
|
+ </section>
|
|
|
+ <section>
|
|
|
+ <title>Dependencies</title>
|
|
|
+ <section>
|
|
|
+ <title>&ser; Modules</title>
|
|
|
+ <para>
|
|
|
+ The following modules must be loaded before this module:
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ <emphasis>No dependencies on other &ser; modules</emphasis>.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </para>
|
|
|
+ </section>
|
|
|
+ <section>
|
|
|
+ <title>External Libraries or Applications</title>
|
|
|
+ <para>
|
|
|
+ The next libraries or applications must be installed before running
|
|
|
+ &ser; with this module loaded:
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ <emphasis>None</emphasis>.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </para>
|
|
|
+ </section>
|
|
|
+ </section>
|
|
|
+ <section>
|
|
|
+ <title>Exported Parameters</title>
|
|
|
+ <section>
|
|
|
+ <title><varname>param_name</varname> (param_type)</title>
|
|
|
+ <para>
|
|
|
+ Param description.
|
|
|
+ </para>
|
|
|
+ <para>
|
|
|
+ <emphasis>
|
|
|
+ Default value is <quote>value</quote>.
|
|
|
+ </emphasis>
|
|
|
+ </para>
|
|
|
+ <example>
|
|
|
+ <title>Set <varname>param_name</varname> parameter</title>
|
|
|
+ <programlisting format="linespecific">
|
|
|
+...
|
|
|
+modparam("module", "param_name", "param_value")
|
|
|
+...
|
|
|
+</programlisting>
|
|
|
+ </example>
|
|
|
+ </section>
|
|
|
+ </section>
|
|
|
+ <section>
|
|
|
+ <title>Exported Functions</title>
|
|
|
+ <section>
|
|
|
+ <title>
|
|
|
+ <function moreinfo="none">function_name(param1, param2)</function>
|
|
|
+ </title>
|
|
|
+ <para>
|
|
|
+ Description
|
|
|
+ </para>
|
|
|
+ <para>Meaning of the parameters is as follows:</para>
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem>
|
|
|
+ <para><emphasis>param1</emphasis> - description.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ <listitem>
|
|
|
+ <para><emphasis>param2</emphasis> - description.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ <example>
|
|
|
+ <title><function>function_name</function> usage</title>
|
|
|
+ <programlisting format="linespecific">
|
|
|
+...
|
|
|
+function_name("sample_param1", "sample_param2");
|
|
|
+...
|
|
|
+</programlisting>
|
|
|
+ </example>
|
|
|
+ </section>
|
|
|
+ </section>
|
|
|
+ <section>
|
|
|
+ <title>Installation & Running</title>
|
|
|
+ <para>Notes about installation and running.</para>
|
|
|
+ </section>
|
|
|
+</chapter>
|
|
|
+
|
|
|
+<!-- Keep this element at the end of the file
|
|
|
+Local Variables:
|
|
|
+sgml-parent-document: ("module.sgml" "Book" "chapter")
|
|
|
+End:
|
|
|
+-->
|
Jan Janak