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