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