Go to main content

man pages section 2: System Calls

Exit Print View

Updated: Thursday, June 13, 2019
 
 

setpgid(2)

Name

setpgid - set process group ID

Synopsis

#include <sys/types.h>
#include <unistd.h>

int setpgid(pid_t pid, pid_t pgid);

Description

The setpgid() function sets the process group ID of the process with ID pid to pgid.

If pgid is equal to pid, the process becomes a process group leader. See Intro(2) for more information on session leaders and process group leaders.

If pgid is not equal to pid, the process becomes a member of an existing process group.

If pid is equal to 0, the process ID of the calling process is used. If pgid is equal to 0, the process specified by pid becomes a process group leader.

Return Values

Upon successful completion, 0 is returned. Otherwise, −1 is returned and errno is set to indicate the error.

Errors

The setpgid() function will fail if:

EACCES

The pid argument matches the process ID of a child process of the calling process and the child process has successfully executed one of the exec family of functions (see exec(2)).

EINVAL

The pgid argument is less than (pid_t) 0 or greater than or equal to PID_MAX, or the calling process has a controlling terminal that does not support job control.

EPERM

The process indicated by the pid argument is a session leader.

EPERM

The pid argument matches the process ID of a child process of the calling process and the child process is not in the same session as the calling process.

EPERM

The pgid argument does not match the process ID of the process indicated by the pid argument, and there is no process with a process group ID that matches pgid in the same session as the calling process.

ESRCH

The pid argument does not match the process ID of the calling process or of a child process of the calling process.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Async-Signal-Safe
Standard

See Also

exec(2), exit(2), fork(2), getpid(2), getsid(2), Intro(2), attributes(7), standards(7)