freebsd-dev/usr.bin/uname/uname.1

.\" Copyright (c) 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)uname.1	8.3 (Berkeley) 4/8/94
.\" $FreeBSD$
.\"
.Dd April 2, 2003
.Dt UNAME 1
.Os
.Sh NAME
.Nm uname
.Nd display information about the system
.Sh SYNOPSIS
.Nm
.Op Fl aimnprsv
.Sh DESCRIPTION
The
.Nm
command writes the name of the operating system implementation to
standard output.
When options are specified, strings representing one or more system
characteristics are written to standard output.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl a
Behave as though the options
.Fl m , n , r , s ,
and
.Fl v
were specified.
.It Fl i
Write the kernel ident to standard output.
.It Fl m
Write the type of the current hardware platform to standard output.
.It Fl n
Write the name of the system to standard output.
.It Fl p
Write the type of the machine processor architecture to standard output.
.It Fl r
Write the current release level of the operating system
to standard output.
.It Fl s
Write the name of the operating system implementation to standard output.
.It Fl v
Write the version level of this release of the operating system
to standard output.
.El
.Pp
If the
.Fl a
flag is specified, or multiple flags are specified, all
output is written on a single line, separated by spaces.
.Sh EXIT STATUS
.Ex -std
.Sh ENVIRONMENT
An environment variable composed of the string
.Ev UNAME_
followed by any flag to the
.Nm
utility (except for
.Fl a )
will allow the corresponding data to be set to the contents
of the environment variable.
.Sh SEE ALSO
.Xr sysctl 3 ,
.Xr uname 3 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
command appeared in PWB UNIX.
.Sh STANDARDS
The
.Nm
command is expected to conform to the
.St -p1003.2
specification.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)uname.1 8.3 (Berkeley) 4/8/94`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Fixed spelling of the document date. 2004-07-02 18:00:03 +00:00			`.Dd April 2, 2003`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt UNAME 1`
			`.Os`
			`.Sh NAME`
			`.Nm uname`
			`.Nd display information about the system`
			`.Sh SYNOPSIS`
Nm uname -> Nm. 1997-08-20 11:03:54 +00:00			`.Nm`
Make kernel identification (`ident' in the config(8) driver) available to userland, and the kernel. In the kernel by way of the 'ident[]' variable akin to all the other stuff generated by newvers.sh. In userland it is available to sysctl consumers via KERN_IDENT or 'kern.ident'. It is exported by uname(1) by the -i flag. Reviewed by: hackers@ 2003-06-09 09:38:20 +00:00			`.Op Fl aimnprsv`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
Nm uname -> Nm. 1997-08-20 11:03:54 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command writes the name of the operating system implementation to`
			`standard output.`
			`When options are specified, strings representing one or more system`
			`characteristics are written to standard output.`
			`.Pp`
			`The options are as follows:`
mdoc(7) police: bump document date for the -p change, tidy up the markup. 2002-01-17 10:38:32 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl a`
			`Behave as though the options`
mdoc(7) police: bump document date for the -p change, tidy up the markup. 2002-01-17 10:38:32 +00:00			`.Fl m , n , r , s ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`and`
			`.Fl v`
			`were specified.`
Make kernel identification (`ident' in the config(8) driver) available to userland, and the kernel. In the kernel by way of the 'ident[]' variable akin to all the other stuff generated by newvers.sh. In userland it is available to sysctl consumers via KERN_IDENT or 'kern.ident'. It is exported by uname(1) by the -i flag. Reviewed by: hackers@ 2003-06-09 09:38:20 +00:00			`.It Fl i`
			`Write the kernel ident to standard output.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl m`
			`Write the type of the current hardware platform to standard output.`
			`.It Fl n`
			`Write the name of the system to standard output.`
Add a -p option which is the same as the -m option but provided for SVR4 compatibility. PR: 5826 1998-02-24 16:57:49 +00:00			`.It Fl p`
'uname -p' prints the value of hw.machine_arch instead of hw.machine. Reviewed by: imp No response from: -arch MFC after: 3 weeks 2002-01-14 12:49:46 +00:00			`Write the type of the machine processor architecture to standard output.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl r`
			`Write the current release level of the operating system`
			`to standard output.`
			`.It Fl s`
			`Write the name of the operating system implementation to standard output.`
			`.It Fl v`
			`Write the version level of this release of the operating system`
			`to standard output.`
			`.El`
			`.Pp`
			`If the`
			`.Fl a`
			`flag is specified, or multiple flags are specified, all`
			`output is written on a single line, separated by spaces.`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
Mostly rewrite the flag handling of uname(1) to be overridable, such as: freefall% uname -s FreeBSD freefall% env UNAME_s=Linnex ./uname -s Linnex MFC after: 1 month 2002-09-18 04:33:10 +00:00			`.Sh ENVIRONMENT`
			`An environment variable composed of the string`
			`.Ev UNAME_`
			`followed by any flag to the`
			`.Nm`
			`utility (except for`
			`.Fl a )`
			`will allow the corresponding data to be set to the contents`
			`of the environment variable.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
			`.Xr sysctl 3 ,`
Sort cross references. 1997-01-15 23:25:55 +00:00			`.Xr uname 3 ,`
			`.Xr sysctl 8`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
Nm uname -> Nm. 1997-08-20 11:03:54 +00:00			`.Nm`
Note that this appeared at least as early as PWB UNIX. Use the literal string 'PWB UNIX', as we still have no .At macro for it. 2002-06-10 22:59:59 +00:00			`command appeared in PWB UNIX.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh STANDARDS`
			`The`
Nm uname -> Nm. 1997-08-20 11:03:54 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command is expected to conform to the`
			`.St -p1003.2`
			`specification.`