xref: /freebsd/share/man/man9/pgfind.9 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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.Dd August 8, 2001
26.Dt PGFIND 9
27.Os
28.Sh NAME
29.Nm pgfind
30.Nd "locate a process group by number"
31.Sh SYNOPSIS
32.In sys/param.h
33.In sys/proc.h
34.Ft "struct pgrp *"
35.Fn pgfind "pid_t pgid"
36.Sh DESCRIPTION
37The
38.Fn pgfind
39function takes a
40.Fa pgid
41as its argument and returns a pointer to the
42.Vt pgrp
43structure whose
44.Va pg_id
45is specified in the argument.
46.Pp
47.Fn pgfind
48locks the
49.Vt pgrp
50structure that is returned.
51.Sh RETURN VALUES
52The
53.Fn pgfind
54function returns
55.Dv NULL
56on failure or a pointer to a
57.Vt pgrp
58structure on successful completion.
59.Sh SEE ALSO
60.Xr pfind 9
61.Sh AUTHORS
62This manual page was written by
63.An Evan Sarmiento Aq Mt kaworu@sektor7.ath.cx .
64