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