usr/src/man/man2/setsid.2

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH SETSID 2 "Aug 21, 2002"
  13 .SH NAME
  14 setsid \- create session and set process group ID
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sys/types.h>
  19 #include <unistd.h>
  20
  21 \fBpid_t\fR \fBsetsid\fR(\fBvoid\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBsetsid()\fR function creates a new session, if the calling process is
  28 not a process group leader. Upon return the calling process will be the session
  29 leader of this new session, will be the process group leader of a new process
  30 group, and will have no controlling terminal. The process group  \fBID\fR of
  31 the calling process will be set equal to the process \fBID\fR of the calling
  32 process. The calling process will be the only process in the new process group
  33 and the only process in the new session.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 Upon successful completion, \fBsetsid()\fR returns the value of the process
  38 group  \fBID\fR of the calling process. Otherwise it returns \fB(pid_t)\(mi1\fR
  39 and sets \fBerrno\fR to indicate the error.
  40 .SH ERRORS
  41 .sp
  42 .LP
  43 The \fBsetsid()\fR function will fail if:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBEPERM\fR\fR
  48 .ad
  49 .RS 9n
  50 The calling process is already a process group leader, or the process group
  51 \fBID\fR of a process other than the calling process matches the process
  52 \fBID\fR of the calling process.
  53 .RE
  54
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Standard
  69 _
  70 MT-Level        Async-Signal-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBgetsid\fR(2), \fBsetpgid\fR(2), \fBsetpgrp\fR(2), \fBattributes\fR(5),
  77 \fBstandards\fR(5)
  78 .SH WARNINGS
  79 .sp
  80 .LP
  81 A call to \fBsetsid()\fR by a process that is a process group leader will fail.
  82 A process can become a process group leader by being the last member of a
  83 pipeline started by a job control shell. Thus, a process that expects to be
  84 part of a pipeline, and that calls \fBsetsid()\fR, should always first fork;
  85 the parent should exit and the child should call \fBsetsid()\fR. This will
  86 ensure that the calling process will work reliably when started by both job
  87 control shells and non-job control shells.