bc89b58def
Reviewed by: bcr (mentor) Approved by: bcr (mentor) MFC after: 7 days Differential Revision: https://reviews.freebsd.org/D24795
72 lines
2.3 KiB
Groff
72 lines
2.3 KiB
Groff
.\"
|
|
.\" Copyright (c) 1996 Joerg Wunsch
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\" "
|
|
.Dd May 10, 2020
|
|
.Dt LOGIN_TTY 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm login_tty
|
|
.Nd prepare a tty for a new login session
|
|
.Sh LIBRARY
|
|
.Lb libutil
|
|
.Sh SYNOPSIS
|
|
.In libutil.h
|
|
.Ft int
|
|
.Fn login_tty "int fd"
|
|
.Sh DESCRIPTION
|
|
The function
|
|
.Fn login_tty
|
|
prepares a terminal for a new login session.
|
|
The file descriptor
|
|
.Ar fd
|
|
passed to
|
|
.Fn login_tty
|
|
must be opened for reading and writing on a terminal device.
|
|
It will be
|
|
made the controlling terminal for the calling process, after allocating
|
|
a new session with
|
|
.Xr setsid 2 .
|
|
This terminal device will also be made the standard input, standard output,
|
|
and standard error output of the calling process.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn login_tty
|
|
function returns -1 if it could not make the device referenced by
|
|
.Ar fd
|
|
the controlling terminal of the calling process, and 0 otherwise.
|
|
.Sh SEE ALSO
|
|
.Xr dup2 2 ,
|
|
.Xr ioctl 2 ,
|
|
.Xr setsid 2 ,
|
|
.Xr tty 4
|
|
.Sh HISTORY
|
|
The function
|
|
.Fn login_tty
|
|
first appeared in
|
|
.Bx 4.4 .
|
|
|