draft/man3/syslog.3

   1 .\" Written  Feb 1994 by Steve Greenland (stevegr@neosoft.com)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" Updated 1999.12.19 by Karl M. Hegbloom <karlheg@debian.org>
  24 .\"
  25 .\" Updated 13 Oct 2001, Michael Kerrisk <mtk.manpages@gmail.com>
  26 .\"     Added description of vsyslog
  27 .\"     Added descriptions of LOG_ODELAY and LOG_NOWAIT
  28 .\"     Added brief description of facility and option arguments
  29 .\"     Added CONFORMING TO section
  30 .\" 2001-10-13, aeb, minor changes
  31 .\" Modified 13 Dec 2001, Martin Schulze <joey@infodrom.org>
  32 .\" Modified 3 Jan 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"
  34 .\" Japanese Verion Copyright (c) 1996 Shoichi OZAWA
  35 .\"     all right reserved.
  36 .\" Translated Sep 1 20:14:01 JST 1996
  37 .\"     by Shoichi OZAWA <ozawa@omika.hitachi.co.jp>
  38 .\" Updated Thu Oct 18 01:00:02 JST 2001
  39 .\"     by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  40 .\" Updated Fri Jan 4 22:15:21 JST 2002
  41 .\"     by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  42 .\" Updated 2002-04-14 by Kentaro Shirakata <argrath@ub32.org>
  43 .\" Updated 2007-01-01 by Kentaro Shirakata <argrath@ub32.org>
  44 .\"
  45 .TH SYSLOG 3 2008-11-12 "Linux" "Linux Programmer's Manual"
  46 .\"O .SH NAME
  47 .\"O closelog, openlog, syslog, vsyslog \- send messages to the system logger
  48 .SH 名前
  49 closelog, openlog, syslog, vsyslog \- システムロガーにメッセージを送る
  50 .\"O .SH SYNOPSIS
  51 .SH 書式
  52 .B #include <syslog.h>
  53 .sp
  54 .BI "void openlog(const char *" ident ", int " option ", int " facility );
  55 .br
  56 .BI "void syslog(int " priority ", const char *" format ", ...);"
  57 .br
  58 .B "void closelog(void);"
  59 .sp
  60 .B #include <stdarg.h>
  61 .sp
  62 .BI "void vsyslog(int " priority ", const char *" format ", va_list " ap );
  63 .sp
  64 .in -4n
  65 .\"O Feature Test Macro Requirements for glibc (see
  66 .\"O .BR feature_test_macros (7)):
  67 glibc 向けの機能検査マクロの要件
  68 .RB ( feature_test_macros (7)
  69 参照):
  70 .in
  71 .sp
  72 .BR vsyslog ():
  73 _BSD_SOURCE
  74 .\"O .SH DESCRIPTION
  75 .SH 説明
  76 .\"O .BR closelog ()
  77 .\"O closes the descriptor being used to write to the system logger.
  78 .\"O The use of
  79 .\"O .BR closelog ()
  80 .\"O is optional.
  81 .BR closelog ()
  82 はシステムのログ記録用プログラム(システムロガー
  83 .BR syslogd (8))
  84 ヘの接続を終了する。
  85 .BR closelog ()
  86 は必須ではない。
  87 .sp
  88 .\"O .BR openlog ()
  89 .\"O opens a connection to the system logger for a program.
  90 .BR openlog ()
  91 はログを出力しようとしているプログラムからログ記録用プログラムへの
  92 接続を開始する。
  93 .\"O The string pointed
  94 .\"O to by
  95 .\"O .I ident
  96 .\"O is prepended to every message, and is typically set to the program name.
  97 .I ident
  98 で指定した文字列(通常は
  99 .BR openlog ()
 100 したプログラムの名前)はログ出力の一文一文に追加され、どのプログラム
 101 が出力したログかを識別するために使われる。
 102 .\"O The
 103 .\"O .I option
 104 .\"O argument specifies flags which control the operation of
 105 .\"O .BR openlog ()
 106 .\"O and subsequent calls to
 107 .\"O .BR syslog ().
 108 .I option
 109 引き数は、
 110 .BR openlog ()
 111 の動作とその後の
 112 .BR syslog ()
 113 の呼び出しを制御するフラグを指定する。
 114 .\"O The
 115 .\"O .I facility
 116 .\"O argument establishes a default to be used if
 117 .\"O none is specified in subsequent calls to
 118 .\"O .BR syslog ().
 119 .I facility
 120 引き数は、後で
 121 .BR syslog ()
 122 を呼び出す際に facility が指定されなかった場合に使用される
 123 デフォルト値を決定する。
 124 .\"O Values for
 125 .\"O .I option
 126 .\"O and
 127 .\"O .I facility
 128 .\"O are given below.
 129 .\"O The use of
 130 .\"O .BR openlog ()
 131 .\"O is optional; it will automatically be called by
 132 .\"O .BR syslog ()
 133 .\"O if necessary, in which case
 134 .\"O .I ident
 135 .\"O will default to NULL.
 136 .I option
 137 と
 138 .I facility
 139 については後述する。
 140 .BR openlog ()
 141 は必須ではなく、必要に応じて
 142 .BR syslog ()
 143 から呼び出される。
 144 .BR syslog ()
 145 が呼び出した場合、
 146 .I ident
 147 のデフォルト値は NULL になる。
 148 .sp
 149 .\"O .BR syslog ()
 150 .\"O generates a log message, which will be distributed by
 151 .\"O .BR syslogd (8).
 152 .BR syslog ()
 153 はログメッセージを出力し、
 154 .BR syslogd (8)
 155 がそのメッセージを記録する。
 156 .\"O The
 157 .\"O .I priority
 158 .\"O argument is formed by ORing the
 159 .\"O .I facility
 160 .\"O and the
 161 .\"O .I level
 162 .\"O values (explained below).
 163 .I priority
 164 引き数は
 165 .I facility
 166 と
 167 .I level
 168 との組合せで指定する。
 169 .I facility
 170 と
 171 .I level
 172 の取りうる値は後述する。
 173 .\"O The remaining arguments
 174 .\"O are a
 175 .\"O .IR format ,
 176 .\"O as in
 177 .\"O .BR printf (3)
 178 .\"O and any arguments required by the
 179 .\"O .IR format ,
 180 .\"O except that the two character sequence
 181 .\"O .B %m
 182 .\"O will be replaced by
 183 .\"O the error message string
 184 .\"O .IR strerror ( errno ).
 185 .\"O A trailing newline may be added if needed.
 186 残りの
 187 .I format
 188 引き数は
 189 .BR printf (3)
 190 と似たスタイルの書式とその書式に与える値である。
 191 .I format
 192 中の2文字
 193 .B %m
 194 はその時点での
 195 .I errno
 196 に関連するエラーメッセージ文字列
 197 .RI ( strerror )
 198 によって置き換えられる。
 199 必要な場合は末尾に改行が加えられる。
 200 .\"O The function
 201 .\"O .BR vsyslog ()
 202 .\"O performs the same task as
 203 .\"O .BR syslog ()
 204 .\"O with the difference that it takes a set of arguments which have
 205 .\"O been obtained using the
 206 .\"O .BR stdarg (3)
 207 .\"O variable argument list macros.
 208 .BR vsyslog ()
 209 関数は
 210 .BR syslog ()
 211 と同じ機能を持つが、可変引き数リストを指定することができる点が異なる。
 212 指定された引き数は、
 213 .BR stdarg (3)
 214 可変引き数リストマクロを用いて取得される。
 215
 216 .\"O The subsections below list the parameters used to set the values of
 217 .\"O .IR option , " facility" ", and " priority .
 218 .\"O .SS option
 219 .\"O The
 220 .\"O .I option
 221 .\"O argument to
 222 .\"O .BR openlog ()
 223 .\"O is an OR of any of these:
 224 以下のサブセクションでは、
 225 .I option
 226 と
 227 .I facility
 228 と
 229 .I priority
 230 の値を設定するのに使用されるパラメータを説明する。
 231 .SS option
 232 下記の値を OR したものが
 233 .BR openlog ()
 234 の
 235 .I option
 236 引き数になる:
 237 .TP 15
 238 .B LOG_CONS
 239 .\"O Write directly to system console if there is an error while sending to
 240 .\"O system logger.
 241 エラーがあれば、システムロガーに送る一方でシステムコンソールにも直接書く。
 242 .TP
 243 .B LOG_NDELAY
 244 .\"O Open the connection immediately (normally, the connection is opened when
 245 .\"O the first message is logged).
 246 ログ記録用プログラムとの接続を即座に開始する
 247 (通常は、最初のメッセージが記録される時に接続を開く)。
 248 .TP
 249 .B LOG_NOWAIT
 250 .\"O Don't wait for child processes that may have been created while logging
 251 .\"O the message.
 252 .\"O (The GNU C library does not create a child process, so this
 253 .\"O option has no effect on Linux.)
 254 メッセージを記録する際に生成される子プロセスの終了を待たない。
 255 (GNU C ライブラリは子プロセスを生成しない。
 256 したがって、このオプションは Linux では無効である。)
 257 .TP
 258 .B LOG_ODELAY
 259 .\"O The converse of
 260 .\"O .BR LOG_NDELAY ;
 261 .\"O opening of the connection is delayed until
 262 .\"O .BR syslog ()
 263 .\"O is called.
 264 .\"O (This is the default, and need not be specified.)
 265 .B LOG_NDELAY
 266 の反対。
 267 .BR syslog ()
 268 が呼ばれるまで、接続の開始を行わない。
 269 (このオプションはデフォルトであり、特に指定する必要はない。)
 270 .TP
 271 .B LOG_PERROR
 272 .\"O (Not in POSIX.1-2001.)
 273 .\"O Print to stderr as well.
 274 stderr にも出力する。(POSIX.1-2001 では定義されていない)
 275 .TP
 276 .B LOG_PID
 277 .\"O Include PID with each message.
 278 個々のメッセージに PID を含める。
 279 .\"O .SS facility
 280 .SS facility
 281 .\"O The
 282 .\"O .I facility
 283 .\"O argument is used to specify what type of program is logging the message.
 284 .\"O This lets the configuration file specify that messages from different
 285 .\"O facilities will be handled differently.
 286 .I facility
 287 引き数はメッセージに記録されるプログラムのタイプを指定するために使われる。
 288 これによって異なるタイプのプログラムからのメッセージは異なる扱いを
 289 するように設定ファイル(
 290 .BR syslog.conf (5))
 291 に定義できる。
 292 .TP 15
 293 .B LOG_AUTH
 294 .\"O security/authorization messages (DEPRECATED Use
 295 .\"O .B LOG_AUTHPRIV
 296 .\"O instead)
 297 セキュリティ/認証 メッセージ
 298 (非推奨。代わりに
 299 .B LOG_AUTHPRIV
 300 を使用すること)
 301 .TP
 302 .B LOG_AUTHPRIV
 303 .\"O security/authorization messages (private)
 304 セキュリティ/認証 メッセージ (プライベート)
 305 .TP
 306 .B LOG_CRON
 307 .\"O clock daemon
 308 .\"O .RB ( cron " and " at )
 309 クロックデーモン
 310 .RB ( cron
 311 と
 312 .RB at )
 313 .TP
 314 .B LOG_DAEMON
 315 .\"O system daemons without separate facility value
 316 特定の facility 値を持たないシステムデーモン
 317 .TP
 318 .B LOG_FTP
 319 .\"O ftp daemon
 320 ftp デーモン
 321 .TP
 322 .B LOG_KERN
 323 .\"O kernel messages (these can't be generated from user processes)
 324 カーネルメッセージ (ユーザプロセスから生成することはできない)
 325 .\" LOG_KERN has the value 0; if used as a facility, zero translates to:
 326 .\" "use the default facility".
 327 .TP
 328 .\"O .BR LOG_LOCAL0 " through " LOG_LOCAL7
 329 .\"O reserved for local use
 330 .BR LOG_LOCAL0 " から " LOG_LOCAL7
 331 ローカルな使用のためにリザーブされている
 332 .TP
 333 .B LOG_LPR
 334 .\"O line printer subsystem
 335 ラインプリンタ・サブシステム
 336 .TP
 337 .B LOG_MAIL
 338 .\"O mail subsystem
 339 メール・サブシステム
 340 .TP
 341 .B LOG_NEWS
 342 .\"O USENET news subsystem
 343 USENET ニュース・サブシステム
 344 .TP
 345 .B LOG_SYSLOG
 346 .\"O messages generated internally by
 347 .\"O .BR syslogd (8)
 348 .BR syslogd (8)
 349 によって内部的に発行されるメッセージ
 350 .TP
 351 .\"O .BR LOG_USER " (default)"
 352 .BR LOG_USER " (デフォルト)"
 353 .\"O generic user-level messages
 354 一般的なユーザレベルメッセージ
 355 .TP
 356 .B LOG_UUCP
 357 .\"O UUCP subsystem
 358 UUCPサブシステム
 359 .SS level
 360 .\"O This determines the importance of the message.
 361 .\"O The levels are, in order of decreasing importance:
 362 これはメッセージの優先度を指定する。
 363 優先度の高いものから低いものの順で下記する。
 364 .TP 15
 365 .B LOG_EMERG
 366 .\"O system is unusable
 367 システムが使用不可
 368 .TP
 369 .B LOG_ALERT
 370 .\"O action must be taken immediately
 371 直ちに行動を起こさなければならない
 372 .TP
 373 .B LOG_CRIT
 374 .\"O critical conditions
 375 危険な状態
 376 .TP
 377 .B LOG_ERR
 378 .\"O error conditions
 379 エラーの状態
 380 .TP
 381 .B LOG_WARNING
 382 .\"O warning conditions
 383 ワーニングの状態
 384 .TP
 385 .B LOG_NOTICE
 386 .\"O normal, but significant, condition
 387 通常だが重要な状態
 388 .TP
 389 .B LOG_INFO
 390 .\"O informational message
 391 インフォメーションメッセージ
 392 .TP
 393 .B LOG_DEBUG
 394 .\"O debug-level message
 395 デバッグレベルのメッセージ
 396 .LP
 397 .\"O The function
 398 .\"O .BR setlogmask (3)
 399 .\"O can be used to restrict logging to specified levels only.
 400 .BR setlogmask (3)
 401 関数を使用して、
 402 指定されたレベルのメッセージだけを記録するように
 403 制限することができる。
 404 .\"O .SH "CONFORMING TO"
 405 .SH 準拠
 406 .\"O The functions
 407 .\"O .BR openlog (),
 408 .\"O .BR closelog (),
 409 .\"O and
 410 .\"O .BR syslog ()
 411 .\"O (but not
 412 .\"O .BR vsyslog ())
 413 .\"O are specified in SUSv2 and POSIX.1-2001.
 414 .BR openlog (),
 415 .BR closelog (),
 416 .BR syslog ()
 417 は SUSv2 と POSIX.1-2001 で規定されている
 418 (但し
 419 .BR vsyslog ()
 420 は除く)。
 421 .\"O POSIX.1-2001 specifies only the
 422 .\"O .B LOG_USER
 423 .\"O and
 424 .\"O .B LOG_LOCAL*
 425 .\"O values for
 426 .\"O .IR facility .
 427 POSIX.1-2001 では
 428 .I facility
 429 として
 430 .B LOG_USER
 431 と
 432 .B LOG_LOCAL*
 433 の値が規定されているだけである。
 434 .\"O However, with the exception of
 435 .\"O .B LOG_AUTHPRIV
 436 .\"O and
 437 .\"O .BR LOG_FTP ,
 438 .\"O the other
 439 .\"O .I facility
 440 .\"O values appear on most UNIX systems.
 441 しかしながら、
 442 .B LOG_AUTHPRIV
 443 と
 444 .B LOG_FTP
 445 という例外はあるが、
 446 それ以外の
 447 .I facility
 448 の値は多くの UNIX システムで使われている。
 449 .\"O The
 450 .\"O .B LOG_PERROR
 451 .\"O value for
 452 .\"O .I option
 453 .\"O is not specified by POSIX.1-2001, but is available
 454 .\"O in most versions of UNIX.
 455 .I option
 456 の値の
 457 .B LOG_PERROR
 458 の値は、 POSIX.1-2001 では規定されていないが、
 459 UNIX の多くのバージョンで使用可能である。
 460 .\"O .\" .SH HISTORY
 461 .\" .SH 履歴
 462 .\"O .\" A
 463 .\"O .\" .BR syslog ()
 464 .\"O .\" function call appeared in 4.2BSD.
 465 .\" .BR syslog ()
 466 .\" ファンクション・コールは 4.2BSD から実装された。
 467 .\"O .\" 4.3BSD documents
 468 .\"O .\" .BR openlog (),
 469 .\"O .\" .BR syslog (),
 470 .\"O .\" .BR closelog (),
 471 .\"O .\" and
 472 .\"O .\" .BR setlogmask ().
 473 .\" 4.3BSD には
 474 .\" .BR openlog (),
 475 .\" .BR syslog (),
 476 .\" .BR closelog (),
 477 .\" .BR setlogmask ()
 478 .\" が実装されている。
 479 .\"O .\" 4.3BSD-Reno also documents
 480 .\"O .\" .BR vsyslog ().
 481 .\" また、4.3BSD-Reno には
 482 .\" .BR vsyslog ()
 483 .\" が実装されている。
 484 .\"O .\" Of course early v* functions used the
 485 .\"O .\" .I <varargs.h>
 486 .\"O .\" mechanism, which is not compatible with
 487 .\"O .\" .IR <stdarg.h> .
 488 .\" 当然ながら初期の v* 関数は
 489 .\" .I <stdarg.h>
 490 .\" とは互換性のない
 491 .\" .I <varargs.h>
 492 .\" の仕組を使用したものである。
 493 .\"O .SH NOTES
 494 .SH 注意
 495 .\"O The argument
 496 .\"O .I ident
 497 .\"O in the call of
 498 .\"O .BR openlog ()
 499 .\"O is probably stored as-is.
 500 .BR openlog ()
 501 呼び出しの
 502 .I ident
 503 引き数は、値がそのまま保持されていることを前提にしている。
 504 .\"O Thus, if the string it points to
 505 .\"O is changed,
 506 .\"O .BR syslog ()
 507 .\"O may start prepending the changed string, and if the string
 508 .\"O it points to ceases to exist, the results are undefined.
 509 それゆえ、
 510 .I ident
 511 で指定された文字列が変更されると、
 512 .BR syslog ()
 513 は変更された文字列の追加するだろうし、
 514 指定された文字列が存在しなくなった場合、結果は未定義である。
 515 .\"O Most portable is to use a string constant.
 516 最も移植性がある方法は、文字列定数を使用することである。
 517 .LP
 518 .\"O Never pass a string with user-supplied data as a format,
 519 .\"O use the following instead:
 520 ユーザーから与えられたデータを format として渡してはならない。
 521 代わりに以下を使うこと。
 522 .nf
 523
 524     syslog(priority, "%s", string);
 525 .fi
 526 .\"O .SH "SEE ALSO"
 527 .SH 関連項目
 528 .BR logger (1),
 529 .BR setlogmask (3),
 530 .BR syslog.conf (5),
 531 .BR syslogd (8)