Mercurial > irccd
comparison man/irccd-api-logger.3 @ 932:0e11221c9bcc
man: split irccd-api into individual ones
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Tue, 05 Jan 2021 22:25:47 +0100 |
| parents | |
| children | cf99df45cb84 |
comparison
equal
deleted
inserted
replaced
| 931:c78ad0799e68 | 932:0e11221c9bcc |
|---|---|
| 1 .\" | |
| 2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr> | |
| 3 .\" | |
| 4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
| 16 .Dd @IRCCD_MAN_DATE@ | |
| 17 .Dt IRCCD-API-LOGGER 3 | |
| 18 .Os | |
| 19 .\" NAME | |
| 20 .Sh NAME | |
| 21 .Nm Irccd.Logger | |
| 22 .Nd logging API | |
| 23 .\" SYNOPSIS | |
| 24 .Sh SYNOPSIS | |
| 25 .Fn Irccd.Logger.debug "message" | |
| 26 .Fn Irccd.Logger.info "message" | |
| 27 .Fn Irccd.Logger.warning "message" | |
| 28 .\" DESCRIPTION | |
| 29 .Sh DESCRIPTION | |
| 30 This module must be used to log messages. It will add messages to the logging | |
| 31 system configured in the | |
| 32 .Xr irccd.conf 5 | |
| 33 file. | |
| 34 .Pp | |
| 35 For instance, if user has chosen to log into syslog, this module will log at | |
| 36 syslog too. | |
| 37 .Pp | |
| 38 Any plugin can log messages, the message will be prepended by the plugin name to | |
| 39 be easily identifiable. | |
| 40 .\" METHODS | |
| 41 .Sh METHODS | |
| 42 .\" Irccd.Logger.debug | |
| 43 The | |
| 44 .Fn Irccd.Logger.debug | |
| 45 method adds a debug | |
| 46 .Fa message , | |
| 47 this is only appended to the journal if irccd was compiled in Debug mode. | |
| 48 .Pp | |
| 49 .\" Irccd.Logger.info | |
| 50 The | |
| 51 .Fn Irccd.Logger.info | |
| 52 method adds a informational | |
| 53 .Fa message . | |
| 54 The message is logged only if irccd is running with verbose messages enabled. | |
| 55 .Pp | |
| 56 .\" Irccd.Logger.warning | |
| 57 The | |
| 58 .Fn Irccd.Logger.warning | |
| 59 method adds a warning | |
| 60 .Fa message . | |
| 61 The message will always be logged. | |
| 62 .\" SEE ALSO | |
| 63 .Sh SEE ALSO | |
| 64 .Xr irccd-api 3 |