[apple/network_cmds.git] / logger.tproj / logger.1

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