xref: /freebsd/usr.bin/logger/logger.1 (revision 05c7a37afb48ddd5ee1bd921a5d46fe59cc70b15)
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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
33.\"
34.Dd June 6, 1993
35.Dt LOGGER 1
36.Os BSD 4.3
37.Sh NAME
38.Nm logger
39.Nd make entries in the system log
40.Sh SYNOPSIS
41.Nm logger
42.Op Fl is
43.Op Fl f Ar file
44.Op Fl p Ar pri
45.Op Fl t Ar tag
46.Op Ar message ...
47.Sh DESCRIPTION
48.Nm Logger
49provides a shell command interface to the
50.Xr syslog  3
51system log module.
52.Pp
53Options:
54.Pp
55.Bl -tag -width "message"
56.It Fl i
57Log the process id of the logger process
58with each line.
59.It Fl s
60Log the message to standard error, as well as the system log.
61.It Fl f Ar file
62Log the specified file.
63.It Fl p Ar pri
64Enter the message with the specified priority.
65The priority may be specified numerically or as a ``facility.level''
66pair.
67For example, ``\-p local3.info'' logs the message(s) as
68.Ar info Ns rmational
69level in the
70.Ar local3
71facility.
72The default is ``user.notice.''
73.It Fl t Ar tag
74Mark every line in the log with the specified
75.Ar tag  .
76.It Ar message
77Write the message to log; if not specified, and the
78.Fl f
79flag is not
80provided, standard input is logged.
81.El
82.Pp
83The
84.Nm logger
85utility exits 0 on success, and >0 if an error occurs.
86.Sh EXAMPLES
87.Bd -literal -offset indent -compact
88logger System rebooted
89
90logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
91.Ed
92.Sh SEE ALSO
93.Xr syslog 3 ,
94.Xr syslogd 8
95.Sh STANDARDS
96The
97.Nm logger
98command is expected to be
99.St -p1003.2
100compatible.
101