freebsd-skq/usr.bin/logger/logger.1

.\" Copyright (c) 1983, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)logger.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd March 4, 2014
.Dt LOGGER 1
.Os
.Sh NAME
.Nm logger
.Nd make entries in the system log
.Sh SYNOPSIS
.Nm
.Op Fl 46Ais
.Op Fl f Ar file
.Op Fl h Ar host
.Op Fl P Ar port
.Op Fl p Ar pri
.Op Fl t Ar tag
.Op Ar message ...
.Sh DESCRIPTION
The
.Nm
utility provides a shell command interface to the
.Xr syslog 3
system log module.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl 4
Force
.Nm
to use IPv4 addresses only.
.It Fl 6
Force
.Nm
to use IPv6 addresses only.
.It Fl A
By default,
.Nm
tries to send the message to only one address,
even if the host has more than one A or AAAA record.
If this option is specified,
.Nm
tries to send the message to all addresses.
.It Fl i
Log the process id of the logger process
with each line.
.It Fl s
Log the message to standard error, as well as the system log.
.It Fl f Ar file
Read the contents of the specified file into syslog.
.It Fl h Ar host
Send the message to the remote system
.Ar host
instead of logging it locally.
.It Fl P Ar port
Send the message to the specified
.Ar port
number on a remote system,
which can be specified as a service name
or as a decimal number.
The default is
.Dq Li syslog .
If an unknown service name is used,
.Nm
prints a warning and falls back to port 514.
.It Fl p Ar pri
Enter the message with the specified priority.
The priority may be specified numerically or as a ``facility.level''
pair.
For example, ``\-p local3.info'' logs the message(s) as
.Ar info Ns rmational
level in the
.Ar local3
facility.
The default is ``user.notice.''
.It Fl t Ar tag
Mark every line in the log with the specified
.Ar tag
rather than the default of current login name.
.It Ar message
Write the message to log; if not specified, and the
.Fl f
flag is not
provided, standard input is logged.
.El
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
.Bd -literal -offset indent -compact
logger System rebooted

logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
.Ed
.Sh SEE ALSO
.Xr syslog 3 ,
.Xr syslogd 8
.Sh STANDARDS
The
.Nm
command is expected to be
.St -p1003.2
compatible.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1983, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)logger.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
- Clarify usage of the -f option. Reviewed by: gjb@, dru@, and Allan Jude 2014-03-05 02:10:10 +00:00			`.Dd March 4, 2014`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt LOGGER 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm logger`
			`.Nd make entries in the system log`
			`.Sh SYNOPSIS`
Use err(3). 1997-07-22 07:33:48 +00:00			`.Nm`
mdoc(7) police: document IPv6 options in the SYNOPSIS. 2000-12-18 08:37:53 +00:00			`.Op Fl 46Ais`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl f Ar file`
Allow logger to send messages directly to a remote syslog. (This only does IPv4 as our syslogd only does IPv4. I dunno if the KAME people have any plans for syslogd). PR: 19821 Submitted by: Nick Hilliard <nick@iol.ie> Reviewed by: sheldonh 2000-07-18 08:56:54 +00:00			`.Op Fl h Ar host`
Add a new command-line option, -P, which allows the user to specify an arbitrary port to which syslog messages are to be sent. PR: bin/54026 Submitted by: Oliver Fromme MFC after: 10 days 2006-08-02 13:21:44 +00:00			`.Op Fl P Ar port`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl p Ar pri`
			`.Op Fl t Ar tag`
			`.Op Ar message ...`
			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility provides a shell command interface to the`
Deal with double whitespace. 2004-07-03 00:24:45 +00:00			`.Xr syslog 3`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`system log module.`
			`.Pp`
Add DIAGNOSTICS section name Options: -> The following options are available: 2000-03-26 14:39:03 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
IPv6 support for logger. Reviewed by: freebsd-current 2000-12-16 18:33:08 +00:00			`.It Fl 4`
.Nm is not required at the begining of this sentence. 2002-04-20 21:33:10 +00:00			`Force`
IPv6 support for logger. Reviewed by: freebsd-current 2000-12-16 18:33:08 +00:00			`.Nm`
			`to use IPv4 addresses only.`
			`.It Fl 6`
