Document tunnel command's environment variables
[claws.git] / doc / src / maintainer_guide.txt
1 Contents:
2
3   1. Files in src/
4   2. Files in src/common/
5   3. Files in src/gtk/
6   4. Hooks summary
7
8
9 ------------------------------------------------------------------------------
10 1. Files in src/
11
12 account.c
13    is the accounts list dialog
14 action.c
15    dialog and functions for external actions
16 addr_compl.c
17    is the address completion process
18 addrbook.c
19    management of address book
20 addrcache.c
21    functions to maintain address cache
22 addrcindex.c
23    functions to maintain address completion index
24 addrclip.c
25    contains address clipboard objects and related functions
26 addressadd.c
27    add address to address book dialog
28 addressbook.c
29    is the address book dialog
30 addrgather.c
31    dialog for gathering EMail addresses from mail folder
32 addrharvest.c
33    functions for an E-Mail address harvester
34 addrindex.c
35    general functions for accessing address index file
36 addritem.c
37    general primitive address item objects
38 addrselect.c
39    address list item selection objects
40 alertpanel.c
41    dialog displaying warnings and notifications
42 codeconv.c
43    conversion of charset encodings
44 compose.c
45    is the compose dialog
46 crash.c
47    collect gdb backtrace info on crashes
48 customheader.c
49    function to parse custom headers configuration file
50 displayheader.c
51    function to parse headers display configuration file
52 editaddress.c
53    editing single addressbook entries
54 editbook.c
55    editing addressbooks
56 editgroup.c
57    editing addressbook groups
58 editjpilot.c
59    edit JPilot address book data
60 editldap.c
61    edit LDAP address book data
62 editldap_basedn.c
63    LDAP Base DN selection dialog
64 editvcard.c
65    edit vCard address book data
66 enriched.c
67    parses text/enriched mime type
68 exphtmldlg.c
69    export address book to HTML file (GUI)
70 expldifdlg.c
71    export address book to LDIF file (GUI)
72 export.c
73    exports MH folders to MBOX
74 exporthtml.c
75    export address book to HTML file
76 exportldif.c
77    export address book to LDIF file
78 filtering.c
79    handles the filtering process and function for filtering data structure
80 folder.c
81    handles the folder structure (left panel) without any gtk
82 folder_item_prefs.c
83    folder property functions (load, save, copy, ...)
84 foldersel.c
85    dialog for selecting mail folders
86 folderview.c
87    is the left panel gtk implementation
88 grouplistdialog.c
89    this is the newsgroup selection dialog box
90 headerview.c
91    is the little header viewer between the list of mails and
92    the mail viewer.html.c
93 imap.c
94    is the handling of the IMAP4 procotol
95 import.c
96    import from mbox dialog
97 importldif.c
98    import LDIF address book data
99 importmutt.c
100    import Mutt address book data
101 importpine.c
102    import Pine address book data
103 inc.c
104    retrievement of POP3 or mbox accounts
105 inputdialog.c
106    this is a dialog for the user to type something.
107 jpilot.c
108    functions necessary to access JPilot database files
109 ldapctrl.c
110    functions for LDAP control data
111 ldapquery.c
112    functions necessary to define and perform LDAP queries
113 ldapserver.c
114    functions necessary to access LDAP servers
115 ldaputil.c
116    some utility functions to access LDAP servers
117 ldif.c
118    functions necessary to access LDIF files (LDAP Data Interchange Format
119    files)
120 logwindow.c
121    is the log window (tool menu / log window)
122 main.c
123    is the main program entry of Sylpheed
124 mainwindow.c
125    is the 3-paned main window
126 manual.c
127    help menu: links to manual and FAQ
128 matcher.c
129    this is some function to match the messages, to handle data structure
130    of matcher/filtering/scoring system or to convert data structures
131    to string.
132 matcher_parser_lex.l
133    this is the lexer used in the parse operation of the configuration files
134    of the matcher/filtering/scoring system.
135 matcher_parser_parse.y
136    this is the parser of the configuration files of
137    the matcher/filtering/scoring system.
138 mbox.c
139    is the mbox importer/exporter
140 mbox_folder.c
141    is the mbox folder support
142 message_search.c
143    dialog for searching current message
144 messageview.c
145    is the mail viewer part of the main window
146 mh.c
147    handles mh folders
148 mimeview.c
149    is the displaying of the list of the MIME part of the mail
150    (at the top of the mail viewer when it is displayed)
151 msgcache.c
152    handles cached message infos
153 mutt.c
154    functions necessary to access MUTT address book file
155 news.c
156    is the news session handling (it uses the nntp protocol)
157 noticeview.c
158    *********** NO DESCRIPTION *********
159 passphrase.c
160    *********** NO DESCRIPTION *********
161 pine.c
162    functions necessary to access Pine address book file
163 pop.c
164    functions for POP3 sessions
165 prefs_account.c
166    is preferences for account dialog
167 prefs_actions.c
168    is preferences for action dialog
169 prefs_common.c
170    is the preferences dialog
171 prefs_customheader.c
172    is the preferences dialog for custom headers
173 prefs_display_header.c
174    is the preferences dialog for headers display
175 prefs_filtering.c
176    is preferences for filtering system dialog
177 prefs_filtering_action.c
178    let the user define the actions for a filtering rule
179 prefs_folder_item.c
180    is the preference dialog for a folder item
181 prefs_gtk.c
182    common functions for handling config windows
183 prefs_matcher.c
184    let the user define the condition for a filtering rule or a scoring rule
185 prefs_scoring.c
186    is preferences for scoring system dialog
187 prefs_summary_column.c
188    dialog for selecting items to display in summaryview
189 prefs_template.c
190    dialog for editing templates
191 prefs_toolbar.c
192    dialog for customizing toolbars
193 procheader.c
194    is the RFC822 headers parser.
195 procmime.c
196    is a MIME parser.
197 procmsg.c
198    handle the list of message files.
199 progressdialog.c
200    is a dialog box with a progress bar
201 quote_fmt.c
202    is the quotation system for forward or reply
203 quote_fmt_lex.l
204    is the lexer for the configuration of the quotation system
205 quote_fmt_parse.y
206    is the parser for the configuration of the quotation system
207 recv.c
208    this will receive some data from a file descriptor and write
209    them to a file.
210 rfc2015.c
211    GPG support
212 scoring.c
213    handles the scoring process and function for scoring data structure
214 select-keys.c
215    dialog for selecting gpg keys
216 send_message.c
217    message sending to SMTP or through sendmail command.
218 setup.c
219    functions for first run (select mailbox dialog) 
220 sigstatus.c
221    dialog for gpg signature check
222 simple-gettext.c
223    a simplified version of gettext
224 sourcewindow.c
225    displays the source of the messages.
226 ssl_manager.c
227    dialog for handling SSL certificates
228 statusbar.c
229    functions for handling statusbar output
230 stock_pixmap.c
231    handle the pixmaps including pixmap theming
232 string_match.c
233    regexp pattern matching utilities
234 summary_search.c
235    dialog for searching folders
236 summaryview.c
237    is the displaying of list of the mail in a folder
238               (up/right in the main window).
239 syldap.c
240    functions necessary to access LDAP servers
241 textview.c
242    is the mail (without MIME part) displaying of the
243    mail viewer.
244 toolbar.c
245    functions for handling toolbars
246 undo.c
247    undo functions for message editor
248 unmime.c
249    decodes headers based on RFC2045 and RFC2047
250 vcard.c
251    functions necessary to access vCard files
252
253
254 ------------------------------------------------------------------------------
255 2. Files in src/common/
256
257 hooks.c
258    functions for handling hooks
259 log.c
260    functions for logging (stdout, file, hook)
261 md5.c
262    This is MD5 calculation
263 mgutils.c
264    common tools for string and list handling
265 nntp.c
266   is the handling of the NNTP procotol
267 passcrypt.c
268   encoding of the password in the configuration files.
269 plugin.c
270    functions for plugin handling
271 prefs.c
272    is a preference file parser.
273 quoted-printable.c
274    handle quoted-printable conversion
275 session.c
276    This is network connection.
277 smtp.c
278    handles the SMTP and ESMTP protocol with authentification
279 socket.c
280    is some function to make it easier to use TCP/unix socket.
281 ssl.c
282    SSL init and cleanup functions
283 ssl_certificate.c
284    functions for checking SSL certificates
285 stringtable.c
286    functions for handling hashed string tables
287 sylpheed.c
288    application init and cleanup functions
289 template.c
290    functions for loading and saving templates
291 utils.c
292    common tool functions
293 uuencode.c
294    UU encoder
295 xml.c
296    XML parser
297 xmlprops.c
298    *********** NO DESCRIPTION *********
299
300
301 ------------------------------------------------------------------------------
302 3. Files in src/gtk/
303
304 about.c
305    this is the about dialog
306 colorlabel.c
307    dialog for setting message color
308 description_window.c
309    dialog for showing descriptions (e.g. action syntax)
310 filesel.c
311    This is a file selection dialog
312 gtkaspell.c
313    spellchecking widget
314 gtksctree.c
315    This is a modified GtkCTree.
316 gtkshruler.c
317    ruler widget (shown in message editor)
318 gtkstext.c
319    This is a modified GtkText.
320 gtkutils.c
321    common tools for gtk widgets (e.g. ctree)
322 gtkvscrollbutton.c
323    composite widget to provide vertical scrolling
324 manage_window.c
325    *********** NO DESCRIPTION *********
326 menu.c
327    functions for handling menus
328 pluginwindow.c
329    dialog for loading and unloading plugins
330 prefswindow.c
331    treeview based preferences dialog
332 sslcertwindow.c
333    dialog to display, change or add SSL certificates
334
335
336 ------------------------------------------------------------------------------
337 4. Hooks summary
338
339 FOLDER_ITEM_UPDATE_HOOKLIST
340   invocation    after folder content has changed
341   definition    folder.h
342   usage         folder.c, trayicon plugin
343   source        FolderItemUpdateData
344   return        /
345 FOLDER_UPDATE_HOOKLIST
346   invocation    after folder content has changed
347   definition    folder.h
348   usage         folder.c
349   source        FolderUpdateData
350   return        /
351 LOG_APPEND_TEXT_HOOKLIST
352   invocation    after appending LogText to logfiles
353   definition    common/log.h
354   usage         logwindow.c, demo plugin
355   source        LogText
356   return        /
357 MAIL_FILTERING_HOOKLIST
358   invocation    before applying filtering rules
359   definition    procmsg.h
360   usage         spamassassin plugin, clamav plugin.
361   source        MailFilteringData
362   return        TRUE stops further processing of current message
363 MAIL_RECEIVE_HOOKLIST
364   invocation    after mail retrieval (before filtering)
365   definition    pop.h
366   usage         fetchinfo plugin
367   source        MailFilteringData
368   return        TRUE stops further processing of this message
369 MSGINFO_UPDATE_HOOKLIST
370   invocation    when msginfo has changed
371   definition    procmsg.h
372   usage         summaryview.c
373   source        MsginfoUpdate
374   return        /
375 PROGRESSINDICATOR_HOOKLIST
376   invocation    starts/stops/sets progressbar
377   definition    common/progressindicator.h
378   usage         mainwindow.c
379   source        ProgressData
380   data          MainWindow
381   return        /
382 SSLCERT_ASK_HOOKLIST
383   invocation    asks for accepting new or modified SSL sertificates
384   definition    common/ssl_certificate.h
385   usage         ssl_certificate.c
386   source        SSLCertHookData
387   return        /
388