|
1
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
2
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
3
|
<head>
|
|
4
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
5
|
<title>gBase: Main Page</title>
|
|
6
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
7
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
8
|
</head>
|
|
9
|
<body>
|
|
10
|
<!-- Generated by Doxygen 1.6.3 -->
|
|
11
|
<div class="navigation" id="top">
|
|
12
|
<div class="tabs">
|
|
13
|
<ul>
|
|
14
|
<li class="current"><a href="main.html"><span>Main Page</span></a></li>
|
|
15
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
16
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
17
|
</ul>
|
|
18
|
</div>
|
|
19
|
</div>
|
|
20
|
<div class="contents">
|
|
21
|
<h1>gBase Documentation</h1><h3 class="version">0.2 b</h3></div>
|
|
22
|
|
|
23
|
<h2>Introduction</h2>
|
|
24
|
|
|
25
|
<p>GBase provides an API with miscellaneous functions. It is based on GLib 2.24.<br />
|
|
26
|
At this time, we find :</p>
|
|
27
|
<ul>
|
|
28
|
<li>some system functions,</li>
|
|
29
|
<li>some file utilities,</li>
|
|
30
|
<li>some computing checksums functions (MD5, SHA-1 and SHA-256),</li>
|
|
31
|
<li>few string utilities.</li>
|
|
32
|
</ul>
|
|
33
|
<p>GBase is under the GNU LGPL v2 license (see COPYING file).</p>
|
|
34
|
|
|
35
|
<h2>Installation</h2>
|
|
36
|
|
|
37
|
<ol>
|
|
38
|
<li>Download the latest version from the Scolring :
|
|
39
|
<ul>
|
|
40
|
<li>To GNU/Linux : <a href="http://trac.scolring.org/projects/gbase/repository/changes/bin/gbase.so">http://trac.scolring.org/projects/gbase/repository/changes/bin/gbase.so</a>;</li><br />
|
|
41
|
<li>To MS Windows : <a href="http://trac.scolring.org/projects/gbase/repository/changes/bin/gbase.dll">http://trac.scolring.org/projects/gbase/repository/changes/bin/gbase.dll</a>.</li><br />
|
|
42
|
</ul></li>
|
|
43
|
<li>Copy it to your Scol <em>plugins</em> directory.</li><br />
|
|
44
|
<li>Edit the <em>usm.ini</em> file (at the Scol root directory) and add this line :
|
|
45
|
<ul>
|
|
46
|
<li>On GNU / Linux :
|
|
47
|
<div class="fragment"><pre class="fragment">plugin ./plugins/gbase.so SCOLloadGBASE SCOLfreeGBASE</pre></div></li><br />
|
|
48
|
<li>On MS Window :
|
|
49
|
<div class="fragment"><pre class="fragment">plugin plugins/gbase.dll SCOLloadGBASE SCOLfreeGBASE</pre></div></li>
|
|
50
|
</ul></li><br />
|
|
51
|
<li>Save it and (re)launch Scol.</li>
|
|
52
|
</ol>
|
|
53
|
|
|
54
|
<p>Note : you must have the GLib 2.24 or + installed on your system. If this doesn't
|
|
55
|
the case, you can find more informations <a href="http://trac.scolring.org/projects/lib2dgtk/wiki/Installation">here</a> (section : GTK+). Only Glib is needed, not all GTK+ !</p>
|
|
56
|
|
|
57
|
<p>To uninstall, comment the added line and remove (or not !) the library.</p>
|
|
58
|
|
|
59
|
<h2>API</h2>
|
|
60
|
|
|
61
|
<p>The complete Scol Api (at this time) is available :<br />
|
|
62
|
<a href="globals.html">globals.html</a>.</p>
|
|
63
|
|
|
64
|
<h2>Bugs, features, ...</h2>
|
|
65
|
|
|
66
|
<p>Please, use our issues interface :<br />
|
|
67
|
<a href="http://trac.scolring.org/projects/lib2dgtk/issues/new">http://trac.scolring.org/projects/lib2dgtk/issues/new</a>.</p>
|
|
68
|
|
|
69
|
<h2>Feedback, help to developer, ...</h2>
|
|
70
|
|
|
71
|
<p>Please, post on our forum :<br />
|
|
72
|
<a href="http://www.scolring.org/forum/">http://www.scolring.org/forum</a>.</p>
|
|
73
|
|
|
74
|
|
|
75
|
|
|
76
|
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 11 15:06:43 2011 for gBase by
|
|
77
|
<a href="http://www.doxygen.org/index.html">
|
|
78
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
79
|
</body>
|
|
80
|
</html>
|