lib/libc/gen/tcgetsid.3

   1 .\" Copyright (c) 2008 David Xu <davidxu@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: src/lib/libc/gen/tcgetsid.3,v 1.1 2008/04/15 08:33:32 davidxu Exp $
  26 .\"
  27 .Dd April 15, 2008
  28 .Dt TCGETSID 3
  29 .Os
  30 .Sh NAME
  31 .Nm tcgetsid
  32 .Nd get 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 pid_t
  39 .Fn tcgetsid "int fd"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn tcgetsid
  43 function returns the process group ID of the session leader for a
  44 controlling terminal specified by
  45 .Fa fd .
  46 .Sh ERRORS
  47 If an error occurs,
  48 .Fn tcgetsid
  49 returns -1 and the global variable
  50 .Va errno
  51 is set to indicate the error, as follows:
  52 .Bl -tag -width Er
  53 .It Bq Er EBADF
  54 The
  55 .Fa fd
  56 argument is not a valid file descriptor.
  57 .It Bq Er ENOTTY
  58 The calling process does not have a controlling terminal or the
  59 underlying terminal device represented by
  60 .Fa fd
  61 is not the controlling terminal.
  62 .El
  63 .Sh SEE ALSO
  64 .Xr getsid 2 ,
  65 .Xr setsid 2 ,
  66 .Xr tcgetpgrp 3
  67 .Sh STANDARDS
  68 The
  69 .Fn tcgetsid
  70 function conforms to
  71 .St -xpg4.2 .