Merge branch 'vendor/DIFFUTILS'
[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. 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.1     8.3 (Berkeley) 4/8/94
29 .\" $FreeBSD: src/usr.bin/uname/uname.1,v 1.8.2.4 2002/10/17 07:47:29 jmallett Exp $
30 .\" $DragonFly: src/usr.bin/uname/uname.1,v 1.5 2007/07/30 22:11:33 swildner Exp $
31 .\"
32 .Dd October 24, 2003
33 .Dt UNAME 1
34 .Os
35 .Sh NAME
36 .Nm uname
37 .Nd display information about the system
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl aimnprsvP
41 .Sh DESCRIPTION
42 The
43 .Nm
44 command writes the name of the operating system implementation to
45 standard output.
46 When options are specified, strings representing one or more system
47 characteristics are written to standard output.
48 .Pp
49 The options are as follows:
50 .Bl -tag -width indent
51 .It Fl a
52 Behave as though the options
53 .Fl m , n , r , s ,
54 and
55 .Fl v
56 were specified.
57 .It Fl i
58 Write the kernel ident to standard output.
59 .It Fl m
60 Write the type of the current hardware platform to standard output.
61 .It Fl n
62 Write the name of the system to standard output.
63 .It Fl p
64 Write the type of the machine processor architecture to standard output.
65 .It Fl r
66 Write the current release level of the operating system
67 to standard output.
68 .It Fl s
69 Write the name of the operating system implementation to standard output.
70 .It Fl v
71 Write the version level of this release of the operating system
72 to standard output.
73 .It Fl P
74 Generates a default ABI: configuration string for dports / pkgng to
75 the standard output, including odd-to-even version-munging.
76 .It Fl PP
77 Generates a default ABI: configuration string for dports / pkgng to
78 the standard output, without version-munging.
79 .El
80 .Pp
81 If the
82 .Fl a
83 flag is specified, or multiple flags are specified, all
84 output is written on a single line, separated by spaces.
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 .Pp
95 A varsym composed of the string
96 .Ev UNAME_
97 followed by any flag to the
98 .Nm
99 utility (except for
100 .Fl a )
101 will allow the corresponding data to be set from the contents
102 of the varsym.
103 Environment variables override varsyms in this case.
104 .Sh EXIT STATUS
105 .Ex -std
106 .Sh SEE ALSO
107 .Xr varsym 1 ,
108 .Xr sysctl 3 ,
109 .Xr uname 3 ,
110 .Xr sysctl 8
111 .Sh STANDARDS
112 The
113 .Nm
114 command is expected to conform to the
115 .St -p1003.2
116 specification.
117 .Sh HISTORY
118 The
119 .Nm
120 command appeared in PWB
121 .Ux .