emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

documentation: Update pids manual pages

Browse Source 
Updated the full suite of manual pages for the procps_pids_*
functions. The only one missing is procps_pids_get which
may not be required.
This commit is contained in:
Craig Small
2017-01-05 09:44:04 +11:00
parent ea930f6f9e
commit 2598e9f2ce
10 changed files with 574 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
doc/procps_pids_reset.3 Normal file
View File

@@ -0,0 +1,70 @@
.\" (C) Copyright 2017 Craig Small <csmall@enc.com.au>
.\"
.\" %%%LICENSE_START(LGPL_2.1+)
.\" This manual is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU Lesser General Public
.\" License as published by the Free Software Foundation; either
.\" version 2.1 of the License, or (at your option) any later version.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
.\" Lesser General Public License for more details.
.\"
.\" You should have received a copy of the GNU Lesser General Public
.\" License along with this library; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\" %%%LICENSE_END
.\"
.TH PROCPS_PIDS_reset 3 2017-01-05 "libproc-2"
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
procps_pids_reset \-
Change what information is collected for a process
.SH SYNOPSIS
.B #include <proc/procps.h>
.sp
.BI "int procps_pids_reset(struct pids_info **" info ", enum pids_item *" items ", int " numitems ");"
.sp
Link with \fI\-lprocps\fP.
.SH DESCRIPTION
During the initial call to \fBprocps_pids_new\fR(3), the information structure
is allocated and the information items are specified.
\fBprocps_pids_reset\fR allows you to change what items for a process are collected
without having to unreference and create a new \fIpids_info\fR structure.
The changed PID information structure can then be used in subsequent calls to
.BR procps_pids_get (3),
.BR procps_pids_reap (3),
.BR procps_pids_reset (3),
.BR procps_pids_select (3),
.BR procps_pids_sort (3)
or even to further calls to \fBprocps_pids_reset\fR itself.
The \fIitems\fR and \fInumitems\fR parameters are identical to the parameters
used in \fBprocps_pids_new\fR.
.SH RETURN VALUE
The function returns 0 on success and one of negative values below
on failure.
.TP
.B -EINVAL
One of the given parameters is incorrect.
.TP
.B -ENOMEM
Unable to allocate memory for the changed structure.
.SH VERSIONS
.B procps_pids_reset()
first appeared in libproc-2 version 0.0.
.SH SEE ALSO
.BR libproc (3),
.BR procps_pids_new (3),
.BR procps_pids_reap (3),
.BR procps_pids_select (3),
.BR procps_pids_sort (3),
.BR procps_pids_unref (3),
.BR proc (5).