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