lib/libc/gen/tcsetpgrp.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)tcsetpgrp.3 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/tcsetpgrp.3,v 1.6.2.3 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/tcsetpgrp.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt TCSETPGRP 3
  38 .Os
  39 .Sh NAME
  40 .Nm tcsetpgrp
  41 .Nd set foreground process group ID
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In unistd.h
  47 .Ft int
  48 .Fn tcsetpgrp "int fd" "pid_t pgrp_id"
  49 .Sh DESCRIPTION
  50 If the process has a controlling terminal, the
  51 .Fn tcsetpgrp
  52 function sets the foreground process group ID associated with the
  53 terminal device to
  54 .Fa pgrp_id .
  55 The terminal device associated with
  56 .Fa fd
  57 must be the controlling terminal of the calling process and the
  58 controlling terminal must be currently associated with the session
  59 of the calling process.
  60 The value of
  61 .Fa pgrp_id
  62 must be the same as the process group ID of a process in the same
  63 session as the calling process.
  64 .Sh RETURN VALUES
  65 .Rv -std tcsetpgrp
  66 .Sh ERRORS
  67 The
  68 .Fn tcsetpgrp
  69 function will fail if:
  70 .Bl -tag -width Er
  71 .It Bq Er EBADF
  72 The
  73 .Fa fd
  74 argument is not a valid file descriptor.
  75 .It Bq Er EINVAL
  76 An invalid value of
  77 .Fa pgrp_id
  78 was specified.
  79 .It Bq Er ENOTTY
  80 The calling process does not have a controlling terminal, or the file
  81 represented by
  82 .Fa fd
  83 is not the controlling terminal, or the controlling terminal is no
  84 longer associated with the session of the calling process.
  85 .It Bq Er EPERM
  86 The
  87 .Fa pgrp_id
  88 argument does not match the process group ID of a process in the same
  89 session as the calling process.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr setpgid 2 ,
  93 .Xr setsid 2 ,
  94 .Xr tcgetpgrp 3
  95 .Sh STANDARDS
  96 The
  97 .Fn tcsetpgrp
  98 function is expected to be compliant with the
  99 .St -p1003.1-88
 100 specification.