lib/libc/sys/setsid.2

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)setsid.2    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt SETSID 2
  33 .Os
  34 .Sh NAME
  35 .Nm setsid
  36 .Nd create session and set process group ID
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft pid_t
  42 .Fn setsid void
  43 .Sh DESCRIPTION
  44 The
  45 .Fn setsid
  46 system call creates a new session.
  47 The calling process is the session leader of the new session, is the
  48 process group leader of a new process group and has no controlling
  49 terminal.
  50 The calling process is the only process in either the session or the
  51 process group.
  52 .Sh RETURN VALUES
  53 Upon successful completion, the
  54 .Fn setsid
  55 system call returns the value of the process group ID of the new process
  56 group, which is the same as the process ID of the calling process.
  57 If an error occurs,
  58 .Fn setsid
  59 returns -1 and the global variable
  60 .Va errno
  61 is set to indicate the error.
  62 .Sh ERRORS
  63 The
  64 .Fn setsid
  65 system call will fail if:
  66 .Bl -tag -width Er
  67 .It Bq Er EPERM
  68 The calling process is already a process group leader, or the process
  69 group ID of a process other than the calling process matches the process
  70 ID of the calling process.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr setpgid 2 ,
  74 .Xr tcgetpgrp 3 ,
  75 .Xr tcsetpgrp 3
  76 .Sh STANDARDS
  77 The
  78 .Fn setsid
  79 system call is expected to be compliant with the
  80 .St -p1003.1-90
  81 specification.