lib/libutil/login_tty.3

   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 .\" $FreeBSD: head/lib/libutil/login_tty.3 206622 2010-04-14 19:08:06Z uqs $
  27 .\" "
  28 .Dd December 29, 1996
  29 .Dt LOGIN_TTY 3
  30 .Os
  31 .Sh NAME
  32 .Nm login_tty
  33 .Nd prepare a tty for a new login session
  34 .Sh LIBRARY
  35 .Lb libutil
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In libutil.h
  39 .Ft int
  40 .Fn login_tty "int fd"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn login_tty
  44 prepares a terminal for a new login session.
  45 The file descriptor
  46 .Ar fd
  47 passed to
  48 .Fn login_tty
  49 must be opened for reading and writing on a terminal device.
  50 It will be
  51 made the controlling terminal for the calling process, after allocating
  52 a new session with
  53 .Xr setsid 2 .
  54 This terminal device will also be made the standard input, standard output,
  55 and standard error output of the calling process.
  56 .Sh RETURN VALUES
  57 The
  58 .Fn login_tty
  59 function returns -1 if it could not make the device referenced by
  60 .Ar fd
  61 the 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