xref: /freebsd/usr.bin/logger/logger.1 (revision faf25f48d601ae39f5752602f3020e2e92605625)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD$
30.\"
31.Dd March 16, 2022
32.Dt LOGGER 1
33.Os
34.Sh NAME
35.Nm logger
36.Nd make entries in the system log
37.Sh SYNOPSIS
38.Nm
39.Op Fl 46Ais
40.Op Fl f Ar file
41.Op Fl H Ar hostname
42.Op Fl h Ar host
43.Op Fl P Ar port
44.Op Fl p Ar pri
45.Op Fl S Ar addr Ns \&: Ns Ar port
46.Op Fl t Ar tag
47.Op Ar message ...
48.Sh DESCRIPTION
49The
50.Nm
51utility provides a shell command interface to the
52.Xr syslog 3
53system log module.
54.Pp
55The following options are available:
56.Bl -tag -width indent
57.It Fl 4
58Force
59.Nm
60to use IPv4 addresses only.
61.It Fl 6
62Force
63.Nm
64to use IPv6 addresses only.
65.It Fl A
66By default,
67.Nm
68tries to send the message to only one address,
69even if the host has more than one A or AAAA record.
70If this option is specified,
71.Nm
72tries to send the message to all addresses.
73.It Fl i
74Log the process id of the logger process
75with each line.
76This flag is ignored and the process id is always logged.
77.It Fl s
78Log the message to standard error, as well as the system log.
79.It Fl f Ar file
80Read the contents of the specified file into syslog.
81This option is ignored when a message is also specified.
82.It Fl H Ar hostname
83Set the hostname in the header of the message to specified value.
84If not specified, host part of
85.Xr gethostname 3
86will be used.
87.It Fl h Ar host
88Send the message to the remote system
89.Ar host
90instead of logging it locally.
91Note that
92.Nm
93currently supports
94.Li AF_INET
95.Pq IPv4 ,
96.Li AF_INET6
97.Pq IPv6 ,
98and
99.Li AF_LOCAL
100.Pq Unix-domain socket
101address families.
102The following address formats are valid in
103.Ar host :
104.Pp
105.Bl -tag -width "AF_LOCAL" -compact
106.It Li AF_INET
107192.168.2.1
108.It Li AF_INET6
1092001:db8::1
110.It Li AF_LOCAL
111.Pa /var/run/log
112.El
113.It Fl P Ar port
114Send the message to the specified
115.Ar port
116number on a remote system,
117which can be specified as a service name
118or as a decimal number.
119The default is
120.Dq Li syslog .
121If an unknown service name is used,
122.Nm
123prints a warning and falls back to port 514.
124.It Fl p Ar pri
125Enter the message with the specified priority.
126The priority may be specified numerically or as a
127.Li facility.level
128pair.
129For example,
130.Dq Fl p Li local3.info
131logs the message(s) as
132.Ar info Ns rmational
133level in the
134.Ar local3
135facility.
136The default is
137.Dq Li user.notice .
138.It Fl S Ar addr Ns \&: Ns Ar port
139Specify source address and/or source port when using
140.Fl h
141option.
142The same address will be used for all of the remote addresses
143when
144.Fl A
145flag is enabled.
146Note that a numeric IPv6 address in
147.Ar addr
148must be enclosed with
149.Dq \&[
150and
151.Dq \&] .
152.It Fl t Ar tag
153Mark every line in the log with the specified
154.Ar tag
155rather than the default of current login name.
156.It Ar message
157Write the message to log; if not specified, and the
158.Fl f
159flag is not
160provided, standard input is logged.
161.El
162.Sh EXIT STATUS
163.Ex -std
164.Sh EXAMPLES
165.Bd -literal -offset indent -compact
166logger System rebooted
167
168logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
169.Ed
170.Sh SEE ALSO
171.Xr syslog 3 ,
172.Xr syslogd 8
173.Sh STANDARDS
174The
175.Nm
176command is expected to be
177.St -p1003.2
178compatible.
179