xref: /dragonfly/usr.bin/logger/logger.1 (revision ed5d5720)
1.\" Copyright (c) 1983, 1990, 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.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
33.\" $FreeBSD: src/usr.bin/logger/logger.1,v 1.4.2.8 2003/05/25 20:06:57 brueffer Exp $
34.\" $DragonFly: src/usr.bin/logger/logger.1,v 1.3 2006/02/17 19:39:09 swildner Exp $
35.\"
36.Dd June 6, 1993
37.Dt LOGGER 1
38.Os
39.Sh NAME
40.Nm logger
41.Nd make entries in the system log
42.Sh SYNOPSIS
43.Nm
44.Op Fl 46Ais
45.Op Fl f Ar file
46.Op Fl h Ar host
47.Op Fl p Ar pri
48.Op Fl t Ar tag
49.Op Ar message ...
50.Sh DESCRIPTION
51The
52.Nm
53utility provides a shell command interface to the
54.Xr syslog  3
55system log module.
56.Pp
57The following options are available:
58.Bl -tag -width indent
59.It Fl 4
60Force
61.Nm
62to use IPv4 addresses only.
63.It Fl 6
64Force
65.Nm
66to use IPv6 addresses only.
67.It Fl A
68By default,
69.Nm
70tries to send the message to only one address,
71even if the host has more than one A or AAAA record.
72If this option is specified,
73.Nm
74tries to send the message to all addresses.
75.It Fl i
76Log the process id of the logger process
77with each line.
78.It Fl s
79Log the message to standard error, as well as the system log.
80.It Fl f Ar file
81Log the specified file.
82.It Fl h Ar host
83Send the message to the remote system
84.Ar host
85instead of logging it locally.
86.It Fl p Ar pri
87Enter the message with the specified priority.
88The priority may be specified numerically or as a ``facility.level''
89pair.
90For example, ``\-p local3.info'' logs the message(s) as
91.Ar info Ns rmational
92level in the
93.Ar local3
94facility.
95The default is ``user.notice.''
96.It Fl t Ar tag
97Mark every line in the log with the specified
98.Ar tag  .
99.It Ar message
100Write the message to log; if not specified, and the
101.Fl f
102flag is not
103provided, standard input is logged.
104.El
105.Sh EXAMPLES
106.Bd -literal -offset indent -compact
107logger System rebooted
108
109logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
110.Ed
111.Sh DIAGNOSTICS
112.Ex -std
113.Sh SEE ALSO
114.Xr syslog 3 ,
115.Xr syslogd 8
116.Sh STANDARDS
117The
118.Nm
119command is expected to be
120.St -p1003.2
121compatible.
122