b43a3a6ee5eb4f8690cb992bdb172f68b37c96be
[dragonfly.git] / lib / libc / gen / uname.3
1 .\" Copyright (c) 1994
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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)uname.3     8.1 (Berkeley) 1/4/94
29 .\" $FreeBSD: src/lib/libc/gen/uname.3,v 1.6.2.4 2001/12/14 18:33:51 ru Exp $
30 .\" $DragonFly: src/lib/libc/gen/uname.3,v 1.3 2006/05/26 19:39:36 swildner Exp $
31 .\"
32 .Dd January 4, 1994
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 .Vt 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 sysname
58 Name of the operating system implementation.
59 .It nodename
60 Network name of this machine.
61 .It release
62 Release level of the operating system.
63 .It version
64 Version level of the operating system.
65 .It machine
66 Machine hardware platform.
67 .El
68 .Sh RETURN VALUES
69 .Rv -std uname
70 .Sh ERRORS
71 The
72 .Fn uname
73 function may fail and set
74 .Va errno
75 for any of the errors specified for the library functions
76 .Xr sysctl 3 .
77 .Sh SEE ALSO
78 .Xr uname 1 ,
79 .Xr sysctl 3
80 .Sh STANDARDS
81 The
82 .Fn uname
83 function conforms to
84 .St -p1003.1-88 .
85 .Sh HISTORY
86 The
87 .Fn uname
88 function first appeared in
89 .Bx 4.4 .