xref: /freebsd/lib/libc/gen/getosreldate.3 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
1.\" Copyright (c) 2002 The FreeBSD Project.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd January 30, 2003
28.Dt GETOSRELDATE 3
29.Os
30.Sh NAME
31.Nm getosreldate
32.Nd get the value of
33.Dv __FreeBSD_version
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In osreldate.h
38.Ft int
39.Fn getosreldate void
40.Sh DESCRIPTION
41The
42.Fn getosreldate
43function returns an integer showing the version of the
44currently running
45.Fx
46kernel.
47Definitions of the values can be found in
48.%B "The Porter's Handbook"
49which is usually installed at
50.Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/ .
51.Sh RETURN VALUES
52Upon successful completion,
53.Fn getosreldate
54returns the value requested;
55otherwise the value \-1 is returned and the global variable
56.Va errno
57is set to indicate the error.
58.Sh EXAMPLES
59An example can be found in
60.Pa /usr/share/examples/FreeBSD_version .
61.Sh ERRORS
62The
63.Fn getosreldate
64function may fail and set
65.Va errno
66for any of the errors specified for the library function
67.Xr sysctl 3 .
68.Sh SEE ALSO
69.Rs
70.%B "The Porter's Handbook"
71.%O /usr/share/doc/en_US.ISO8859-1/books/porters\-handbook/
72.Re
73.Sh HISTORY
74The
75.Fn getosreldate
76function appeared in
77.Fx 2.0 .
78