.\" Copyright (c) 1983, 1986, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)syslogd.8	8.1 (Berkeley) 6/6/93
.\" %FreeBSD: src/usr.sbin/syslogd/syslogd.8,v 1.52 2004/08/07 04:28:55 imp Exp %
.\"
.\" $FreeBSD$
.\"
.Dd November 24, 2001
.Dt SYSLOGD 8
.Os
.Sh 名称
.Nm syslogd
.Nd システムメッセージの記録をとる
.Sh 書式
.Nm
.Op Fl 46Acdknosuv
.Op Fl a Ar allowed_peer
.Op Fl b Ar bind_address
.Op Fl f Ar config_file
.Op Fl l Ar path
.Op Fl m Ar mark_interval
.Op Fl P Ar pid_file
.Op Fl l Ar path
.Op Fl p Ar log_socket
.Sh 解説
.Nm
ユーティリティは設定ファイルに指定された通りに、システムコンソール、
ログファイル、他のマシンやユーザへのメッセージを読み込み、記録します。
.Pp
オプションには以下のものがあります。
.Bl -tag -width indent
.It Fl 4
.Nm
が IPv4 アドレスのみを使用するよう、強制します。
.It Fl 6
.Nm
が IPv6 アドレスのみを使用するよう、強制します。
.It Fl A
ホストが複数の A または AAAA レコードを持っている場合でも、
通常
.Nm
はメッセージを単一のアドレスにのみ送信しようとします。
本オプションが指定されると、
.Nm
はメッセージをすべてのアドレスに送信しようとします。
.It Fl a Ar allowed_peer
.Ar allowed_peer
がこの
.Nm
に UDP データグラムを使用してログすることを許します。
複数の
.Fl a
オプションを指定可能です。
.Pp
.Ar allowed_peer
は以下のいずれかです:
.Bl -tag -width "ipaddr/masklen[:service]XX"
.It Xo
.Sm off
.Ar ipaddr
.No / Ar masklen
.Op : Ar service
.Sm on
.Xc
.Ar ipaddr
(通常のドット表記の 4 つ組)
からのデータグラムを受け付けます。
アドレス比較の際、
.Ar masklen
ビットを考慮します。
アドレスを
.Ql \&[
と
.Ql \&]
で括ることで、
.Ar ipaddr
に IPv6 アドレスを指定可能です。
.Ar service
が指定された場合、パケット送出元が属すべき
UDP service の名前もしくは番号となります
.Pf ( Xr services 5
参照)。
.Ar service
に
.Ql \&*
を指定すると、全ての UDP ポートから送信されたパケットを受け付けます。
デフォルトの
.Ar service
は
.Ql syslog
です。
.Ar ipaddr
が IPv4 アドレスの場合で
.Ar masklen
を指定しないと、
.Ar ipaddr
がクラス A もしくは B のアドレス範囲に属す場合にはそれぞれ
歴史的なクラス A もしくは B のネットマスクが使用され、
そうでない場合には 24 が使用されます。
.Ar ipaddr
が IPv6 アドレスの場合で
.Ar masklen
を指定しないと、
.Ar masklen
は 128 が用いられます。
.It Xo
.Sm off
.Ar domainname Op : Ar service
.Sm on
.Xc
送信アドレスのアドレス逆引きにおいて
.Ar domainname
が得られたデータグラムを受け付けます。
.Ar service
の意味は前述の通りです。
.It Xo
.Sm off
.No * Ar domainname Op : Ar service
.Sm on
.Xc
上述の通りですが、送信ホスト名が
.Ar domainname
で
.Em 終る
全てのホストから受け付けます。
.El
.Pp
.Fl s
が指定された場合には、
.Fl a
オプションは無視されます。
.It Fl b Ar bind_address
バインド対象となる IP アドレスまたはホスト名を、1 個指定します。
ホスト名が指定された場合、これに対応する
IPv4 または IPv6 のアドレスが使用されます。
.It Fl c
出力が他のプログラムへのパイプの場合、同じ行の繰り返しを
.Dq Li "last message repeated N times"
という形式の単一行に圧縮することを無効化します。
2 回指定すると、すべての場合においてこの圧縮を無効化します。
.It Fl d
.Nm
をデバッグモードで実行します。
これは恐らく、
.Nm
の開発者にのみ役立ちます。
.It Fl f
代りの設定ファイルのパス名を指定します。
デフォルトは
.Pa /etc/syslog.conf
です。
.It Fl k
ファシリティ
.Dq kern
で受信したメッセージをファシリティ
.Dq user
へ変換することを、止めます。
通常は、
.Dq kern
ファシリティは、直接
.Pa /dev/klog
から読み込むメッセージ用に予約されています。
.It Fl m
.Dq mark
されたメッセージの間隔を分単位で指定します。
デフォルトは 20 分です。
.It Fl n
すべての要求に対し、DNS への問い合わせを抑止します。
.It Fl o
カーネルメッセージの前に、
.Xr getbootfile 3
で判定される完全なカーネルブートファイルを付けます。
これを指定しないと、カーネルメッセージのプレフィックスは常に
.Dq Li kernel:
になります。
.It Fl p
代りに使用するログ用ソケットのパス名を指定します。
デフォルトは
.Pa /var/run/log
です。
.It Fl P
プロセス ID を格納するための別のファイルを指定します。
デフォルトは
.Pa /var/run/syslog.pid
です。
.It Fl l
.Nm
が追加のログ用ソケットを置く場所を指定します。
19 個まで追加のログ用ソケットを指定可能です。
主な用法は、
様々に chroot したファイル空間において追加のログ用ソケットを
.Pa /var/run/log
に置くというものです。
.It Fl s
セキュアモードで操作します。
リモートマシンからのログメッセージをログしません。
2 度指定すると、ネットワークソケットを全くオープンせず、
またリモートマシンへのログ動作も無効にします。
.It Fl u
ただ 1 つの優先度のログのみ行います。
指定した優先度のメッセージのみログします。
このオプションを指定しないと、指定した優先度以上のメッセージがログされます。
このオプションにより、デフォルトの比較を
.Dq =>
から
.Dq =
に変更します。
.It Fl v
冗長なログを行います。
1 度指定すると、ローカルに書き込まれたメッセージと共に、
ファシリティと優先度が数値でログされます。
複数回指定すると、ローカルに書き込まれたメッセージと共に、
ファシリティと優先度が名前でログされます。
.El
.Pp
.Nm
ユーティリティは
起動時と hangup シグナルを受けとった時はいつでも設定ファイルを
読み込みます。
設定ファイルのフォーマットに関する情報は、
.Xr syslog.conf 5
参照して下さい。
.Pp
.Nm
ユーティリティは
.Ux
ドメインソケット
.Pa /var/run/log、
.Pa /etc/services
で指定されるインターネットドメインソケット
および特殊デバイス
.Pa /dev/klog
(カーネルメッセージを読むため) からメッセージを読み込みます。
.Pp
.Nm
ユーティリティはプロセス ID ファイル、デフォルトでは
.Pa /var/run/syslog.pid
を作成し、ここにプロセス ID を記録します。
これは
.Nm
を kill や、設定ファイルを読み込ませるために使えます。
.Pp
.Nm
に送られるメッセージは単一の行で構成されます。このメッセージは先頭に
優先順位コードを含んでいます。このコードは
.Sq Aq 5
のように括弧でくくられた 10 進数から構成されており、インクルードファイル
.In sys/syslog.h
で定義されている優先順位に対応します。
.Pp
セキュリティ上の理由から、
.Nm
は存在しないログファイルへ追加書き込みしません。
.Nm
の起動前に手動で作成する必要があります。
.Sh 関連ファイル
.Bl -tag -width /var/run/syslog.pid -compact
.It Pa /etc/syslog.conf
コンフィギュレーションファイル
.It Pa /var/run/syslog.pid
デフォルトのプロセス ID ファイル
.It Pa /var/run/log
.Ux
ドメインデータグラムのログ用ソケットの名前
.It Pa /dev/klog
カーネルログ用のデバイス
.El
.Sh 関連項目
.Xr logger 1 ,
.Xr syslog 3 ,
.Xr services 5 ,
.Xr syslog.conf 5
.Sh 歴史
.Nm
ユーティリティは
.Bx 4.3
から登場しました。
.Pp
.Fl a ,
.Fl s ,
.Fl u ,
.Fl v
のオプションは
.Fx 2.2
における拡張です。
.Sh バグ
UDP パケットで受けとったメッセージを記録する能力は認証されていない
ディスクを溢れさせるリモートサービスと等価であり、恐らくデフォルトで無効に
されるべきです。
ある種の
.Nm
間の認証メカニズムが用意されるべきでしょう。
最悪の無駄遣いを避けるために、
.Fl a
オプションの使用を強く勧めます。
.Pp
.Fl a
のマッチングアルゴリズムは非常に効率的には見えません;
ドメイン名比較より、数値による IP アドレスを使用する方が高速です。
許可されたピアのリストの検索は線型に行なわれるため、
多くのメッセージを受け付けると予測されるピアグループは
.Fl a
リストの最初の方に置くべきです。
.Pp
ログ用ソケットは読み込み専用のルートファイルシステムの扱いを容易にする
ために
.Pa /dev
から移されました。このことは古いバイナリを混乱させるかもしれないので、
過渡期の間はシンボリックリンクが役に立つでしょう。