freebsd-skq/lib/libc/sys/getpid.2

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)getpid.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd December 15, 2015
.Dt GETPID 2
.Os
.Sh NAME
.Nm getpid ,
.Nm getppid
.Nd get parent or calling process identification
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft pid_t
.Fn getpid void
.Ft pid_t
.Fn getppid void
.Sh DESCRIPTION
The
.Fn getpid
system call
returns
the process ID of
the calling process.
Though the ID is guaranteed to be unique, it should
.Em NOT
be used for constructing temporary file names, for
security reasons; see
.Xr mkstemp 3
instead.
.Pp
The
.Fn getppid
system call
returns the process ID of the parent
of the calling process.
.Sh ERRORS
The
.Fn getpid
and
.Fn getppid
system calls are always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr fork 2 ,
.Xr getpgrp 2 ,
.Xr kill 2 ,
.Xr setpgid 2 ,
.Xr setsid 2 ,
.Xr exec 3
.Sh STANDARDS
The
.Fn getpid
and
.Fn getppid
system calls are expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
The
.Fn getpid
function appeared in
.At v7 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)getpid.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Remove sys/types.h due to STANDARDS and unistd.h also includes sys/types.h. 2015-12-15 15:19:06 +00:00			`.Dd December 15, 2015`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt GETPID 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm getpid ,`
			`.Nm getppid`
			`.Nd get parent or calling process identification`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft pid_t`
			`.Fn getpid void`
			`.Ft pid_t`
			`.Fn getppid void`
			`.Sh DESCRIPTION`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
			`.Fn getpid`
			`system call`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`returns`
			`the process ID of`
			`the calling process.`
Don't suggest people use getpid() to construct temporary filenames; point them to mkstemp() instead. Obtained from: OpenBSD (based on) 2000-11-19 10:30:42 +00:00			`Though the ID is guaranteed to be unique, it should`
			`.Em NOT`
			`be used for constructing temporary file names, for`
			`security reasons; see`
			`.Xr mkstemp 3`
			`instead.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Pp`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
			`.Fn getppid`
			`system call`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`returns the process ID of the parent`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`of the calling process.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh ERRORS`
			`The`
			`.Fn getpid`
			`and`
			`.Fn getppid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system calls are always successful, and no return value is reserved to`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`indicate an error.`
			`.Sh SEE ALSO`
Replace the SEE ALSO xrefs with a more reasonable set stolen from POSIX. 2006-11-02 14:10:56 +00:00			`.Xr fork 2 ,`
			`.Xr getpgrp 2 ,`
			`.Xr kill 2 ,`
			`.Xr setpgid 2 ,`
			`.Xr setsid 2 ,`
			`.Xr exec 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh STANDARDS`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`The`
			`.Fn getpid`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`and`
			`.Fn getppid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system calls are expected to conform to`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`.St -p1003.1-90 .`
function appeared in Version 7 AT&T UNIX Obtained from: ftp://netlib.att.com/netlib/att/cs/v7man/man2 1996-08-29 21:24:19 +00:00			`.Sh HISTORY`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
function appeared in Version 7 AT&T UNIX Obtained from: ftp://netlib.att.com/netlib/att/cs/v7man/man2 1996-08-29 21:24:19 +00:00			`.Fn getpid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`function appeared in`
function appeared in Version 7 AT&T UNIX Obtained from: ftp://netlib.att.com/netlib/att/cs/v7man/man2 1996-08-29 21:24:19 +00:00			`.At v7 .`