xref: /netbsd-src/usr.sbin/syslogd/syslogd.8 (revision d9158b13b5dfe46201430699a3f7a235ecf28df3)
1.\" Copyright (c) 1983, 1986, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)syslogd.8	6.10 (Berkeley) 3/16/91
33.\"	$Id: syslogd.8,v 1.2 1993/08/01 07:23:26 mycroft Exp $
34.\"
35.Dd March 16, 1991
36.Dt SYSLOGD 8
37.Os BSD 4.2
38.Sh NAME
39.Nm syslogd
40.Nd log systems messages
41.Sh SYNOPSIS
42.Nm syslogd
43.Op Fl f Ar config_file
44.Op Fl m Ar mark_interval
45.Op Fl p Ar log_socket
46.Sh DESCRIPTION
47.Nm Syslogd
48reads and logs messages to the system console, log files, other
49machines and/or users as specified by its configuration file.
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl f
53Specify the pathname of an alternate configuration file;
54the default is
55.Pa /etc/syslog.conf .
56.It Fl m
57Select the number of minutes between ``mark'' messages;
58the default is 20 minutes.
59.It Fl p
60Specify the pathname of an alternate log socket;
61the default is
62.Pa /dev/log .
63.El
64.Pp
65.Nm Syslogd
66reads its configuration file when it starts up and whenever it
67receives a hangup signal.
68For information on the format of the configuration file,
69see
70.Xr syslog.conf 5 .
71.Pp
72.Nm Syslogd
73reads messages from the
74.Tn UNIX
75domain socket
76.Pa /dev/log ,
77from an Internet domain socket specified in
78.Pa /etc/services ,
79and from the special device
80.Pa /dev/klog
81(to read kernel messages).
82.Pp
83.Nm Syslogd
84creates the file
85.Pa /var/run/syslog.pid ,
86and stores its process
87id there.
88This can be used to kill or reconfigure
89.Nm syslogd .
90.Pp
91The message sent to
92.Nm syslogd
93should consist of a single line.
94The message can contain a priority code, which should be a preceding
95decimal number in angle braces, for example,
96.Sq Aq 5.
97This priority code should map into the priorities defined in the
98include file
99.Aq Pa sys/syslog.h .
100.Sh FILES
101.Bl -tag -width /var/run/syslog.pid -compact
102.It Pa /etc/syslog.conf
103The configuration file.
104.It Pa /var/run/syslog.pid
105The process id of current
106.Nm syslogd .
107.It Pa /dev/log
108Name of the
109.Tn UNIX
110domain datagram log socket.
111.It Pa /dev/klog
112The kernel log device.
113.El
114.Sh SEE ALSO
115.Xr logger 1 ,
116.Xr syslog 3 ,
117.Xr services 5 ,
118.Xr syslog.conf 5
119.Sh HISTORY
120The
121.Nm
122command appeared in
123.Bx 4.3 .
124