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 .Dd November 28, 2022
  29 .Dt TCSETPGRP 3
  30 .Os
  31 .Sh NAME
  32 .Nm tcsetpgrp
  33 .Nd set foreground process group ID
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In unistd.h
  38 .Ft int
  39 .Fn tcsetpgrp "int fd" "pid_t pgrp_id"
  40 .Sh DESCRIPTION
  41 If the process has a controlling terminal, the
  42 .Fn tcsetpgrp
  43 function sets the foreground process group ID associated with the
  44 terminal device to
  45 .Fa pgrp_id .
  46 The terminal device associated with
  47 .Fa fd
  48 must be the controlling terminal of the calling process and the
  49 controlling terminal must be currently associated with the session
  50 of the calling process.
  51 The value of
  52 .Fa pgrp_id
  53 must be the same as the process group ID of a process in the same
  54 session as the calling process.
  55 .Sh RETURN VALUES
  56 .Rv -std tcsetpgrp
  57 .Sh ERRORS
  58 The
  59 .Fn tcsetpgrp
  60 function will fail if:
  61 .Bl -tag -width Er
  62 .It Bq Er EBADF
  63 The
  64 .Fa fd
  65 argument is not a valid file descriptor.
  66 .It Bq Er EINVAL
  67 An invalid value of
  68 .Fa pgrp_id
  69 was specified.
  70 .It Bq Er ENOTTY
  71 The calling process does not have a controlling terminal, or the file
  72 represented by
  73 .Fa fd
  74 is not the controlling terminal, or the controlling terminal is no
  75 longer associated with the session of the calling process.
  76 .It Bq Er EPERM
  77 The
  78 .Fa pgrp_id
  79 argument does not match the process group ID of a process in the same
  80 session as the calling process.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr setpgid 2 ,
  84 .Xr setsid 2 ,
  85 .Xr tcgetpgrp 3
  86 .Sh STANDARDS
  87 The
  88 .Fn tcsetpgrp
  89 function is expected to be compliant with the
  90 .St -p1003.1-88
  91 specification.