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