lib/libc/gen/tcsetsid.3

   1 .\" Copyright (c) 2009 Ed Schouten <ed@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: head/lib/libc/gen/tcsetsid.3 191882 2009-05-07 13:49:48Z ed $
  26 .\"
  27 .Dd May 5, 2018
  28 .Dt TCSETSID 3
  29 .Os
  30 .Sh NAME
  31 .Nm tcsetsid
  32 .Nd set session ID associated with a controlling terminal
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In termios.h
  38 .Ft int
  39 .Fn tcsetsid "int fd" "pid_t pid"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn tcsetsid
  43 function sets associates a session identified by
  44 .Fa pid
  45 with a controlling terminal specified by
  46 .Fa fd .
  47 .Pp
  48 This implementation only allows the controlling terminal to be changed
  49 by the session leader itself.
  50 This implies that
  51 .Fa pid
  52 always has to be equal to the process ID.
  53 .Pp
  54 It is unsupported to associate with a terminal that already has an
  55 associated session.
  56 Conversely, it is also unsupported to associate to a terminal when
  57 the session is already associated with a different terminal.
  58 .Sh ERRORS
  59 If an error occurs,
  60 .Fn tcsetsid
  61 returns -1 and the global variable
  62 .Va errno
  63 is set to indicate the error, as follows:
  64 .Bl -tag -width Er
  65 .It Bq Er EBADF
  66 The
  67 .Fa fd
  68 argument is not a valid file descriptor.
  69 .It Bq Er ENOTTY
  70 The file descriptor represented by
  71 .Fa fd
  72 is not a terminal.
  73 .It Bq Er EINVAL
  74 The
  75 .Fa pid
  76 argument is not equal to the session ID of the calling process.
  77 .It Bq Er EPERM
  78 The calling process is not a session leader.
  79 .It Bq Er EPERM
  80 The session already has an associated terminal or the terminal already
  81 has an associated session.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr getsid 2 ,
  85 .Xr setsid 2 ,
  86 .Xr tcgetpgrp 3 ,
  87 .Xr tcgetsid 3
  88 .Sh HISTORY
  89 A
  90 .Fn tcsetsid
  91 function first appeared in QNX.
  92 It does not comply to any standard.