File: lunarmain.xml

package info (click to toggle)
liblunar 2.0.1-2.2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 2,076 kB
  • ctags: 480
  • sloc: sh: 10,194; ansic: 4,603; xml: 584; makefile: 173; python: 16
file content (65 lines) | stat: -rw-r--r-- 2,326 bytes parent folder | download | duplicates (3)
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
<refentry id="lunar-lunarmain">
<refmeta>
<refentrytitle role="top_of_page" id="lunar-lunarmain.top_of_page">Intialization</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LUNAR Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Intialization</refname>
<refpurpose>Initialization functions</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="lunar-lunarmain.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;lunar/lunar.h&gt;

<link linkend="void">void</link>                <link linkend="lunar-init">lunar_init</link>                          (<link linkend="int">int</link> *argc,
                                                         <link linkend="char">char</link> ***argv);
</synopsis>
</refsynopsisdiv>









<refsect1 id="lunar-lunarmain.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="lunar-lunarmain.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="lunar-init" role="function">
<title>lunar_init ()</title>
<indexterm zone="lunar-init"><primary>lunar_init</primary></indexterm><programlisting><link linkend="void">void</link>                lunar_init                          (<link linkend="int">int</link> *argc,
                                                         <link linkend="char">char</link> ***argv);</programlisting>
<para>
Call this function before using any other liblunar functions in your applications. It will initialize liblunar.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
<listitem><simpara> Address of the <parameter>argc</parameter> parameter of your <link linkend="main"><function>main()</function></link> function. Changed if any arguments were handled.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
<listitem><simpara> Address of the <parameter>argv</parameter> parameter of <link linkend="main"><function>main()</function></link>. Any parameters understood by <link linkend="lunar-init"><function>lunar_init()</function></link> are stripped before return.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>