xref: /openbsd-src/usr.bin/logger/logger.1 (revision 3507c921a74fd97669f8086327e1a3192060e0ae)
1.\"	$OpenBSD: logger.1,v 1.22 2019/06/17 00:23:03 guenther Exp $
2.\"	$NetBSD: logger.1,v 1.4 1994/12/22 06:26:59 jtc Exp $
3.\"
4.\" Copyright (c) 1983, 1990, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
32.\"
33.Dd $Mdocdate: June 17 2019 $
34.Dt LOGGER 1
35.Os
36.Sh NAME
37.Nm logger
38.Nd make entries in the system log
39.Sh SYNOPSIS
40.Nm logger
41.Op Fl cis
42.Op Fl f Ar file
43.Op Fl p Ar pri
44.Op Fl t Ar tag
45.Op Ar message ...
46.Sh DESCRIPTION
47The
48.Nm logger
49utility provides a shell command interface to the
50.Xr syslog 3
51system log module.
52.Pp
53The options are as follows:
54.Bl -tag -width "-f file"
55.It Fl c
56If unable to pass the message to
57.Xr syslogd 8 ,
58attempt to write the message to the console.
59.It Fl f Ar file
60Read from the specified
61.Ar file .
62.It Fl i
63Log the process ID of the logger process
64with each line.
65.It Fl p Ar pri
66Enter the message with the specified priority.
67The priority may be specified numerically or as a
68.Dq facility.level
69pair.
70For example,
71.Dq -p local3.info
72logs the message(s) as
73.Ar info Ns rmational
74level in the
75.Ar local3
76facility.
77The default is
78.Dq user.notice .
79.It Fl s
80Log the message to standard error, as well as the system log.
81.It Fl t Ar tag
82Mark every line in the log with the specified
83.Ar tag .
84.It Ar message
85Write the message to log; if not specified, and the
86.Fl f
87flag is not
88provided, standard input is logged.
89.El
90.Sh EXIT STATUS
91.Ex -std logger
92.Sh EXAMPLES
93.Bd -literal -offset indent
94$ logger System rebooted
95
96$ logger -p local0.notice -t HOSTIDM -f /dev/idmc
97.Ed
98.Sh SEE ALSO
99.Xr syslog 3 ,
100.Xr syslogd 8
101.Sh STANDARDS
102The
103.Nm
104utility is compliant with the
105.St -p1003.1-2008
106specification.
107.Pp
108The flags
109.Op Fl cfipst
110are extensions to that specification.
111