2002-02-20 14:34:42 +03:00
|
|
|
.\" $NetBSD: ttymsg.3,v 1.8 2002/02/20 11:34:42 wiz Exp $
|
1997-06-29 22:44:03 +04:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
|
|
|
|
|
.\" 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 NetBSD
|
|
|
|
|
.\" Foundation, Inc. and its contributors.
|
|
|
|
|
.\" 4. Neither the name of The NetBSD Foundation 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 NETBSD FOUNDATION, INC. 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
|
1997-07-31 04:01:15 +04:00
|
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
|
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
1997-06-29 22:44:03 +04:00
|
|
|
.\" 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.
|
|
|
|
|
.\"
|
|
|
|
|
.Dd June 29, 1997
|
|
|
|
|
.Dt TTYMSG 3
|
1999-03-22 22:44:33 +03:00
|
|
|
.Os
|
1997-06-29 22:44:03 +04:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm ttymsg
|
|
|
|
|
.Nd ttymsg utility function
|
1998-02-05 21:45:17 +03:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libutil
|
1997-06-29 22:44:03 +04:00
|
|
|
.Sh SYNOPSIS
|
2002-02-07 10:00:09 +03:00
|
|
|
.Fd #include \*[Lt]util.h\*[Gt]
|
1997-06-29 22:44:03 +04:00
|
|
|
.Ft char *
|
1997-07-01 10:24:01 +04:00
|
|
|
.Fn ttymsg "struct iovec *iov" "int iovlen" "const char *tty" "int tmout"
|
1997-06-29 22:44:03 +04:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
1997-07-01 10:24:01 +04:00
|
|
|
.Fn ttymsg
|
1997-06-29 22:44:03 +04:00
|
|
|
function is used by
|
|
|
|
|
programs such as
|
|
|
|
|
.Xr talkd 8 ,
|
|
|
|
|
.Xr syslogd 8 ,
|
|
|
|
|
.Xr wall 1 ,
|
1997-07-01 10:24:01 +04:00
|
|
|
etc., to display the contents of a uio structure on a terminal.
|
|
|
|
|
.Fn ttymsg
|
|
|
|
|
forks and finishes in the child if the write would block after
|
|
|
|
|
waiting up to
|
|
|
|
|
.Fa tmout
|
|
|
|
|
seconds.
|
1997-06-29 22:44:03 +04:00
|
|
|
.Sh RETURN VALUES
|
1997-07-01 10:24:01 +04:00
|
|
|
.Fn ttymsg
|
|
|
|
|
returns a pointer to an error string on unexpected
|
|
|
|
|
error; the string is not newline-terminated. Various "normal" errors are
|
1997-06-29 22:44:03 +04:00
|
|
|
ignored (exclusive-use, lack of permission, etc.).
|
1997-07-01 10:24:01 +04:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr writev 2
|
