home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / bsd_srcs / lib / libc / gen / tcsetpgrp.3 < prev    next >
Encoding:
Text File  |  1992-03-28  |  3.4 KB  |  101 lines
  1. .\" Copyright (c) 1991 The Regents of the University of California.
  2. .\" 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    5.3 (Berkeley) 3/29/92
  33. .\"
  34. .Dd "March 29, 1992"
  35. .Dt TCSETPGRP
  36. .Os
  37. .Sh NAME
  38. .Nm tcsetpgrp
  39. .Nd set foreground process group ID
  40. .Sh SYNOPSIS
  41. .Fd #include <sys/types.h>
  42. .Fd #include <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. .Nm 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. .Pp
  61. Upon successful completion,
  62. .Nm tcsetpgrp
  63. returns a value of zero.
  64. .Sh ERRORS
  65. If an error occurs,
  66. .Nm tcgetpgrp
  67. returns -1 and the global variable
  68. .Va errno
  69. is set to indicate the error, as follows:
  70. .Bl -tag -width Er
  71. .It Bq Er EBADF
  72. The
  73. .Fa fd
  74. argument is not a valid file descriptor.
  75. .It Bq Er EINVAL
  76. An invalid value of
  77. .Fa pgrp_id
  78. was specified.
  79. .It Bq Er ENOTTY
  80. The calling process does not have a controlling terminal, or the file
  81. represented by
  82. .Fa fd
  83. is not the controlling terminal, or the controlling terminal is no
  84. longer associated with the session of the calling process.
  85. .It Bq Er EPERM
  86. The
  87. .Fa pgrp_id
  88. argument does not match the process group ID of a process in the same
  89. session as the calling process.
  90. .El
  91. .Sh SEE ALSO
  92. .Xr setpgid 3 ,
  93. .Xr setsid 2 ,
  94. .Xr tcgetpgrp 3
  95. .Sh STANDARDS
  96. The
  97. .Nm tcsetpgprp
  98. function is expected to be compliant with the
  99. .St -p1003.1-88
  100. specification.
  101.