xref: /freebsd/usr.bin/logger/logger.1 (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
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 March 4, 2014
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 t Ar tag
45.Op Ar message ...
46.Sh DESCRIPTION
47The
48.Nm
49utility provides a shell command interface to the
50.Xr syslog 3
51system log module.
52.Pp
53The following options are available:
54.Bl -tag -width indent
55.It Fl 4
56Force
57.Nm
58to use IPv4 addresses only.
59.It Fl 6
60Force
61.Nm
62to use IPv6 addresses only.
63.It Fl A
64By default,
65.Nm
66tries to send the message to only one address,
67even if the host has more than one A or AAAA record.
68If this option is specified,
69.Nm
70tries to send the message to all addresses.
71.It Fl i
72Log the process id of the logger process
73with each line.
74.It Fl s
75Log the message to standard error, as well as the system log.
76.It Fl f Ar file
77Read the contents of the specified file into syslog.
78.It Fl h Ar host
79Send the message to the remote system
80.Ar host
81instead of logging it locally.
82.It Fl P Ar port
83Send the message to the specified
84.Ar port
85number on a remote system,
86which can be specified as a service name
87or as a decimal number.
88The default is
89.Dq Li syslog .
90If an unknown service name is used,
91.Nm
92prints a warning and falls back to port 514.
93.It Fl p Ar pri
94Enter the message with the specified priority.
95The priority may be specified numerically or as a ``facility.level''
96pair.
97For example, ``\-p local3.info'' logs the message(s) as
98.Ar info Ns rmational
99level in the
100.Ar local3
101facility.
102The default is ``user.notice.''
103.It Fl t Ar tag
104Mark every line in the log with the specified
105.Ar tag
106rather than the default of current login name.
107.It Ar message
108Write the message to log; if not specified, and the
109.Fl f
110flag is not
111provided, standard input is logged.
112.El
113.Sh EXIT STATUS
114.Ex -std
115.Sh EXAMPLES
116.Bd -literal -offset indent -compact
117logger System rebooted
118
119logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
120.Ed
121.Sh SEE ALSO
122.Xr syslog 3 ,
123.Xr syslogd 8
124.Sh STANDARDS
125The
126.Nm
127command is expected to be
128.St -p1003.2
129compatible.
130