6955 libproc should be documented and shipped

6956 libproc cannot leave free() to callers
Reviewed by: Ryan Zezeski <ryan@zinascii.com>
Reviewed by: Cody Mello <cody.mello@joyent.com>
Reviewed by: Joshua M. Clulow <josh@sysmgr.org>
Approved by: Richard Lowe <richlowe@richlowe.net>

1 files changed, 56 insertions, 0 deletions

diff --git a/usr/src/man/man3proc/Lpsinfo.3proc b/usr/src/man/man3proc/Lpsinfo.3proc
new file mode 100644
index 0000000000..d9ff12afb1
--- /dev/null
+++ b/usr/src/man/man3proc/Lpsinfo.3proc
@@ -0,0 +1,56 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source.  A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2015 Joyent, Inc.
+.\"
+.Dd May 11, 2016
+.Dt LPSINFO 3PROC
+.Os
+.Sh NAME
+.Nm Lpsinfo
+.Nd get process ps information
+.Sh SYNOPSIS
+.Lb libproc
+.In libproc.h
+.Ft "const lwpsinfo_t *"
+.Fo Lpsinfo
+.Fa "struct ps_lwphandle *L"
+.Fc
+.Sh DESCRIPTION
+The
+.Fn Lpsinfo
+function returns the thread handle
+.Fa L Ns 's
+.Xr ps 1
+information. The
+.Sy lwpsinfo_t
+structure that is returned is defined in
+.Xr proc 4
+and is valid until a subsequent call to
+.Xr Lfree 3PROC .
+.Sh RETURN VALUES
+Upon successful completion, the
+.Fn Lpsinfo
+function returns a pointer to the thread's ps information. Otherwise,
+.Dv NULL
+is returned to indicate that it could not be found.
+.Sh INTERFACE STABILITY
+.Sy Uncommitted
+.Sh MT-LEVEL
+See
+.Sy LOCKING
+in
+.Xr libproc 3LIB .
+.Sh SEE ALSO
+.Xr ps 1 ,
+.Xr libproc 3LIB ,
+.Xr Lfree 3PROC ,
+.Xr proc 4