lib/libc/gen/uname.3

   1 .\"     $NetBSD: uname.3,v 1.12 2011/03/30 16:41:00 jruoho Exp $
   2 .\"
   3 .\" Copyright (c) 1994
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)uname.3     8.1 (Berkeley) 1/4/94
  31 .\"
  32 .Dd March 30, 2011
  33 .Dt UNAME 3
  34 .Os
  35 .Sh NAME
  36 .Nm uname
  37 .Nd get system identification
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/utsname.h
  42 .Ft int
  43 .Fn uname "struct utsname *name"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn uname
  47 function stores nul-terminated strings of information identifying
  48 the current system into the structure referenced by
  49 .Fa name .
  50 .Pp
  51 The
  52 .Em utsname
  53 structure is defined in the
  54 .In sys/utsname.h
  55 header file, and contains the following members:
  56 .Bl -tag -width nodenameXXXX -offset indent
  57 .It Va sysname
  58 Name of the operating system implementation.
  59 .It Va nodename
  60 Network name of this machine.
  61 .It Va release
  62 Release level of the operating system.
  63 .It Va version
  64 Version level of the operating system.
  65 .It Va machine
  66 Machine hardware platform.
  67 .El
  68 .Sh RETURN VALUES
  69 If
  70 .Nm uname
  71 is successful, 0 is returned, otherwise, \-1 is returned and
  72 .Va errno
  73 is set appropriately.
  74 .Sh ERRORS
  75 The
  76 .Fn uname
  77 function may fail and set
  78 .Va errno
  79 for any of the errors specified for the library functions
  80 .Xr sysctl 3 .
  81 .Sh SEE ALSO
  82 .Xr uname 1 ,
  83 .Xr sysctl 3
  84 .Sh STANDARDS
  85 The
  86 .Fn uname
  87 function conforms to
  88 .St -p1003.1-90 .
  89 .Sh HISTORY
  90 The
  91 .Nm uname
  92 function first appeared in
  93 .Bx 4.4 .