Mercurial > irccd

comparison man/irccd-api.3 @ 1002:ec5461750efd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: add Irccd.Rule and Irccd.Hook manual pages
author David Demelier <markand@malikania.fr>
date Sat, 13 Feb 2021 22:15:16 +0100
parents 0e11221c9bcc
children 3ea3361f0fc7
comparison
equal deleted inserted replaced
1001:b01f5d65d62a 1002:ec5461750efd
25 .Ss Modules 25 .Ss Modules
26 .Vt Irccd 26 .Vt Irccd
27 .Vt Irccd.Chrono 27 .Vt Irccd.Chrono
28 .Vt Irccd.Directory 28 .Vt Irccd.Directory
29 .Vt Irccd.File 29 .Vt Irccd.File
30 .Vt Irccd.Hook
30 .Vt Irccd.Logger 31 .Vt Irccd.Logger
31 .Vt Irccd.Plugin 32 .Vt Irccd.Plugin
33 .Vt Irccd.Rule
32 .Vt Irccd.Server 34 .Vt Irccd.Server
33 .Vt Irccd.System 35 .Vt Irccd.System
34 .Vt Irccd.Timer 36 .Vt Irccd.Timer
35 .Vt Irccd.Unicode 37 .Vt Irccd.Unicode
36 .Vt Irccd.Util 38 .Vt Irccd.Util
318 .Sh CONSTANTS 320 .Sh CONSTANTS
319 .\" Constants 321 .\" Constants
320 The following constants properties are defined: 322 The following constants properties are defined:
321 .Pp 323 .Pp
322 .Bl -tag 324 .Bl -tag
323 .It Va Irccd.version No (object) 325 .It Va Irccd.Version No (object)
324 See below. 326 See below.
325 .It Va Irccd.version.major No (int) 327 .It Va Irccd.Version.Major No (int)
326 The major irccd version. 328 The major irccd version.
327 .It Va Irccd.version.minor No (int) 329 .It Va Irccd.Version.Minor No (int)
328 The minor irccd version. 330 The minor irccd version.
329 .It Va Irccd.version.patch No (int) 331 .It Va Irccd.Version.Patch No (int)
330 The patch irccd version. 332 The patch irccd version.
331 .El 333 .El
332 .Pp 334 .Pp
333 .\" EXCEPTIONS 335 .\" EXCEPTIONS
334 .Sh EXCEPTIONS 336 .Sh EXCEPTIONS
335 The following exceptions are defined: 337 The following exceptions are defined:
336 .Bl -tag 338 .Bl -tag
337 .It Va Irccd.SystemError 339 .It Va Irccd.SystemError
338 An exception inheriting Error thrown by some filesystem functions. 340 An exception inheriting Error thrown by some filesystem functions.
339 .It Va Irccd.ServerError
340 Thrown from Irccd.Server module.
341 .It Va Irccd.PluginError
342 Throw from Irccd.Plugin module.
343 .El 341 .El
344 .\" SEE ALSO 342 .\" SEE ALSO
345 .Sh SEE ALSO 343 .Sh SEE ALSO
346 .Xr irccd 1 344 .Xr irccd 1
347 .Xr irccd-api-chrono 3 , 345 .Xr irccd-api-chrono 3 ,
348 .Xr irccd-api-directory 3 , 346 .Xr irccd-api-directory 3 ,
349 .Xr irccd-api-file 3 , 347 .Xr irccd-api-file 3 ,
348 .Xr irccd-api-hook 3 ,
350 .Xr irccd-api-logger 3 , 349 .Xr irccd-api-logger 3 ,
351 .Xr irccd-api-plugin 3 , 350 .Xr irccd-api-plugin 3 ,
351 .Xr irccd-api-rule 3 ,
352 .Xr irccd-api-server 3 , 352 .Xr irccd-api-server 3 ,
353 .Xr irccd-api-system 3 , 353 .Xr irccd-api-system 3 ,
354 .Xr irccd-api-timer 3 , 354 .Xr irccd-api-timer 3 ,
355 .Xr irccd-api-unicode 3 , 355 .Xr irccd-api-unicode 3 ,
356 .Xr irccd-api-util 3 356 .Xr irccd-api-util 3