1.\" $NetBSD: ttymsg.3,v 1.4 1997/07/31 00:02:54 jtc Exp $ 2.\" 3.\" Copyright (c) 1996 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the NetBSD 17.\" Foundation, Inc. and its contributors. 18.\" 4. Neither the name of The NetBSD Foundation nor the names of its 19.\" contributors may be used to endorse or promote products derived 20.\" from this software without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32.\" POSSIBILITY OF SUCH DAMAGE. 33.\" 34.Dd June 29, 1997 35.Dt TTYMSG 3 36.Os NetBSD 1.3 37.Sh NAME 38.Nm ttymsg 39.Nd ttymsg utility function 40.Sh SYNOPSIS 41.Fd #include <util.h> 42.Ft char * 43.Fn ttymsg "struct iovec *iov" "int iovlen" "const char *tty" "int tmout" 44.Sh DESCRIPTION 45The 46.Fn ttymsg 47function is used by 48programs such as 49.Xr talkd 8 , 50.Xr syslogd 8 , 51.Xr wall 1 , 52etc., to display the contents of a uio structure on a terminal. 53.Fn ttymsg 54forks and finishes in the child if the write would block after 55waiting up to 56.Fa tmout 57seconds. 58.Sh RETURN VALUES 59.Fn ttymsg 60returns a pointer to an error string on unexpected 61error; the string is not newline-terminated. Various "normal" errors are 62ignored (exclusive-use, lack of permission, etc.). 63.Sh SEE ALSO 64.Xr writev 2 65 66