- Uniformly use .In for header file references.
[dragonfly.git] / lib / libc / gen / uname.3
CommitLineData
984263bc
MD
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. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
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.\" @(#)uname.3 8.1 (Berkeley) 1/4/94
33.\" $FreeBSD: src/lib/libc/gen/uname.3,v 1.6.2.4 2001/12/14 18:33:51 ru Exp $
44cb301e 34.\" $DragonFly: src/lib/libc/gen/uname.3,v 1.3 2006/05/26 19:39:36 swildner Exp $
984263bc
MD
35.\"
36.Dd January 4, 1994
37.Dt UNAME 3
38.Os
39.Sh NAME
40.Nm uname
41.Nd get system identification
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In sys/utsname.h
46.Ft int
47.Fn uname "struct utsname *name"
48.Sh DESCRIPTION
49The
50.Fn uname
51function stores nul-terminated strings of information identifying
52the current system into the structure referenced by
53.Fa name .
54.Pp
55The
56.Vt utsname
57structure is defined in the
44cb301e 58.In sys/utsname.h
984263bc
MD
59header file, and contains the following members:
60.Bl -tag -width nodenameXXXX -offset indent
61.It sysname
62Name of the operating system implementation.
63.It nodename
64Network name of this machine.
65.It release
66Release level of the operating system.
67.It version
68Version level of the operating system.
69.It machine
70Machine hardware platform.
71.El
72.Sh RETURN VALUES
73.Rv -std uname
74.Sh ERRORS
75The
76.Fn uname
77function may fail and set
78.Va errno
79for 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
85The
86.Fn uname
87function conforms to
88.St -p1003.1-88 .
89.Sh HISTORY
90The
91.Fn uname
92function first appeared in
93.Bx 4.4 .