lib/libc/sys/setsid.2

   1 .\"     $NetBSD: setsid.2,v 1.15 2011/04/04 08:00:53 jruoho Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)setsid.2    8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd April 4, 2011
  33 .Dt SETSID 2
  34 .Os
  35 .Sh NAME
  36 .Nm setsid
  37 .Nd create session and set process group ID
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft pid_t
  43 .Fn setsid "void"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn setsid
  47 function creates a new session.
  48 The calling process is the session leader of the new session, is the
  49 process group leader of a new process group and has no controlling
  50 terminal.
  51 The calling process is the only process in either the session or the
  52 process group.
  53 .Pp
  54 Upon successful completion, the
  55 .Fn setsid
  56 function returns the value of the process group ID of the new process
  57 group, which is the same as the process ID of the calling process.
  58 .Sh ERRORS
  59 If an error occurs,
  60 .Fn setsid
  61 returns \-1 and the global variable
  62 .Va errno
  63 is set to indicate the error, as follows:
  64 .Bl -tag -width Er
  65 .It Bq Er EPERM
  66 The calling process is already a process group leader, or the process
  67 group ID of a process other than the calling process matches the process
  68 ID of the calling process.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr getsid 2 ,
  72 .Xr setpgid 2 ,
  73 .Xr tcgetpgrp 3 ,
  74 .Xr tcsetpgrp 3
  75 .Sh STANDARDS
  76 The
  77 .Fn setsid
  78 function conforms to
  79 .St -p1003.1-90 .