xref: /freebsd/usr.sbin/syslogd/syslogd.8 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" Copyright (c) 1983, 1986, 1991, 1993
2.\"	The Regents of the University of California.  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.\"     @(#)syslogd.8	8.1 (Berkeley) 6/6/93
33.\"	$Id: syslogd.8,v 1.3 1996/05/20 17:10:03 wollman Exp $
34.\"
35.Dd October 12, 1995
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 \&dI
44.Op Fl f Ar config_file
45.Op Fl m Ar mark_interval
46.Op Fl p Ar log_socket
47.Sh DESCRIPTION
48.Nm Syslogd
49reads and logs messages to the system console, log files, other
50machines and/or users as specified by its configuration file.
51The options are as follows:
52.Bl -tag -width Ds
53.It Fl d
54Put
55.Nm syslogd
56into debugging mode.  This is probably only of use to developers working on
57.Nm syslogd .
58.It Fl f
59Specify the pathname of an alternate configuration file;
60the default is
61.Pa /etc/syslog.conf .
62.It Fl s
63Operate in secure mode.  Do not open a UDP socket to listen for log message
64from remote machines.
65.It Fl m
66Select the number of minutes between ``mark'' messages;
67the default is 20 minutes.
68.It Fl p
69Specify the pathname of an alternate log socket;
70the default is
71.Pa /dev/log .
72.El
73.Pp
74.Nm Syslogd
75reads its configuration file when it starts up and whenever it
76receives a hangup signal.
77For information on the format of the configuration file,
78see
79.Xr syslog.conf 5 .
80.Pp
81.Nm Syslogd
82reads messages from the
83.Tn UNIX
84domain socket
85.Pa /dev/log ,
86from an Internet domain socket specified in
87.Pa /etc/services ,
88and from the special device
89.Pa /dev/klog
90(to read kernel messages).
91.Pp
92.Nm Syslogd
93creates the file
94.Pa /var/run/syslog.pid ,
95and stores its process
96id there.
97This can be used to kill or reconfigure
98.Nm syslogd .
99.Pp
100The message sent to
101.Nm syslogd
102should consist of a single line.
103The message can contain a priority code, which should be a preceding
104decimal number in angle braces, for example,
105.Sq Aq 5.
106This priority code should map into the priorities defined in the
107include file
108.Aq Pa sys/syslog.h .
109.Sh FILES
110.Bl -tag -width /var/run/syslog.pid -compact
111.It Pa /etc/syslog.conf
112The configuration file.
113.It Pa /var/run/syslog.pid
114The process id of current
115.Nm syslogd .
116.It Pa /dev/log
117Name of the
118.Tn UNIX
119domain datagram log socket.
120.It Pa /dev/klog
121The kernel log device.
122.El
123.Sh SEE ALSO
124.Xr logger 1 ,
125.Xr syslog 3 ,
126.Xr services 5 ,
127.Xr syslog.conf 5
128.Sh HISTORY
129The
130.Nm
131command appeared in
132.Bx 4.3 .
133.Sh BUGS
134The ability to log messages received in UDP packets is equivalent to
135an unauthenticated remote disk-filling service, and should probably be
136disabled by default.  Some sort of
137.No inter- Ns Nm syslogd
138authentication mechanism ought to be worked out.
139
140