xref: /freebsd/usr.bin/logger/logger.1 (revision 1da7f3f6f72b2245e458fc7195733268ae4a1136)
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.Dd July 3, 2023
29.Dt LOGGER 1
30.Os
31.Sh NAME
32.Nm logger
33.Nd make entries in the system log
34.Sh SYNOPSIS
35.Nm
36.Op Fl 46Ais
37.Op Fl f Ar file
38.Op Fl H Ar hostname
39.Op Fl h Ar host
40.Op Fl P Ar port
41.Op Fl p Ar pri
42.Op Fl S Ar addr Ns \&: Ns Ar port
43.Op Fl t Ar tag
44.Op Ar message ...
45.Sh DESCRIPTION
46The
47.Nm
48utility provides a shell command interface to the
49.Xr syslog 3
50system log module.
51.Pp
52The following options are available:
53.Bl -tag -width indent
54.It Fl 4
55Force
56.Nm
57to use IPv4 addresses only.
58.It Fl 6
59Force
60.Nm
61to use IPv6 addresses only.
62.It Fl A
63By default,
64.Nm
65tries to send the message to only one address,
66even if the host has more than one A or AAAA record.
67If this option is specified,
68.Nm
69tries to send the message to all addresses.
70.It Fl i
71Log the process id of the logger process
72with each line.
73This flag is ignored and the process id is always logged.
74See also
75.Fl t .
76.It Fl s
77Log the message to standard error, as well as the system log.
78.It Fl f Ar file
79Read the contents of the specified file into syslog.
80This option is ignored when a message is also specified.
81.It Fl H Ar hostname
82Set the hostname in the header of the message to specified value.
83If not specified, host part of
84.Xr gethostname 3
85will be used.
86.It Fl h Ar host
87Send the message to the remote system
88.Ar host
89instead of logging it locally.
90Note that
91.Nm
92currently supports
93.Li AF_INET
94.Pq IPv4 ,
95.Li AF_INET6
96.Pq IPv6 ,
97and
98.Li AF_LOCAL
99.Pq Unix-domain socket
100address families.
101The following address formats are valid in
102.Ar host :
103.Pp
104.Bl -tag -width "AF_LOCAL" -compact
105.It Li AF_INET
106192.168.2.1
107.It Li AF_INET6
1082001:db8::1
109.It Li AF_LOCAL
110.Pa /var/run/log
111.El
112.It Fl P Ar port
113Send the message to the specified
114.Ar port
115number on a remote system,
116which can be specified as a service name
117or as a decimal number.
118The default is
119.Dq Li syslog .
120If an unknown service name is used,
121.Nm
122prints a warning and falls back to port 514.
123.It Fl p Ar pri
124Enter the message with the specified priority.
125The priority may be specified numerically or as a
126.Li facility.level
127pair.
128For example,
129.Dq Fl p Li local3.info
130logs the message(s) as
131.Ar info Ns rmational
132level in the
133.Ar local3
134facility.
135The default is
136.Dq Li user.notice .
137.It Fl S Ar addr Ns \&: Ns Ar port
138Specify source address and/or source port when using
139.Fl h
140option.
141The same address will be used for all of the remote addresses
142when
143.Fl A
144flag is enabled.
145Note that a numeric IPv6 address in
146.Ar addr
147must be enclosed with
148.Dq \&[
149and
150.Dq \&] .
151.It Fl t Ar tag
152Mark every line in the log with the specified
153.Ar tag
154rather than the default of current login name.
155Use
156.Fl t Ar tag[N]
157to insert specific decimal process id instead of id of
158.Nm .
159.It Ar message
160Write the message to log; if not specified, and the
161.Fl f
162flag is not
163provided, standard input is logged.
164.El
165.Sh EXIT STATUS
166.Ex -std
167.Sh EXAMPLES
168.Bd -literal -offset indent -compact
169logger System rebooted
170
171logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
172.Ed
173.Sh SEE ALSO
174.Xr syslog 3 ,
175.Xr syslogd 8
176.Sh STANDARDS
177The
178.Nm
179command is expected to be
180.St -p1003.2
181compatible.
182