Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libcr / gen / getosreldate.3
1 .\" Copyright (c) 2002
2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgment:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $FreeBSD: src/lib/libc/gen/getosreldate.3,v 1.1.2.1 2003/02/02 02:54:03 trhodes Exp $
33 .\"
34 .Dd January 30, 2003
35 .Dt GETOSRELDATE 3
36 .Os
37 .Sh NAME
38 .Nm getosreldate
39 .Nd get the value of __FreeBSD_version
40 .Sh LIBRARY
41 .Lb libc
42 .Sh SYNOPSIS
43 .In osreldate.h
44 .Ft int
45 .Fn getosreldate void
46 .Sh DESCRIPTION
47 The
48 .Fn getrelosdate
49 function should return a 32-bit integer showing the version of
50 .Fx
51 that a program was compiled on, and maybe running on (if 2.0 or better).
52 Definitions of the values can be found on the porters handbook
53 which is usually installed at
54 .Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/
55 .Sh EXAMPLES
56 An example can be found in
57 .Pa /usr/share/examples/FreeBSD_version .
58 .Sh SEE ALSO
59 The porter handbook:
60 .Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/
61 .Sh HISTORY
62 The
63 .Fn getosreldate
64 appeared in
65 .Fx 2.0 .