This is FreeBSD 5.x's code to dump the kernel's identifier through
[dragonfly.git] / usr.bin / uname / uname.1
1 .\" Copyright (c) 1993
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.1     8.3 (Berkeley) 4/8/94
33 .\" $FreeBSD: src/usr.bin/uname/uname.1,v 1.8.2.4 2002/10/17 07:47:29 jmallett Exp $
34 .\" $DragonFly: src/usr.bin/uname/uname.1,v 1.3 2003/10/24 17:19:16 dillon Exp $
35 .\"
36 .Dd October 24, 2003
37 .Dt UNAME 1
38 .Os
39 .Sh NAME
40 .Nm uname
41 .Nd display information about the system
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl aimnprsv
45 .Sh DESCRIPTION
46 The
47 .Nm
48 command writes the name of the operating system implementation to
49 standard output.
50 When options are specified, strings representing one or more system
51 characteristics are written to standard output.
52 .Pp
53 The options are as follows:
54 .Bl -tag -width indent
55 .It Fl a
56 Behave as though the options
57 .Fl m , n , r , s ,
58 and
59 .Fl v
60 were specified.
61 .It Fl i
62 Write the kernel ident to standard output.
63 .It Fl m
64 Write the type of the current hardware platform to standard output.
65 .It Fl n
66 Write the name of the system to standard output.
67 .It Fl p
68 Write the type of the machine processor architecture to standard output.
69 .It Fl r
70 Write the current release level of the operating system
71 to standard output.
72 .It Fl s
73 Write the name of the operating system implementation to standard output.
74 .It Fl v
75 Write the version level of this release of the operating system
76 to standard output.
77 .El
78 .Pp
79 If the
80 .Fl a
81 flag is specified, or multiple flags are specified, all
82 output is written on a single line, separated by spaces.
83 .Sh DIAGNOSTICS
84 .Ex -std
85 .Sh ENVIRONMENT
86 An environment variable composed of the string
87 .Ev UNAME_
88 followed by any flag to the
89 .Nm
90 utility (except for
91 .Fl a )
92 will allow the corresponding data to be set to the contents
93 of the environment variable.
94 .Sh SEE ALSO
95 .Xr sysctl 3 ,
96 .Xr uname 3 ,
97 .Xr sysctl 8
98 .Sh HISTORY
99 The
100 .Nm
101 command appeared in PWB UNIX.
102 .Sh STANDARDS
103 The
104 .Nm
105 command is expected to conform to the
106 .St -p1003.2
107 specification.