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