xref: /freebsd/usr.bin/logger/logger.1 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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.\" $FreeBSD$
34.\"
35.Dd June 6, 1993
36.Dt LOGGER 1
37.Os BSD 4.3
38.Sh NAME
39.Nm logger
40.Nd make entries in the system log
41.Sh SYNOPSIS
42.Nm
43.Op Fl is
44.Op Fl f Ar file
45.Op Fl p Ar pri
46.Op Fl t Ar tag
47.Op Ar message ...
48.Sh DESCRIPTION
49.Nm Logger
50provides a shell command interface to the
51.Xr syslog  3
52system log module.
53.Pp
54Options:
55.Pp
56.Bl -tag -width "message"
57.It Fl i
58Log the process id of the logger process
59with each line.
60.It Fl s
61Log the message to standard error, as well as the system log.
62.It Fl f Ar file
63Log the specified file.
64.It Fl p Ar pri
65Enter the message with the specified priority.
66The priority may be specified numerically or as a ``facility.level''
67pair.
68For example, ``\-p local3.info'' logs the message(s) as
69.Ar info Ns rmational
70level in the
71.Ar local3
72facility.
73The default is ``user.notice.''
74.It Fl t Ar tag
75Mark every line in the log with the specified
76.Ar tag  .
77.It Ar message
78Write the message to log; if not specified, and the
79.Fl f
80flag is not
81provided, standard input is logged.
82.El
83.Pp
84The
85.Nm
86utility exits 0 on success, and >0 if an error occurs.
87.Sh EXAMPLES
88.Bd -literal -offset indent -compact
89logger System rebooted
90
91logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
92.Ed
93.Sh SEE ALSO
94.Xr syslog 3 ,
95.Xr syslogd 8
96.Sh STANDARDS
97The
98.Nm
99command is expected to be
100.St -p1003.2
101compatible.
102