The Open Group Base Specifications Issue 8
IEEE Std 1003.1-2024
Copyright © 2001-2024 The IEEE and The Open Group

NAME

tcsetpgrp — set the foreground process group ID

SYNOPSIS

#include <unistd.h>

int tcsetpgrp(int
fildes, pid_t pgid_id);

DESCRIPTION

If the process has a controlling terminal, tcsetpgrp() shall set the foreground process group ID associated with the terminal to pgid_id. The application shall ensure that the file associated with fildes is the controlling terminal of the calling process and the controlling terminal is currently associated with the session of the calling process. The application shall ensure that the value of pgid_id matches a process group ID of a process in the same session as the calling process.

Attempts to use tcsetpgrp() from a process which is a member of a background process group on a fildes associated with its controlling terminal shall cause the process group to be sent a SIGTTOU signal. If the calling thread is blocking SIGTTOU signals or the process is ignoring SIGTTOU signals, the process shall be allowed to perform the operation, and no signal is sent.

RETURN VALUE

Upon successful completion, 0 shall be returned. Otherwise, -1 shall be returned and errno set to indicate the error.

ERRORS

The tcsetpgrp() function shall fail if:

[EBADF]
The fildes argument is not a valid file descriptor.
[EINTR]
A signal interrupted tcsetpgrp().
[EINVAL]
This implementation does not support the value in the pgid_id argument.
[EIO]
The process group of the writing process is orphaned, the calling thread is not blocking SIGTTOU, and the process is not ignoring SIGTTOU.
[ENOTTY]
The calling process does not have a controlling terminal, or the file is not the controlling terminal, or the controlling terminal is no longer associated with the session of the calling process.
[EPERM]
The value of pgid_id is a value supported by the implementation, but does not match the process group ID of a process in the same session as the calling process.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

tcgetpgrp

XBD <sys/types.h>, <unistd.h>

CHANGE HISTORY

First released in Issue 3. Included for alignment with the POSIX.1-1988 standard.

Issue 6

In the SYNOPSIS, the inclusion of <sys/types.h> is no longer required.

The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:

The normative text is updated to avoid use of the term "must" for application requirements.

The Open Group Corrigendum U047/4 is applied.

Issue 7

POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0655 [79] and XSH/TC1-2008/0656 [79] are applied.

Issue 8

Austin Group Defect 1126 is applied, adding the [EINTR] error.

End of informative text.

 

return to top of page

UNIX® is a registered Trademark of The Open Group.
POSIX™ is a Trademark of The IEEE.
Copyright © 2001-2024 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]