d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed copyright.

Browse Source 
Tidy up the markup.
Only describe the new, post-2.0 behavior.
Added the RETURN VALUES and ERRORS sections.
This commit is contained in:
ru 2003-02-24 22:55:33 +00:00
parent f55406b65f
commit 71431e76ae
1 changed files with 32 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
lib/libc/gen/getosreldate.3
View File

@ -1,5 +1,5 @@
.\" Copyright (c) 2002
.\" The Regents of the University of California. All rights reserved.
.\" Copyright (c) 2002 The FreeBSD Project.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -9,18 +9,11 @@
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgment:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" 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 REGENTS OR CONTRIBUTORS BE LIABLE
.\" 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)
@ -36,7 +29,8 @@
.Os
.Sh NAME
.Nm getosreldate
.Nd get the value of __FreeBSD_version
.Nd get the value of
.Dv __FreeBSD_version
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
@ -45,21 +39,39 @@
.Fn getosreldate void
.Sh DESCRIPTION
The
.Fn getrelosdate
function should return a 32-bit integer showing the version of
.Fn getosreldate
function returns an integer showing the version of the
currently running
.Fx
that a program was compiled on, and maybe running on (if 2.0 or better).
Definitions of the values can be found on the porters handbook
kernel.
Definitions of the values can be found in
.%B "The Porter's Handbook"
which is usually installed at
.Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/
.Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/ .
.Sh RETURN VALUES
Upon successful completion,
.Fn getosreldate
returns the value requested;
otherwise the value \-1 is returned and the global variable
.Va errno
is set to indicate the error.
.Sh EXAMPLES
An example can be found in
.Pa /usr/share/examples/FreeBSD_version .
.Sh ERRORS
The
.Fn getosreldate
function may fail and set
.Va errno
for any of the errors specified for the library function
.Xr sysctl 3 .
.Sh SEE ALSO
The porter handbook:
.Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/
.Rs
.%B "The Porter's Handbook"
.%O /usr/share/doc/en_US.ISO8859-1/books/porters\-handbook/
.Re
.Sh HISTORY
The
.Fn getosreldate
appeared in
function appeared in
.Fx 2.0 .