[apple/xnu.git] / bsd / man / man2 / getpid.2

.\"	$NetBSD: getpid.2,v 1.5 1995/02/27 12:33:12 cgd Exp $
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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
.\"
.Dd June 4, 1993
.Dt GETPID 2
.Os BSD 4
.Sh NAME
.Nm getpid ,
.Nm getppid
.Nd get parent or calling process identification
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft pid_t
.Fo getpid
.Fa void
.Fc
.Ft pid_t
.Fo getppid
.Fa void
.Fc
.Sh DESCRIPTION
.Fn Getpid
returns
the process ID of
the calling process.
The ID is guaranteed to be unique and is
useful for constructing temporary file names.
.Pp
.Fn Getppid
returns the process ID of the parent
of the calling process. 
.Sh ERRORS
The
.Fn getpid
and
.Fn getppid
functions are always successful, and no return value is reserved to
indicate an error.
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <unistd.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Sh SEE ALSO
.Xr gethostid 2 ,
.Xr compat 5
.Sh STANDARDS
.Fn Getpid
and
.Fn getppid
conform to 
.St -p1003.1-88 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: getpid.2,v 1.5 1995/02/27 12:33:12 cgd Exp $
	2	.\"
	3	.\" Copyright (c) 1980, 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. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)getpid.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt GETPID 2
	38	.Os BSD 4
	39	.Sh NAME
	40	.Nm getpid ,
	41	.Nm getppid
	42	.Nd get parent or calling process identification
	43	.Sh SYNOPSIS
9bccf70c A	44	.Fd #include <unistd.h>
9bccf70c A	45	.Ft pid_t
2d21ac55 A	46	.Fo getpid
	47	.Fa void
	48	.Fc
9bccf70c	49	.Ft pid_t
2d21ac55 A	50	.Fo getppid
	51	.Fa void
	52	.Fc
9bccf70c A	53	.Sh DESCRIPTION
	54	.Fn Getpid
	55	returns
	56	the process ID of
	57	the calling process.
	58	The ID is guaranteed to be unique and is
	59	useful for constructing temporary file names.
	60	.Pp
	61	.Fn Getppid
	62	returns the process ID of the parent
	63	of the calling process.
	64	.Sh ERRORS
	65	The
	66	.Fn getpid
	67	and
	68	.Fn getppid
	69	functions are always successful, and no return value is reserved to
	70	indicate an error.
2d21ac55 A	71	.Sh LEGACY SYNOPSIS
	72	.Fd #include <sys/types.h>
	73	.Fd #include <unistd.h>
	74	.Pp
	75	The include file
	76	.In sys/types.h
	77	is necessary.
9bccf70c	78	.Sh SEE ALSO
2d21ac55 A	79	.Xr gethostid 2 ,
2d21ac55 A	80	.Xr compat 5
9bccf70c A	81	.Sh STANDARDS
	82	.Fn Getpid
	83	and
	84	.Fn getppid
	85	conform to
	86	.St -p1003.1-88 .