.Nm is not required at the begining of this sentence. 2002-04-20 21:33:10 +00:00			`Force`
IPv6 support for logger. Reviewed by: freebsd-current 2000-12-16 18:33:08 +00:00			`.Nm`
			`to use IPv6 addresses only.`
			`.It Fl A`
Clarify the describtion of the -A switch PR: 51187 Submitted by: Jeff Ito <jeffi@rcn.com> Approved by: re (jhb) MFC after: 3 days 2003-05-21 15:00:47 +00:00			`By default,`
			`.Nm`
			`tries to send the message to only one address,`
IPv6 support for logger. Reviewed by: freebsd-current 2000-12-16 18:33:08 +00:00			`even if the host has more than one A or AAAA record.`
			`If this option is specified,`
			`.Nm`
			`tries to send the message to all addresses.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl i`
			`Log the process id of the logger process`
			`with each line.`
			`.It Fl s`
			`Log the message to standard error, as well as the system log.`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.It Fl f Ar file`
- Clarify usage of the -f option. Reviewed by: gjb@, dru@, and Allan Jude 2014-03-05 02:10:10 +00:00			`Read the contents of the specified file into syslog.`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.It Fl h Ar host`
			`Send the message to the remote system`
Allow logger to send messages directly to a remote syslog. (This only does IPv4 as our syslogd only does IPv4. I dunno if the KAME people have any plans for syslogd). PR: 19821 Submitted by: Nick Hilliard <nick@iol.ie> Reviewed by: sheldonh 2000-07-18 08:56:54 +00:00			`.Ar host`
			`instead of logging it locally.`
Add a new command-line option, -P, which allows the user to specify an arbitrary port to which syslog messages are to be sent. PR: bin/54026 Submitted by: Oliver Fromme MFC after: 10 days 2006-08-02 13:21:44 +00:00			`.It Fl P Ar port`
			`Send the message to the specified`
			`.Ar port`
			`number on a remote system,`
			`which can be specified as a service name`
			`or as a decimal number.`
Markup fixes. 2006-09-29 15:20:48 +00:00			`The default is`
			`.Dq Li syslog .`
Add a new command-line option, -P, which allows the user to specify an arbitrary port to which syslog messages are to be sent. PR: bin/54026 Submitted by: Oliver Fromme MFC after: 10 days 2006-08-02 13:21:44 +00:00			`If an unknown service name is used,`
			`.Nm`
			`prints a warning and falls back to port 514.`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.It Fl p Ar pri`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Enter the message with the specified priority.`
			The priority may be specified numerically or as a ``facility.level''
			`pair.`
			For example, ``\-p local3.info'' logs the message(s) as
			`.Ar info Ns rmational`
			`level in the`
			`.Ar local3`
			`facility.`
			The default is ``user.notice.''
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.It Fl t Ar tag`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Mark every line in the log with the specified`
When specifying the -t option (send tag in front of message), this tag should also be forwarded to the remote logging host, not only when the logging is done locally. PR: bin/154324 Submitted by: Callum Gibson <callumgibson@optusnet.com.au> MFC after: 1 week 2011-04-08 12:33:07 +00:00			`.Ar tag`
			`rather than the default of current login name.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Ar message`
			`Write the message to log; if not specified, and the`
			`.Fl f`
			`flag is not`
			`provided, standard input is logged.`
			`.El`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh EXAMPLES`
			`.Bd -literal -offset indent -compact`
			`logger System rebooted`

			`logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc`
			`.Ed`
			`.Sh SEE ALSO`
			`.Xr syslog 3 ,`
			`.Xr syslogd 8`
			`.Sh STANDARDS`
			`The`
Use err(3). 1997-07-22 07:33:48 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command is expected to be`
			`.St -p1003.2`
			`compatible.`