openrc/man/rc_find_pids.3

70 lines
2.3 KiB
Groff
Raw Normal View History

2009-05-01 19:41:40 +05:30
.\" Copyright (c) 2007-2008 Roy Marples
2007-12-25 03:33:27 +05:30
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.Dd Mar 17, 2008
2007-12-25 03:33:27 +05:30
.Dt RC_FIND_PIDS 3 SMM
.Os OpenRC
.Sh NAME
.Nm rc_find_pids
.Nd finds the pids of processes that match the given criteria
.Sh LIBRARY
Run Command library (librc, -lrc)
.Sh SYNOPSIS
.In rc.h
.Ft "RC_PIDLIST *" Fo rc_find_pids
.Fa "const char *const *argv"
2007-12-25 03:33:27 +05:30
.Fa "const char *cmd"
.Fa "uid_t uid"
.Fa "pid_t pid"
.Fc
.Sh DESCRIPTION
.Fn rc_find_pids
returns RC_PIDLIST, a structure based on the LIST macro from
.Xr queue 3
which contains all the pids found matching the given criteria.
If
2007-12-25 03:33:27 +05:30
.Fa pid
is given then only that pid is returned if it is running. Otherise we check
all instances of
.Fa argv
2007-12-25 03:33:27 +05:30
with a process name of
.Fa cmd
owned by
.Fa uid ,
all of which are optional.
.Pp
The returned list should be freed when done.
2007-12-25 03:33:27 +05:30
.Sh IMPLEMENTATION NOTES
On BSD systems we use
.Lb libkvm
and on Linux systems we use the
.Pa /proc
filesystem to find our processes.
.Pp
Each RC_PID should be freed in the list as well as the list itself when done.
2007-12-25 03:33:27 +05:30
.Sh SEE ALSO
.Xr free 3 ,
.Xr queue 3
2007-12-25 03:33:27 +05:30
.Sh AUTHORS
2008-12-31 00:38:51 +05:30
.An Roy Marples <roy@marples.name>