xref: /netbsd-src/usr.bin/logger/logger.1 (revision 9d478d44f6a7e048964ebcf9362bcc98ccee69e6)
1.\"	$NetBSD: logger.1,v 1.17 2020/06/26 15:46:28 wiz Exp $
2.\"
3.\" Copyright (c) 1983, 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
31.\"
32.Dd June 25, 2020
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 cins
41.Op Fl d Ar SD
42.Op Fl f Ar file
43.Op Fl m Ar msgid
44.Op Fl p Ar pri
45.Op Fl t Ar tag
46.Op Ar message ...
47.Sh DESCRIPTION
48.Nm
49provides a shell command interface to the
50.Xr syslog 3
51system log module.
52.Pp
53Options:
54.Bl -tag -width "messageXX"
55.It Fl c
56Log to console as a fallback
57.Dv ( LOG_CONS ) :
58if the message cannot be passed to
59.Xr syslogd 8 ,
60the message is written to
61.Pa /dev/console .
62.It Fl d Ar sd
63Log this in the structured data (SD) field.
64.Po
65.Ar sd
66has to be passed as one argument and will require careful quoting when used from
67the shell.
68.Pc
69.It Fl f Ar file
70Log the specified file.
71.It Fl i
72Log the process id of the logger process
73with each line
74.Dv ( LOG_PID ) .
75.It Fl m Ar msgid
76The MSGID used for the message.
77.It Fl n
78Open log file immediately
79.Dv ( LOG_NDELAY ) .
80.It Fl p Ar pri
81Enter the message with the specified priority.
82The priority may be specified numerically or as a
83.Dq facility.level
84pair.
85For example,
86.Dq \-p local3.info
87logs the message(s) as
88.Ar info Ns rmational
89level in the
90.Ar local3
91facility.
92The default is
93.Dq user.notice .
94.It Fl s
95Log the message to standard error, as well as the system log
96.Dv ( LOG_PERROR ) .
97.It Fl t Ar tag
98Mark every line in the log with the specified
99.Ar tag  .
100.It Ar message
101Write the message to log; if not specified, and the
102.Fl f
103flag is not provided, standard input is logged.
104.El
105.Sh EXIT STATUS
106.Ex -std logger
107.Sh EXAMPLES
108.Bd -literal -offset indent -compact
109logger System rebooted
110
111logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
112.Ed
113.Sh SEE ALSO
114.Xr syslog 3 ,
115.Xr syslogd 8
116.Sh STANDARDS
117The
118.Nm
119utility conforms to
120.St -p1003.2-92 .
121