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 .\"     $Id$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt TCSETPGRP 3
  37 .Os
  38 .Sh NAME
  39 .Nm tcsetpgrp
  40 .Nd set foreground process group ID
  41 .Sh SYNOPSIS
  42 .Fd #include <sys/types.h>
  43 .Fd #include <unistd.h>
  44 .Ft int
  45 .Fn tcsetpgrp "int fd" "pid_t pgrp_id"
  46 .Sh DESCRIPTION
  47 If the process has a controlling terminal, the
  48 .Nm tcsetpgrp
  49 function sets the foreground process group ID associated with the
  50 terminal device to
  51 .Fa pgrp_id .
  52 The terminal device associated with
  53 .Fa fd
  54 must be the controlling terminal of the calling process and the
  55 controlling terminal must be currently associated with the session
  56 of the calling process.
  57 The value of
  58 .Fa pgrp_id
  59 must be the same as the process group ID of a process in the same
  60 session as the calling process.
  61 .Pp
  62 Upon successful completion,
  63 .Nm tcsetpgrp
  64 returns a value of zero.
  65 .Sh ERRORS
  66 If an error occurs,
  67 .Nm tcsetpgrp
  68 returns -1 and the global variable
  69 .Va errno
  70 is set to indicate the error, as follows:
  71 .Bl -tag -width Er
  72 .It Bq Er EBADF
  73 The
  74 .Fa fd
  75 argument is not a valid file descriptor.
  76 .It Bq Er EINVAL
  77 An invalid value of
  78 .Fa pgrp_id
  79 was specified.
  80 .It Bq Er ENOTTY
  81 The calling process does not have a controlling terminal, or the file
  82 represented by
  83 .Fa fd
  84 is not the controlling terminal, or the controlling terminal is no
  85 longer associated with the session of the calling process.
  86 .It Bq Er EPERM
  87 The
  88 .Fa pgrp_id
  89 argument does not match the process group ID of a process in the same
  90 session as the calling process.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr setpgid 2 ,
  94 .Xr setsid 2 ,
  95 .Xr tcgetpgrp 3
  96 .Sh STANDARDS
  97 The
  98 .Nm tcsetpgprp
  99 function is expected to be compliant with the
 100 .St -p1003.1-88
 101 specification.