usr/src/man/man3head/syslog.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH SYSLOG.H 3HEAD "Sep 10, 2003"
  11 .SH NAME
  12 syslog.h, syslog \- definitions for system error logging
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsyslog.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsyslog.h\fR> header defines the following symbolic constants, zero or
  23 more of which can be OR'ed together to form the \fBlogopt\fR option of
  24 \fBopenlog()\fR:
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fBLOG_PID\fR\fR
  29 .ad
  30 .RS 14n
  31 Log the process ID with each message.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBLOG_CONS\fR\fR
  38 .ad
  39 .RS 14n
  40 Log to the system console on error.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBLOG_NDELAY\fR\fR
  47 .ad
  48 .RS 14n
  49 Connect to syslog daemon immediately.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBLOG_ODELAY\fR\fR
  56 .ad
  57 .RS 14n
  58 Delay open until \fBsyslog()\fR is called.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBLOG_NOWAIT\fR\fR
  65 .ad
  66 .RS 14n
  67 Do not wait for child processes.
  68 .RE
  69
  70 .sp
  71 .LP
  72 The following symbolic constants are defined as possible values of the
  73 \fIfacility\fR argument to \fBopenlog()\fR:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBLOG_KERN\fR\fR
  78 .ad
  79 .RS 14n
  80 reserved for message generated by the system
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBLOG_USER\fR\fR
  87 .ad
  88 .RS 14n
  89 message generated by a process
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBLOG_MAIL\fR\fR
  96 .ad
  97 .RS 14n
  98 reserved for message generated by mail system
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBLOG_NEWS\fR\fR
 105 .ad
 106 .RS 14n
 107 reserved for message generated by news system
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBLOG_UUCP\fR\fR
 114 .ad
 115 .RS 14n
 116 reserved for message generated by UUCP system
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBLOG_DAEMON\fR\fR
 123 .ad
 124 .RS 14n
 125 reserved for message generated by system daemon
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBLOG_AUTH\fR\fR
 132 .ad
 133 .RS 14n
 134 reserved for message generated by authorization daemon
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBLOG_CRON\fR\fR
 141 .ad
 142 .RS 14n
 143 reserved for message generated by clock daemon
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBLOG_LPR\fR\fR
 150 .ad
 151 .RS 14n
 152 reserved for message generated by printer system
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBLOG_LOCAL0\fR\fR
 159 .ad
 160 .RS 14n
 161 reserved for local use
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBLOG_LOCAL1\fR\fR
 168 .ad
 169 .RS 14n
 170 reserved for local use
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBLOG_LOCAL2\fR\fR
 177 .ad
 178 .RS 14n
 179 reserved for local use
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fBLOG_LOCAL3\fR\fR
 186 .ad
 187 .RS 14n
 188 reserved for local use
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fBLOG_LOCAL4\fR\fR
 195 .ad
 196 .RS 14n
 197 reserved for local use
 198 .RE
 199
 200 .sp
 201 .ne 2
 202 .na
 203 \fB\fBLOG_LOCAL5\fR\fR
 204 .ad
 205 .RS 14n
 206 reserved for local use
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fBLOG_LOCAL6\fR\fR
 213 .ad
 214 .RS 14n
 215 reserved for local use
 216 .RE
 217
 218 .sp
 219 .ne 2
 220 .na
 221 \fB\fBLOG_LOCAL7\fR\fR
 222 .ad
 223 .RS 14n
 224 reserved for local use
 225 .RE
 226
 227 .sp
 228 .LP
 229 The following is declared as a macro for constructing the \fImaskpri\fR
 230 argument to \fBsetlogmask()\fR. The following macro expands to an expression of
 231 type \fBint\fR when the argument \fIpri\fR is an expre ssion of type \fBint\fR:
 232 .sp
 233 .ne 2
 234 .na
 235 \fB\fBLOG_MASK(\fR\fIpri\fR\fB)\fR\fR
 236 .ad
 237 .RS 17n
 238 a mask for priority \fIpri\fR
 239 .RE
 240
 241 .sp
 242 .LP
 243 The following constants are defined as possible values for the \fIpriority\fR
 244 argument of \fBsyslog()\fR:
 245 .sp
 246 .ne 2
 247 .na
 248 \fB\fBLOG_EMERG\fR\fR
 249 .ad
 250 .RS 15n
 251 A panic condition was reported to all processes.
 252 .RE
 253
 254 .sp
 255 .ne 2
 256 .na
 257 \fB\fBLOG_ALERT\fR\fR
 258 .ad
 259 .RS 15n
 260 A condition that should be corrected immediately.
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fB\fBLOG_CRIT\fR\fR
 267 .ad
 268 .RS 15n
 269 A critical condition.
 270 .RE
 271
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fBLOG_ERR\fR\fR
 276 .ad
 277 .RS 15n
 278 An error message.
 279 .RE
 280
 281 .sp
 282 .ne 2
 283 .na
 284 \fB\fBLOG_WARNING\fR\fR
 285 .ad
 286 .RS 15n
 287 A warning message.
 288 .RE
 289
 290 .sp
 291 .ne 2
 292 .na
 293 \fB\fBLOG_NOTICE\fR\fR
 294 .ad
 295 .RS 15n
 296 A condition requiring special handling.
 297 .RE
 298
 299 .sp
 300 .ne 2
 301 .na
 302 \fB\fBLOG_INFO\fR\fR
 303 .ad
 304 .RS 15n
 305 A general information message.
 306 .RE
 307
 308 .sp
 309 .ne 2
 310 .na
 311 \fB\fBLOG_DEBUG\fR\fR
 312 .ad
 313 .RS 15n
 314 A message useful for debugging programs.
 315 .RE
 316
 317 .SH ATTRIBUTES
 318 .sp
 319 .LP
 320 See \fBattributes\fR(5) for descriptions of the following attributes:
 321 .sp
 322
 323 .sp
 324 .TS
 325 box;
 326 c | c
 327 l | l .
 328 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 329 _
 330 Interface Stability     Standard
 331 .TE
 332
 333 .SH SEE ALSO
 334 .sp
 335 .LP
 336 \fBsyslog\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)