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.9 2001/10/01 16:08:51 ru Exp $
  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 LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fo tcsetpgrp
  47 .Fa "int fildes"
  48 .Fa "pid_t pgid_id"
  49 .Fc
  50 .Sh DESCRIPTION
  51 If the process has a controlling terminal, the
  52 .Fn tcsetpgrp
  53 function sets the foreground process group ID associated with the
  54 terminal device to
  55 .Fa pgid_id .
  56 The terminal device associated with
  57 .Fa fildes
  58 must be the controlling terminal of the calling process and the
  59 controlling terminal must be currently associated with the session
  60 of the calling process.
  61 The value of
  62 .Fa pgid_id
  63 must be the same as the process group ID of a process in the same
  64 session as the calling process.
  65 .Sh RETURN VALUES
  66 .Rv -std tcsetpgrp
  67 .Sh ERRORS
  68 The
  69 .Fn tcsetpgrp
  70 function will fail if:
  71 .Bl -tag -width Er
  72 .It Bq Er EBADF
  73 The
  74 .Fa fildes
  75 argument is not a valid file descriptor.
  76 .It Bq Er EINVAL
  77 An invalid value of
  78 .Fa pgid_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 fildes
  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 pgid_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 LEGACY SYNOPSIS
  93 .Fd #include <sys/types.h>
  94 .Fd #include <unistd.h>
  95 .Pp
  96 The include file
  97 .In sys/types.h
  98 is necessary.
  99 .Sh SEE ALSO
 100 .Xr setpgid 2 ,
 101 .Xr setsid 2 ,
 102 .Xr tcgetpgrp 3 ,
 103 .Xr compat 5
 104 .Sh STANDARDS
 105 The
 106 .Fn tcsetpgrp
 107 function is expected to be compliant with the
 108 .St -p1003.1-88
 109 specification.