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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright (C) 2004-2009 Georgy Yunaev gyunaev@ulduzsoft.com
*
* 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.
*
* 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.
*/
/*!
* \file libirc_doc.h
* \author Georgy Yunaev
* \version 1.0
* \date 09.2004
* \brief This file contains Doxygen modules.
*/
/*! \mainpage libircclient - a IRC library to create IRC clients
*
* \section intro_sec Introduction
*
* 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:
* - Full multi-threading support.
* - Single threads handles all the IRC processing.
* - Support for single-threaded applications, and socket-based applications,
* which use select()
* - Synchronous and asynchronous interfaces.
* - CTCP support with optional build-in reply code.
* - Flexible DCC support, including both DCC chat, and DCC file transfer.
* - Can both initiate and react to initiated DCC.
* - Can accept or decline DCC sessions asynchronously.
* - Plain C interface and implementation (possible to use from C++ code,
* obviously)
* - Compatible with RFC 1459 and most IRC clients.
* - Free, licensed under LGPL license.
* - Good documentation and examples available.
*
* \section install_sec Compilation on Unix
*
* To compile libircclient, unpack the distribution, and do the standard mantra:
* \code
* # ./configure
* # make
* # make install
* \endcode
*
* \section install_secw Compilation under MS Windows
*
* To compile libircclient under MS Windows:
* - open the src/win32/libircclient.dsw file;
* - select the appropriate library linkage (static or dynamic), and
* debug/release version;
* - do 'Make build'
*
* You can also build the example using spammer.dsp project file. Here you
* can see how to integrate libircclient into your own project.
*
* \section doc Documentation
*
* Documentation is not installed with \a make \a install; you should copy it
* somewhere by hand.
* There is html documentation (in \a doc/html) and manual pages (\a doc/man).
* It is also recommended to check the \a examples directory, there are a
* few examples, they'll help you.
*
* \section author Author, copyright, support.
*
* If you have any questions, bug reports, suggestions regarding libircclient -
* please send them to gyunaev@ulduzsoft.com.
*
* Copyright (C) 2004-2009 Georgy Yunaev gyunaev@ulduzsoft.com
*
* 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.
*
* 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.
*
*/
/*!
* \defgroup initclose Initiating and destroying IRC session.
*/
/*!
* \defgroup conndisc Connecting, disconnecting from IRC server.
*/
/*!
* \defgroup running Running IRC session.
*/
/*!
* \defgroup ircmd_ch IRC commands: channel management.
*/
/*!
* \defgroup ircmd_msg IRC commands: sending messages/notices.
*/
/*!
* \defgroup ircmd_oth IRC commands: other stuff.
*/
/*!
* \defgroup ctcp CTCP requests and replies.
*/
/*!
* \defgroup nnparse Nickname parsing.
*/
/*!
* \defgroup dccstuff DCC chat/send requests and replies.
*/
/*!
* \defgroup events Handling IRC events.
*/
/*!
* \defgroup errors Obtaining error values and descriptions.
*/
/*!
* \defgroup errorcodes Error codes generated by libircclient.
*/
/*!
* \defgroup contexts Managing contexts.
*/
/*!
* \defgroup common Getting libircclient version.
*/
/*!
* \defgroup options Managing libircclient options.
*/
/*!
* \defgroup rfcnumbers Numeric reply codes from RFC1459
*/
/*!
* \defgroup colors Messages colors manipulation
*/
|
