lib/libc/uname.3

   1 .\"     $OpenBSD: uname.3,v 1.15 2014/01/21 03:15:45 schwarze 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 .Dd $Mdocdate: January 21 2014 $
  31 .Dt UNAME 3
  32 .Os
  33 .Sh NAME
  34 .Nm uname
  35 .Nd get system identification
  36 .Sh SYNOPSIS
  37 .In sys/utsname.h
  38 .Ft int
  39 .Fn uname "struct utsname *name"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn uname
  43 function stores NUL-terminated strings of information identifying
  44 the current system into the structure referenced by
  45 .Fa name .
  46 .Pp
  47 The
  48 .Li utsname
  49 structure is defined in the
  50 .In sys/utsname.h
  51 header file, and contains the following members:
  52 .Pp
  53 .Bl -tag -width nodenameXXXX -offset indent -compact
  54 .It Fa sysname
  55 Name of the operating system implementation.
  56 .It Fa nodename
  57 Network name of this machine.
  58 .It Fa release
  59 Release level of the operating system.
  60 .It Fa version
  61 Version level of the operating system.
  62 .It Fa machine
  63 Machine hardware platform.
  64 .El
  65 .Sh RETURN VALUES
  66 The
  67 .Fn uname
  68 function returns a non-negative value if successful;
  69 otherwise the value -1 is returned and the global variable
  70 .Va errno
  71 is set to indicate the error.
  72 .Sh ERRORS
  73 The
  74 .Fn uname
  75 function will fail if:
  76 .Bl -tag -width Er
  77 .It Bq Er EFAULT
  78 .Fa name
  79 contains an invalid address.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr uname 1 ,
  83 .Xr puname 1
  84 .Sh STANDARDS
  85 The
  86 .Fn uname
  87 function conforms to
  88 .St -p1003.1-88 .
  89 .Sh HISTORY
  90 The
  91 .Fn uname
  92 function first appeared in
  93 .Bx 4.4 .