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

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