man3/setlogmask.3

   1 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH SETLOGMASK 3  2021-03-22 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 setlogmask \- set log priority mask
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <syslog.h>
  31 .PP
  32 .BI "int setlogmask(int " mask );
  33 .fi
  34 .SH DESCRIPTION
  35 A process has a log priority mask that determines which calls to
  36 .BR syslog (3)
  37 may be logged.
  38 All other calls will be ignored.
  39 Logging is enabled for the priorities that have the corresponding
  40 bit set in
  41 .IR mask .
  42 The initial mask is such that logging is enabled for all priorities.
  43 .PP
  44 The
  45 .BR setlogmask ()
  46 function sets this logmask for the calling process,
  47 and returns the previous mask.
  48 If the mask argument is 0, the current logmask is not modified.
  49 .PP
  50 The eight priorities are
  51 .BR LOG_EMERG ,
  52 .BR LOG_ALERT ,
  53 .BR LOG_CRIT ,
  54 .BR LOG_ERR ,
  55 .BR LOG_WARNING ,
  56 .BR LOG_NOTICE ,
  57 .BR LOG_INFO ,
  58 and
  59 .BR LOG_DEBUG .
  60 The bit corresponding to a priority
  61 .I p
  62 is
  63 .IR LOG_MASK(p) .
  64 Some systems also provide a macro
  65 .IR LOG_UPTO(p)
  66 for the mask
  67 of all priorities in the above list up to and including
  68 .IR p .
  69 .SH RETURN VALUE
  70 This function returns the previous log priority mask.
  71 .SH ERRORS
  72 None.
  73 .\" .SH NOTES
  74 .\" The glibc logmask handling was broken in versions before glibc 2.1.1.
  75 .SH ATTRIBUTES
  76 For an explanation of the terms used in this section, see
  77 .BR attributes (7).
  78 .ad l
  79 .nh
  80 .TS
  81 allbox;
  82 lbx lb lb
  83 l l l.
  84 Interface       Attribute       Value
  85 T{
  86 .BR setlogmask ()
  87 T}      Thread safety   MT-Unsafe race:LogMask
  88 .TE
  89 .hy
  90 .ad
  91 .sp 1
  92 .SH CONFORMING TO
  93 POSIX.1-2001, POSIX.1-2008.
  94 .\" Note that the description in POSIX.1-2001 is flawed.
  95 .PP
  96 .BR LOG_UPTO ()
  97 will be included in the next release of the POSIX specification (Issue 8).
  98 .\" FIXME . https://www.austingroupbugs.net/view.php?id=1033
  99 .SH SEE ALSO
 100 .BR closelog (3),
 101 .BR openlog (3),
 102 .BR syslog (3)