xref: /freebsd/share/man/man9/pfind.9 (revision 9207b4cff7b8d483f4dd3c62266c2b58819eb7f9)
1.\" Copyright (c) 2001 Evan Sarmiento.
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 11, 2001
28.Os
29.Dt PFIND 9
30.Sh NAME
31.Nm pfind , zpfind
32.Nd locate a process by number
33.Sh SYNOPSIS
34.In sys/proc.h
35.Ft "struct proc *"
36.Fn pfind "pid_t pid"
37.Ft "struct proc *"
38.Fn zpfind "pid_t pid"
39.Sh DESCRIPTION
40.Fn pfind
41takes a
42.Fa pid
43as its argument and returns a pointer to the
44.Vt proc
45structure whose PID is specified in the argument only if the
46.Fa pid
47is on the
48.Va allproc
49list.
50.Pp
51.Fn zpfind
52takes a
53.Fa pid
54as its argument.
55If
56.Fn zpfind
57finds a process whose PID is equal to that of argument
58and is a zombie process, meaning that it must reside on the
59.Va zombproc
60list,
61.Fn zpfind
62returns a pointer to that
63.Vt proc
64structure.
65.Pp
66Both
67.Fn pfind
68and
69.Fn zpfind
70lock the
71.Vt proc
72structure that is returned using
73.Fn PROC_LOCK "p" .
74.Sh RETURN VALUES
75.Fn pfind
76and
77.Fn zpfind
78return a pointer to a
79.Vt proc
80structure on success and a
81.Dv NULL
82on failure.
83.Sh AUTHORS
84This man page was written by
85.An Evan Sarmiento Aq kaworu@sektor7.ath.cx .
86