xref: /freebsd/usr.bin/logger/logger.1 (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
33.\" $FreeBSD$
34.\"
35.Dd August 2, 2006
36.Dt LOGGER 1
37.Os
38.Sh NAME
39.Nm logger
40.Nd make entries in the system log
41.Sh SYNOPSIS
42.Nm
43.Op Fl 46Ais
44.Op Fl f Ar file
45.Op Fl h Ar host
46.Op Fl P Ar port
47.Op Fl p Ar pri
48.Op Fl t Ar tag
49.Op Ar message ...
50.Sh DESCRIPTION
51The
52.Nm
53utility provides a shell command interface to the
54.Xr syslog 3
55system log module.
56.Pp
57The following options are available:
58.Bl -tag -width indent
59.It Fl 4
60Force
61.Nm
62to use IPv4 addresses only.
63.It Fl 6
64Force
65.Nm
66to use IPv6 addresses only.
67.It Fl A
68By default,
69.Nm
70tries to send the message to only one address,
71even if the host has more than one A or AAAA record.
72If this option is specified,
73.Nm
74tries to send the message to all addresses.
75.It Fl i
76Log the process id of the logger process
77with each line.
78.It Fl s
79Log the message to standard error, as well as the system log.
80.It Fl f Ar file
81Log the specified file.
82.It Fl h Ar host
83Send the message to the remote system
84.Ar host
85instead of logging it locally.
86.It Fl P Ar port
87Send the message to the specified
88.Ar port
89number on a remote system,
90which can be specified as a service name
91or as a decimal number.
92The default is
93.Dq Li syslog .
94If an unknown service name is used,
95.Nm
96prints a warning and falls back to port 514.
97.It Fl p Ar pri
98Enter the message with the specified priority.
99The priority may be specified numerically or as a ``facility.level''
100pair.
101For example, ``\-p local3.info'' logs the message(s) as
102.Ar info Ns rmational
103level in the
104.Ar local3
105facility.
106The default is ``user.notice.''
107.It Fl t Ar tag
108Mark every line in the log with the specified
109.Ar tag .
110.It Ar message
111Write the message to log; if not specified, and the
112.Fl f
113flag is not
114provided, standard input is logged.
115.El
116.Sh EXIT STATUS
117.Ex -std
118.Sh EXAMPLES
119.Bd -literal -offset indent -compact
120logger System rebooted
121
122logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
123.Ed
124.Sh SEE ALSO
125.Xr syslog 3 ,
126.Xr syslogd 8
127.Sh STANDARDS
128The
129.Nm
130command is expected to be
131.St -p1003.2
132compatible.
133