1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<!-- Module User's Guide -->
<chapter>
<chapterinfo>
<revhistory>
<revision>
<revnumber>$Revision: 1.1.1.1 $</revnumber>
<date>$Date: 2005/06/13 16:47:30 $</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 following 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:
-->
|
