[apple/system_cmds.git] / hostinfo.tproj / hostinfo.8

.\" Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
.\" 
.\" The contents of this file constitute Original Code as defined in and
.\" are subject to the Apple Public Source License Version 1.1 (the
.\" "License").  You may not use this file except in compliance with the
.\" License.  Please obtain a copy of the License at
.\" http://www.apple.com/publicsource and read it before using this file.
.\" 
.\" This Original Code and all software distributed under the License are
.\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
.\" License for the specific language governing rights and limitations
.\" under the License.
.\" 
.\"     @(#)hostinfo.1
.Dd October 30, 2003               \" DATE 
.Dt hostinfo 8      \" Program name and manual section number 
.Os "Mac OS X"
.Sh NAME                 \" Section Header - required - don't modify 
.Nm hostinfo
.\" The following lines are read in generating the apropos(man -k) database. Use only key
.\" words here as the database is built based on the words here and in the .ND line. 
.\" Use .Nm macro to designate other names for the documented program.
.Nd host information
.Sh SYNOPSIS             \" Section Header - required - don't modify
.Nm
.Sh DESCRIPTION          \" Section Header - required - don't modify
The
.Nm
command displays information about the host system on which the command is executing.
The output includes
a  kernel version description,
processor configuration data,
available physical memory,
and various scheduling statistics.
.Pp
.Sh OPTIONS
There are no options.
.Sh DISPLAY
.Pp
.Bl -ohang -width Primary_memory_available_ -offset indent
.It Mach kernel version:
The version string compiled into the kernel executing on the host system.
.Pp
.It Processor Configuration:
The maximum possible processors for which the kernel is configured, 
followed by the number of physical and logical processors available.
.Pp
.It Processor type:
The host's processor type and subtype.
.Pp
.It Processor active:
A list of active processors on the host system.
Active processors are members of a processor set and are ready to 
dispatch threads.
On a single processor system, the active processor, is processor 0.
.Pp
.It Primary memory available:
The amount of physical memory that is configured for use on the host system.
.Pp
.It Default processor set:
Displays the number of tasks currently assigned to the host processor set,
the number of threads currently assigned to the host processor set,
and the number of processors included in the host processor set.
.Pp
.It Load average:
Measures the average number of threads in the run queue.
.Pp
.It Mach factor:
A variant of the load average which measures 
the processing resources available to a new thread.
Mach factor is based on the number of CPUs divided by (1 + the number of runnablethreads)
or 
the number of CPUs minus the number of runnable threads when the number of runnable threads
is less than the number of CPUs.
The closer the Mach factor value is to zero, the higher the load.
On an idle system with a fixed number of active processors, the mach factor will be equal to the number of CPUs.
.El
.Sh SEE ALSO 
.\" List links in ascending order by section, alphabetically within a section.
.Xr sysctl 8
.\" .Sh BUGS              \" Document known, unremedied bugs
Commit	Line	Data
83f6dbe8 A	1	.\" Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
	2	.\"
	3	.\" The contents of this file constitute Original Code as defined in and
	4	.\" are subject to the Apple Public Source License Version 1.1 (the
	5	.\" "License"). You may not use this file except in compliance with the
	6	.\" License. Please obtain a copy of the License at
	7	.\" http://www.apple.com/publicsource and read it before using this file.
	8	.\"
	9	.\" This Original Code and all software distributed under the License are
	10	.\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	11	.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	12	.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	13	.\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	14	.\" License for the specific language governing rights and limitations
	15	.\" under the License.
	16	.\"
	17	.\" @(#)hostinfo.1
	18	.Dd October 30, 2003 \" DATE
	19	.Dt hostinfo 8 \" Program name and manual section number
	20	.Os "Mac OS X"
	21	.Sh NAME \" Section Header - required - don't modify
	22	.Nm hostinfo
	23	.\" The following lines are read in generating the apropos(man -k) database. Use only key
	24	.\" words here as the database is built based on the words here and in the .ND line.
	25	.\" Use .Nm macro to designate other names for the documented program.
	26	.Nd host information
	27	.Sh SYNOPSIS \" Section Header - required - don't modify
	28	.Nm
	29	.Sh DESCRIPTION \" Section Header - required - don't modify
	30	The
	31	.Nm
	32	command displays information about the host system on which the command is executing.
	33	The output includes
	34	a kernel version description,
	35	processor configuration data,
	36	available physical memory,
	37	and various scheduling statistics.
	38	.Pp
	39	.Sh OPTIONS
	40	There are no options.
	41	.Sh DISPLAY
	42	.Pp
	43	.Bl -ohang -width Primary_memory_available_ -offset indent
	44	.It Mach kernel version:
	45	The version string compiled into the kernel executing on the host system.
	46	.Pp
	47	.It Processor Configuration:
	48	The maximum possible processors for which the kernel is configured,
09fd88e4	49	followed by the number of physical and logical processors available.
83f6dbe8 A	50	.Pp
	51	.It Processor type:
	52	The host's processor type and subtype.
	53	.Pp
	54	.It Processor active:
	55	A list of active processors on the host system.
	56	Active processors are members of a processor set and are ready to
	57	dispatch threads.
	58	On a single processor system, the active processor, is processor 0.
	59	.Pp
	60	.It Primary memory available:
	61	The amount of physical memory that is configured for use on the host system.
	62	.Pp
	63	.It Default processor set:
	64	Displays the number of tasks currently assigned to the host processor set,
	65	the number of threads currently assigned to the host processor set,
	66	and the number of processors included in the host processor set.
	67	.Pp
	68	.It Load average:
	69	Measures the average number of threads in the run queue.
	70	.Pp
	71	.It Mach factor:
	72	A variant of the load average which measures
	73	the processing resources available to a new thread.
	74	Mach factor is based on the number of CPUs divided by (1 + the number of runnablethreads)
	75	or
	76	the number of CPUs minus the number of runnable threads when the number of runnable threads
	77	is less than the number of CPUs.
	78	The closer the Mach factor value is to zero, the higher the load.
	79	On an idle system with a fixed number of active processors, the mach factor will be equal to the number of CPUs.
	80	.El
	81	.Sh SEE ALSO
	82	.\" List links in ascending order by section, alphabetically within a section.
	83	.Xr sysctl 8
	84	.\" .Sh BUGS \" Document known, unremedied bugs