docs: Add namespace man pages

diff --git a/Makefile.am b/Makefile.am
index 871d98f9b2ae182203ece3bd76f3f668687daf88..ed773dfb6c9e6e46e88bcccea4fa5b4e678f223c 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -83,6 +83,9 @@ dist_man_MANS = \
        doc/procps_pids_select.3 \
        doc/procps_pids_sort.3 \
        doc/procps_pids_unref.3 \
+       doc/procps_ns_get_id.3 \
+       doc/procps_ns_get_name.3 \
+       doc/procps_ns_read_pid.3 \
        doc/procps_uptime.3 \
        doc/procps_uptime_sprint.3 \
        doc/procps_uptime_sprint_short.3

diff --git a/doc/procps_ns_get_id.3 b/doc/procps_ns_get_id.3
new file mode 100644 (file)
index 0000000..03993f7
--- /dev/null
+++ b/doc/procps_ns_get_id.3
@@ -0,0 +1,76 @@
+.\" (C) Copyright 2020 Craig Small <csmall@dropbear.xyz>
+.\"
+.\" %%%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_LINUX_VERSION 3 2020-05-18 "libproc-2"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.SH NAME
+procps_ns \-
+provide information on the namespaces
+.SH SYNOPSIS
+.nf
+.B #include <proc/namespace.h>
+.PP
+.BI "int procps_ns_get_id(const char * " name ");"
+.BI "const char *procps_ns_get_name(const int " id ");"
+.BI "int procps_ns_read_pid(const int " pid ", struct procps_namespaces * " nsp ");"
+.sp
+Link with \fI\-lprocps\fP.
+.SH DESCRIPTION
+The family of
+.BR procps_ns ()
+functions return information about the Linux namespaces.
+
+.BR procps_ns_get_id ()
+finds the ID of the namespace for the given namespace name.
+
+.BR procps_ns_get_name ()
+finds the name of the namespace of the given integer ID.
+
+.BR procps_ns_read_pid ()
+puts the inodes for the namespaces of the given process into
+the array pointed to \fInsp\fR.
+
+.SH RETURN VALUE
+.BR procps_ns_get_id ()
+returns an integer for the namespace ID for the given name or
+.B \-EINVAL
+for an invalid input or an unknown namespace name.
+
+.BR procps_ns_get_name ()
+returns a statically allocated string containing the name of the
+namespace for the given ID. If the name is not found the function
+returns
+.B NULL
+
+.BR procps_ns_read_pid ()
+Returns 0 on success and \fB\-EINVAL\fR on failure.
+
+.SH FILES
+.TP
+.IB /proc/ PID /ns
+contains the set of namespaces for a particular \fBPID\fR.
+
+.SH VERSIONS
+The
+.BR procps_ns ()
+set of functions first appeared in libproc-2 version 0.0.
+
+.SH SEE ALSO
+.BR proc (5),
+.BR namespaces (7).

diff --git a/doc/procps_ns_get_name.3 b/doc/procps_ns_get_name.3
new file mode 100644 (file)
index 0000000..ba81a00
--- /dev/null
+++ b/doc/procps_ns_get_name.3
@@ -0,0 +1 @@
+.so man3/procps_ns_get_id.3

diff --git a/doc/procps_ns_read_pid.3 b/doc/procps_ns_read_pid.3
new file mode 100644 (file)
index 0000000..ba81a00
--- /dev/null
+++ b/doc/procps_ns_read_pid.3
@@ -0,0 +1 @@
+.so man3/procps_ns_get_id.3