diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/libalpm_log.3 | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3/libalpm_log.3')
-rw-r--r-- | upstream/archlinux/man3/libalpm_log.3 | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/libalpm_log.3 b/upstream/archlinux/man3/libalpm_log.3 new file mode 100644 index 00000000..01defc87 --- /dev/null +++ b/upstream/archlinux/man3/libalpm_log.3 @@ -0,0 +1,102 @@ +.TH "libalpm_log" 3 "Tue Feb 6 2024 19:11:31" "libalpm" \" -*- nroff -*- +.ad l +.nh +.SH NAME +libalpm_log \- Logging Functions +.SH SYNOPSIS +.br +.PP +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef void(* \fBalpm_cb_log\fP) (void *ctx, \fBalpm_loglevel_t\fP level, const char *fmt, va_list args)" +.br +.RI "The callback type for logging\&. " +.in -1c +.SS "Enumerations" + +.in +1c +.ti -1c +.RI "enum \fBalpm_loglevel_t\fP { \fBALPM_LOG_ERROR\fP = 1, \fBALPM_LOG_WARNING\fP = (1 << 1), \fBALPM_LOG_DEBUG\fP = (1 << 2), \fBALPM_LOG_FUNCTION\fP = (1 << 3) }" +.br +.RI "Logging Levels\&. " +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "int \fBalpm_logaction\fP (\fBalpm_handle_t\fP *handle, const char *prefix, const char *fmt,\&.\&.\&.) __attribute__((format(printf" +.br +.RI "A printf-like function for logging\&. " +.in -1c +.SH "Detailed Description" +.PP + + +Functions to log using libalpm +.SH "Typedef Documentation" +.PP +.SS "typedef void(* alpm_cb_log) (void *ctx, \fBalpm_loglevel_t\fP level, const char *fmt, va_list args)" + +.PP +The callback type for logging\&. libalpm will call this function whenever something is to be logged\&. many libalpm will produce log output\&. Additionally any calls to \fBalpm_logaction\fP will also call this callback\&. +.PP +\fBParameters\fP +.RS 4 +\fIctx\fP user-provided context +.br +\fIlevel\fP the currently set loglevel +.br +\fIfmt\fP the printf like format string +.br +\fIargs\fP printf like arguments +.RE +.PP + +.SH "Enumeration Type Documentation" +.PP +.SS "enum \fBalpm_loglevel_t\fP" + +.PP +Logging Levels\&. +.PP +\fBEnumerator\fP +.in +1c +.TP +\fB\fIALPM_LOG_ERROR \fP\fP +Error\&. +.TP +\fB\fIALPM_LOG_WARNING \fP\fP +Warning\&. +.TP +\fB\fIALPM_LOG_DEBUG \fP\fP +Debug\&. +.TP +\fB\fIALPM_LOG_FUNCTION \fP\fP +Function\&. +.SH "Function Documentation" +.PP +.SS "int alpm_logaction (\fBalpm_handle_t\fP * handle, const char * prefix, const char * fmt, \&.\&.\&.)" + +.PP +A printf-like function for logging\&. +.PP +\fBParameters\fP +.RS 4 +\fIhandle\fP the context handle +.br +\fIprefix\fP caller-specific prefix for the log +.br +\fIfmt\fP output format +.RE +.PP +\fBReturns\fP +.RS 4 +0 on success, -1 on error (pm_errno is set accordingly) +.RE +.PP + +.SH "Author" +.PP +Generated automatically by Doxygen for libalpm from the source code\&. |