xref: /netbsd/usr.bin/logger/logger.1 (revision 6550d01e)
1.\"	$NetBSD: logger.1,v 1.12 2010/05/14 16:58:32 jruoho 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 May 14, 2010
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 is
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.Pp
55.Bl -tag -width "messageXX"
56.It Fl d Ar sd
57Log this in the structured data (SD) field.
58.Po
59.Ar sd
60has to be passed as one argument and will require careful quoting when used from
61the shell.
62.Pc
63.It Fl f Ar file
64Log the specified file.
65.It Fl i
66Log the process id of the logger process
67with each line.
68.It Fl m Ar msgid
69The MSGID used for the message.
70.It Fl p Ar pri
71Enter the message with the specified priority.
72The priority may be specified numerically or as a
73.Dq facility.level
74pair.
75For example,
76.Dq \-p local3.info
77logs the message(s) as
78.Ar info Ns rmational
79level in the
80.Ar local3
81facility.
82The default is
83.Dq user.notice .
84.It Fl s
85Log the message to standard error, as well as the system log.
86.It Fl t Ar tag
87Mark every line in the log with the specified
88.Ar tag  .
89.It Ar message
90Write the message to log; if not specified, and the
91.Fl f
92flag is not provided, standard input is logged.
93.El
94.Sh EXIT STATUS
95.Ex -std logger
96.Sh EXAMPLES
97.Bd -literal -offset indent -compact
98logger System rebooted
99
100logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
101.Ed
102.Sh SEE ALSO
103.Xr syslog 3 ,
104.Xr syslogd 8
105.Sh STANDARDS
106The
107.Nm
108utility conforms to
109.St -p1003.2-92 .
110