xref: /freebsd/usr.bin/logger/logger.1 (revision 66fd12cf4896eb08ad8e7a2627537f84ead84dd3)
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 July 3, 2023
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.
77See also
78.Fl t .
79.It Fl s
80Log the message to standard error, as well as the system log.
81.It Fl f Ar file
82Read the contents of the specified file into syslog.
83This option is ignored when a message is also specified.
84.It Fl H Ar hostname
85Set the hostname in the header of the message to specified value.
86If not specified, host part of
87.Xr gethostname 3
88will be used.
89.It Fl h Ar host
90Send the message to the remote system
91.Ar host
92instead of logging it locally.
93Note that
94.Nm
95currently supports
96.Li AF_INET
97.Pq IPv4 ,
98.Li AF_INET6
99.Pq IPv6 ,
100and
101.Li AF_LOCAL
102.Pq Unix-domain socket
103address families.
104The following address formats are valid in
105.Ar host :
106.Pp
107.Bl -tag -width "AF_LOCAL" -compact
108.It Li AF_INET
109192.168.2.1
110.It Li AF_INET6
1112001:db8::1
112.It Li AF_LOCAL
113.Pa /var/run/log
114.El
115.It Fl P Ar port
116Send the message to the specified
117.Ar port
118number on a remote system,
119which can be specified as a service name
120or as a decimal number.
121The default is
122.Dq Li syslog .
123If an unknown service name is used,
124.Nm
125prints a warning and falls back to port 514.
126.It Fl p Ar pri
127Enter the message with the specified priority.
128The priority may be specified numerically or as a
129.Li facility.level
130pair.
131For example,
132.Dq Fl p Li local3.info
133logs the message(s) as
134.Ar info Ns rmational
135level in the
136.Ar local3
137facility.
138The default is
139.Dq Li user.notice .
140.It Fl S Ar addr Ns \&: Ns Ar port
141Specify source address and/or source port when using
142.Fl h
143option.
144The same address will be used for all of the remote addresses
145when
146.Fl A
147flag is enabled.
148Note that a numeric IPv6 address in
149.Ar addr
150must be enclosed with
151.Dq \&[
152and
153.Dq \&] .
154.It Fl t Ar tag
155Mark every line in the log with the specified
156.Ar tag
157rather than the default of current login name.
158Use
159.Fl t Ar tag[N]
160to insert specific decimal process id instead of id of
161.Nm .
162.It Ar message
163Write the message to log; if not specified, and the
164.Fl f
165flag is not
166provided, standard input is logged.
167.El
168.Sh EXIT STATUS
169.Ex -std
170.Sh EXAMPLES
171.Bd -literal -offset indent -compact
172logger System rebooted
173
174logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
175.Ed
176.Sh SEE ALSO
177.Xr syslog 3 ,
178.Xr syslogd 8
179.Sh STANDARDS
180The
181.Nm
182command is expected to be
183.St -p1003.2
184compatible.
185