xref: /freebsd/lib/libutil/login_tty.3 (revision 483f4c83716bc5db371e6fff01ac31b9d4323aa3)
1.\"
2.\" Copyright (c) 1996 Joerg Wunsch
3.\"
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $Id$
27.\" "
28.Dd December 29, 1996
29.Os
30.Dt LOGIN_TTY 3
31.Sh NAME
32.Nm login_tty
33.Nd prepare a tty for a new login session
34.Sh SYNOPSIS
35.Fd #include <libutil.h>
36.Ft int
37.Fn login_tty "int fd"
38.Pp
39Link with
40.Va -lutil
41on the
42.Xr cc 1
43command line.
44.Sh DESCRIPTION
45The function
46.Nm login_tty
47prepares a terminal for a new login session.  The filedescriptor
48.Ar fd
49passed to
50.Nm login_tty
51must be opened for reading and writing on a terminal device.  It will be
52made the controlling terminal for the calling process, after allocating
53a new session with
54.Xr setsid 2 .
55This terminal device will also be made the standard input, standard output,
56and standard error output of the calling process.
57.Sh RETURN VALUES
58.Nm Login_tty
59returns -1 if it could not make the device referenced by
60.Ar fd
61the controlling terminal of the calling process, and 0 otherwise.
62.Sh SEE ALSO
63.Xr dup2 2 ,
64.Xr ioctl 2 ,
65.Xr setsid 2 ,
66.Xr tty 4
67