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