lib/libc/gen/getosreldate.3

   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 September 30, 2008
  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 unistd.h
  38 .Ft int
  39 .Fn getosreldate void
  40 .Sh DESCRIPTION
  41 The
  42 .Fn getosreldate
  43 function returns an integer showing the version of the
  44 currently running
  45 .Fx
  46 kernel.
  47 Definitions of the values can be found in
  48 .%B "The Porter's Handbook"
  49 which is usually installed at
  50 .Pa /usr/share/doc/en_US.ISO8859-1/books/porters-handbook/ .
  51 .Sh RETURN VALUES
  52 Upon successful completion,
  53 .Fn getosreldate
  54 returns the value requested;
  55 otherwise the value \-1 is returned and the global variable
  56 .Va errno
  57 is set to indicate the error.
  58 .Sh ENVIRONMENT
  59 .Bl -tag -width ".Ev OSVERSION"
  60 .It Ev OSVERSION
  61 If the environment variable
  62 .Ev OSVERSION
  63 is set, it will override the
  64 .Fn getosreldate
  65 return value.
  66 .El
  67 .Sh EXAMPLES
  68 An example can be found in
  69 .Pa /usr/share/examples/FreeBSD_version .
  70 .Sh ERRORS
  71 The
  72 .Fn getosreldate
  73 function may fail and set
  74 .Va errno
  75 for any of the errors specified for the library function
  76 .Xr sysctl 3 .
  77 .Sh SEE ALSO
  78 .Rs
  79 .%B "The Porter's Handbook"
  80 .%O /usr/share/doc/en_US.ISO8859-1/books/porters\-handbook/
  81 .Re
  82 .Sh HISTORY
  83 The
  84 .Fn getosreldate
  85 function appeared in
  86 .Fx 2.0 .