[unix-history] / usr.sbin / syslogd / syslogd.8

.\" Copyright (c) 1983, 1986, 1991 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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	6.10 (Berkeley) 3/16/91
.\"
.Dd March 16, 1991
.Dt SYSLOGD 8
.Os BSD 4.2
.Sh NAME
.Nm syslogd
.Nd log systems messages
.Sh SYNOPSIS
.Nm syslogd
.Op Fl f Ar config_file
.Op Fl m Ar mark_interval
.Op Fl p Ar log_socket
.Sh DESCRIPTION
.Nm Syslogd
reads and logs messages to the system console, log files, other
machines and/or users as specified by its configuration file.
The options are as follows:
.Bl -tag -width Ds
.It Fl f
Specify the pathname of an alternate configuration file;
the default is
.Pa /etc/syslog.conf .
.It Fl m
Select the number of minutes between ``mark'' messages;
the default is 20 minutes.
.It Fl p
Specify the pathname of an alternate log socket;
the default is
.Pa /dev/log .
.El
.Pp
.Nm Syslogd
reads its configuration file when it starts up and whenever it
receives a hangup signal.
For information on the format of the configuration file,
see
.Xr syslog.conf 5 .
.Pp
.Nm Syslogd
reads messages from the
.Tn UNIX
domain socket
.Pa /dev/log ,
from an Internet domain socket specified in
.Pa /etc/services ,
and from the special device
.Pa /dev/klog
(to read kernel messages).
.Pp
.Nm Syslogd
creates the file
.Pa /var/run/syslog.pid ,
and stores its process
id there.
This can be used to kill or reconfigure
.Nm syslogd .
.Pp
The message sent to
.Nm syslogd
should consist of a single line.
The message can contain a priority code, which should be a preceding
decimal number in angle braces, for example,
.Sq Aq 5.
This priority code should map into the priorities defined in the
include file
.Aq Pa sys/syslog.h .
.Sh FILES
.Bl -tag -width /var/run/syslog.pid -compact
.It Pa /etc/syslog.conf
The configuration file.
.It Pa /var/run/syslog.pid
The process id of current
.Nm syslogd .
.It Pa /dev/log
Name of the
.Tn UNIX
domain datagram log socket.
.It Pa /dev/klog
The kernel log device.
.El
.Sh SEE ALSO
.Xr logger 1 ,
.Xr syslog 3 ,
.Xr services 5 ,
.Xr syslog.conf 5
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
Commit	Line	Data
15637ed4 RG	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	.\" @(#)syslogd.8 6.10 (Berkeley) 3/16/91
	33	.\"
	34	.Dd March 16, 1991
	35	.Dt SYSLOGD 8
	36	.Os BSD 4.2
	37	.Sh NAME
	38	.Nm syslogd
	39	.Nd log systems messages
	40	.Sh SYNOPSIS
	41	.Nm syslogd
	42	.Op Fl f Ar config_file
	43	.Op Fl m Ar mark_interval
	44	.Op Fl p Ar log_socket
	45	.Sh DESCRIPTION
	46	.Nm Syslogd
	47	reads and logs messages to the system console, log files, other
	48	machines and/or users as specified by its configuration file.
	49	The options are as follows:
	50	.Bl -tag -width Ds
	51	.It Fl f
	52	Specify the pathname of an alternate configuration file;
	53	the default is
	54	.Pa /etc/syslog.conf .
	55	.It Fl m
	56	Select the number of minutes between ``mark'' messages;
	57	the default is 20 minutes.
	58	.It Fl p
	59	Specify the pathname of an alternate log socket;
	60	the default is
	61	.Pa /dev/log .
	62	.El
	63	.Pp
	64	.Nm Syslogd
65	reads its configuration file when it starts up and whenever it
66	receives a hangup signal.
67	For information on the format of the configuration file,
68	see
69	.Xr syslog.conf 5 .
70	.Pp
71	.Nm Syslogd
72	reads messages from the
73	.Tn UNIX
74	domain socket
75	.Pa /dev/log ,
76	from an Internet domain socket specified in
77	.Pa /etc/services ,
78	and from the special device
79	.Pa /dev/klog
80	(to read kernel messages).
81	.Pp
82	.Nm Syslogd
83	creates the file
84	.Pa /var/run/syslog.pid ,
85	and stores its process
86	id there.
87	This can be used to kill or reconfigure
88	.Nm syslogd .
89	.Pp
90	The message sent to
91	.Nm syslogd
92	should consist of a single line.
93	The message can contain a priority code, which should be a preceding
94	decimal number in angle braces, for example,
95	.Sq Aq 5.
96	This priority code should map into the priorities defined in the
97	include file
98	.Aq Pa sys/syslog.h .
99	.Sh FILES
100	.Bl -tag -width /var/run/syslog.pid -compact
101	.It Pa /etc/syslog.conf
102	The configuration file.
103	.It Pa /var/run/syslog.pid
104	The process id of current
105	.Nm syslogd .
106	.It Pa /dev/log
107	Name of the
108	.Tn UNIX
109	domain datagram log socket.
110	.It Pa /dev/klog
111	The kernel log device.
112	.El
113	.Sh SEE ALSO
114	.Xr logger 1 ,
115	.Xr syslog 3 ,
116	.Xr services 5 ,
117	.Xr syslog.conf 5
118	.Sh HISTORY
119	The
120	.Nm
121	command appeared in
122	.Bx 4.3 .