Files
glest-source/source/shared_lib/sources/libircclient/doc/html/index.html

51 lines
4.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libircclient: libircclient - a IRC library to create IRC clients</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libircclient - a IRC library to create IRC clients</h1>
<p>
<h3 align="center">1.3 </h3><h2><a class="anchor" name="intro_sec">
Introduction</a></h2>
libircclient is a small but powerful library, which implements client-server IRC protocol. It is designed to be small, fast, portable and compatible to RFC standards, and most IRC clients. libircclient features include:<ul>
<li>Full multi-threading support.</li><li>Single threads handles all the IRC processing.</li><li>Support for single-threaded applications, and socket-based applications, which use select()</li><li>Synchronous and asynchronous interfaces.</li><li>CTCP support with optional build-in reply code.</li><li>Flexible DCC support, including both DCC chat, and DCC file transfer.</li><li>Can both initiate and react to initiated DCC.</li><li>Can accept or decline DCC sessions asynchronously.</li><li>Plain C interface and implementation (possible to use from C++ code, obviously)</li><li>Compatible with RFC 1459 and most IRC clients.</li><li>Free, licensed under LGPL license.</li><li>Good documentation and examples available.</li></ul>
<h2><a class="anchor" name="install_sec">
Compilation on Unix</a></h2>
To compile libircclient, unpack the distribution, and do the standard mantra: <div class="fragment"><pre class="fragment"><span class="preprocessor"> # ./configure</span>
<span class="preprocessor"></span><span class="preprocessor"> # make</span>
<span class="preprocessor"> # make install</span>
</pre></div><h2><a class="anchor" name="install_secw">
Compilation under MS Windows</a></h2>
To compile libircclient under MS Windows:<ul>
<li>open the src/win32/libircclient.dsw file;</li><li>select the appropriate library linkage (static or dynamic), and debug/release version;</li><li>do 'Make build'</li></ul>
<p>
You can also build the example using spammer.dsp project file. Here you can see how to integrate libircclient into your own project.<h2><a class="anchor" name="doc">
Documentation</a></h2>
Documentation is not installed with <em>make</em> <em>install</em>; you should copy it somewhere by hand. There is html documentation (in <em>doc/html</em>) and manual pages (<em>doc/man</em>). It is also recommended to check the <em>examples</em> directory, there are a few examples, they'll help you.<h2><a class="anchor" name="cocoa">
Cocoa Support</a></h2>
There is an experimental Cocoa framework wrapper around libircclient, called <a href="../../cocoa/doc/html/index.html">IRCClient</a>. You can find the Xcode project and source in the cocoa/ directory in the current trunk.<h2><a class="anchor" name="author">
Author, copyright, support.</a></h2>
If you have any questions, bug reports, suggestions regarding libircclient - please send them to <a href="mailto:gyunaev@ulduzsoft.com">gyunaev@ulduzsoft.com</a>.<p>
Copyright (C) 2004-2009 Georgy Yunaev <a href="mailto:gyunaev@ulduzsoft.com">gyunaev@ulduzsoft.com</a><p>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.<p>
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. </div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:19:35 2009 for libircclient by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>