summaryrefslogtreecommitdiff
path: root/doc/procps_linux_version.3
diff options
context:
space:
mode:
authorCraig Small <csmall@enc.com.au>2016-04-16 08:34:08 +1000
committerCraig Small <csmall@enc.com.au>2016-04-16 08:34:08 +1000
commitd15a8901d29cd53c2c9fa15b6ef9efc8dbaf6287 (patch)
tree14df236551958df7d3e6b0d5871bf616d926f7a1 /doc/procps_linux_version.3
parent828540578cadb2e3e90e29754325cd3d8fab7033 (diff)
downloadprocps-ng-d15a8901d29cd53c2c9fa15b6ef9efc8dbaf6287.tar.gz
docs: Cleanup procps_linux_version page
Getting the manual page for procps_linux_version(3) fixed up so it follows the man-pages(7) and other standards. Added lgpl license to file, so its the same as the code.
Diffstat (limited to 'doc/procps_linux_version.3')
-rw-r--r--doc/procps_linux_version.351
1 files changed, 36 insertions, 15 deletions
diff --git a/doc/procps_linux_version.3 b/doc/procps_linux_version.3
index a3e3e28..838854b 100644
--- a/doc/procps_linux_version.3
+++ b/doc/procps_linux_version.3
@@ -1,7 +1,22 @@
-.\"
.\" (C) Copyright 2016 Craig Small <csmall@enc.com.au>
.\"
-.TH PROCPS_LINUX_VERSION 3 2016-04-14
+.\" %%%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 2016-04-14 "libproc-2"
.\" Please adjust this date whenever revising the manpage.
.\"
.SH NAME
@@ -16,10 +31,12 @@ Link with \fI\-lprocps\fP.
.SH DESCRIPTION
The function
.BR procps_linux_version ()
-returns the current Linux version as an integer. On systems that have an emulated proc filesystem this function returns the
-version of the Linux emulation instead.
-
-The Linux version consists of a triple of positive integers representing the major, minor and patch versions of the kernel.
+returns the current Linux version as an integer. On non-Linux systems that
+have an emulated proc filesystem this function returns the version of the
+Linux emulation instead.
+The Linux version consists of a triple of positive integers representing
+the major, minor and patch versions of the kernel.
+.PP
The library provides 3 macros for separating out the components.
.RS 4
.TP 1.2i
@@ -39,15 +56,10 @@ version, use the following macro:
.BI LINUX_VERSION( major , minor , patch )
.SH RETURN VALUE
-On success,
+The
.BR procps_linux_version ()
-return a positive integer which is the encoded Linux kernel version;
-on error, it returns a negative integer.
-
-.SH ERRORS
-On error,
-.BR procps_linux_version ()
-may return the following values as errors:
+returns a positive integer encoding the Linux version if successful. Otherwise
+returns a negative integer to one of the values defined below.
.TP
.B -EIO
The procps library was unable to read the osrelease file.
@@ -56,7 +68,16 @@ The procps library was unable to read the osrelease file.
Unable to parse the osrelease file.
.PP
.BR procps_linux_version ()
-may also return any (negated) value that \fBfopen\fR() may return.
+may also return any (negated) value that \fBfopen\fR() may set errno to.
+
+.SH FILES
+.TP
+.I /proc/sys/kernel/osrelease
+Contains the release version of the Linux kernel or proc filesystem.
+
+.SH VERSIONS
+.B procps_linux_version()
+first appeared in libproc-2 version 0.0.
.SH SEE ALSO
.BR fopen (3),