xref: /dragonfly/usr.bin/logger/logger.1 (revision c37c9ab3)
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: src/usr.bin/logger/logger.1,v 1.4.2.8 2003/05/25 20:06:57 brueffer Exp $
30.\"
31.Dd June 6, 1993
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 pri
43.Op Fl t Ar tag
44.Op Ar message ...
45.Sh DESCRIPTION
46The
47.Nm
48utility provides a shell command interface to the
49.Xr syslog 3
50system log module.
51.Pp
52The following options are available:
53.Bl -tag -width indent
54.It Fl 4
55Force
56.Nm
57to use IPv4 addresses only.
58.It Fl 6
59Force
60.Nm
61to use IPv6 addresses only.
62.It Fl A
63By default,
64.Nm
65tries to send the message to only one address,
66even if the host has more than one A or AAAA record.
67If this option is specified,
68.Nm
69tries to send the message to all addresses.
70.It Fl i
71Log the process id of the logger process
72with each line.
73.It Fl s
74Log the message to standard error, as well as the system log.
75.It Fl f Ar file
76Log the specified file.
77.It Fl h Ar host
78Send the message to the remote system
79.Ar host
80instead of logging it locally.
81.It Fl p Ar pri
82Enter the message with the specified priority.
83The priority may be specified numerically or as a ``facility.level''
84pair.
85For example, ``\-p local3.info'' logs the message(s) as
86.Ar info Ns rmational
87level in the
88.Ar local3
89facility.
90The default is ``user.notice.''
91.It Fl t Ar tag
92Mark every line in the log with the specified
93.Ar tag .
94.It Ar message
95Write the message to log; if not specified, and the
96.Fl f
97flag is not
98provided, standard input is logged.
99.El
100.Sh EXIT STATUS
101.Ex -std
102.Sh EXAMPLES
103.Bd -literal -offset indent -compact
104logger System rebooted
105
106logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
107.Ed
108.Sh SEE ALSO
109.Xr syslog 3 ,
110.Xr syslogd 8
111.Sh STANDARDS
112The
113.Nm
114command is expected to be
115.St -p1003.2
116compatible.
117