freebsd-skq/usr.sbin/devinfo/devinfo.8

.\" -*- nroff -*-
.\"
.\" Copyright (c) 2002 Hiten Pandya
.\" Copyright (c) 2002 Robert N. M. Watson
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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.
.\"
.\" $FreeBSD$
.\"
.Dd November 28, 2005
.Dt DEVINFO 8
.Os
.Sh NAME
.Nm devinfo
.Nd print information about system device configuration
.Sh SYNOPSIS
.Nm
.Op Fl rv
.Nm
.Fl u
.Sh DESCRIPTION
The
.Nm
utility, without any arguments, shows the hierarchy of devices available
in the system, starting from the
.Dq nexus
device.
.Pp
The following options are accepted.
.Bl -tag -width indent
.It Fl r
Causes hardware resource information (such as IRQ, I/O ports, I/O memory
addresses) to be also listed, under each device that has reserved those resources.
.It Fl u
Displays the same information as with
.Fl r
but sorts by resource type rather than by device, allowing to review the
set of system resources by usage and available resources.
I.e., it lists all
the IRQ consumers together.
.It Fl v
Display all devices in the driver tree, not just those that are attached or
busy.
Without this flag, only those devices that have attached are reported.
.El
.Sh SEE ALSO
.Xr systat 1 ,
.Xr devinfo 3 ,
.Xr iostat 8 ,
.Xr pciconf 8 ,
.Xr pnpinfo 8 ,
.Xr vmstat 8 ,
.Xr devclass 9 ,
.Xr device 9
.Sh AUTHORS
.An Mike Smith Aq msmith@FreeBSD.org
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.\" -- nroff --`
			`.\"`
			`.\" Copyright (c) 2002 Hiten Pandya`
			`.\" Copyright (c) 2002 Robert N. M. Watson`
			`.\"`
			`.\" 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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Follow the rules for the .Dd macro use: use unabbreviated month names. Submitted by: ru 2005-11-28 13:51:36 +00:00			`.Dd November 28, 2005`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Dt DEVINFO 8`
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors) 2010-04-14 19:08:06 +00:00			`.Os`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Sh NAME`
Remove EOL space. This is a whitespace only change. Reviewed by: rwatson, Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-13 08:37:46 +00:00			`.Nm devinfo`
o Uncapitalize .Nd macro arguments and remove punctuation o Minor grammar fixes. o Sort SEE ALSO references, and add iostat(8). o Delete punctuation at end of AUTHORS' section only line Reviewed by: rwatson, Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-13 08:40:07 +00:00			`.Nd print information about system device configuration`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Sh SYNOPSIS`
			`.Nm`
Use a separate synopsis line for -u as devinfo will ignore other options when -u is specified. Xref device(9) and devclass(9). 2005-11-28 01:33:19 +00:00			`.Op Fl rv`
			`.Nm`
Sync usage() and SYNOPSIS. 2006-09-29 16:46:01 +00:00			`.Fl u`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Sh DESCRIPTION`
mdoc(7) police: Make this look like an average manpage. 2002-05-30 14:26:02 +00:00			`The`
			`.Nm`
			`utility, without any arguments, shows the hierarchy of devices available`
Typo fix: syste -> system 2002-05-31 01:46:26 +00:00			`in the system, starting from the`
mdoc(7) police: Make this look like an average manpage. 2002-05-30 14:26:02 +00:00			`.Dq nexus`
o Uncapitalize .Nd macro arguments and remove punctuation o Minor grammar fixes. o Sort SEE ALSO references, and add iostat(8). o Delete punctuation at end of AUTHORS' section only line Reviewed by: rwatson, Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-13 08:40:07 +00:00			`device.`
Remove EOL space. This is a whitespace only change. Reviewed by: rwatson, Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-13 08:37:46 +00:00			`.Pp`
mdoc(7) police: Make this look like an average manpage. 2002-05-30 14:26:02 +00:00			`The following options are accepted.`
			`.Bl -tag -width indent`
			`.It Fl r`
			`Causes hardware resource information (such as IRQ, I/O ports, I/O memory`
			`addresses) to be also listed, under each device that has reserved those resources.`
			`.It Fl u`
			`Displays the same information as with`
			`.Fl r`
			`but sorts by resource type rather than by device, allowing to review the`
			`set of system resources by usage and available resources.`
			`I.e., it lists all`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`the IRQ consumers together.`
o Don't print devices that aren't attached unless run with the newly minted -v flag. o Print devices that don't return a name as 'unknown' in -v mode. # Yea! Now I wont think I have 10 different ISA network adapters in my # laptop. 2002-09-20 02:26:58 +00:00			`.It Fl v`
			`Display all devices in the driver tree, not just those that are attached or`
			`busy.`
			`Without this flag, only those devices that have attached are reported.`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.El`
			`.Sh SEE ALSO`
o Uncapitalize .Nd macro arguments and remove punctuation o Minor grammar fixes. o Sort SEE ALSO references, and add iostat(8). o Delete punctuation at end of AUTHORS' section only line Reviewed by: rwatson, Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-13 08:40:07 +00:00			`.Xr systat 1 ,`
			`.Xr devinfo 3 ,`
			`.Xr iostat 8 ,`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Xr pciconf 8 ,`
			`.Xr pnpinfo 8 ,`
Use a separate synopsis line for -u as devinfo will ignore other options when -u is specified. Xref device(9) and devclass(9). 2005-11-28 01:33:19 +00:00			`.Xr vmstat 8 ,`
			`.Xr devclass 9 ,`
			`.Xr device 9`
Add a man page for the devinfo command; I'd argue devinfo is the single most useful new command added to FreeBSD 5.0, but maybe that's just me :-). Submitted by: Hiten Pandya <hiten@uk.FreeBSD.org> 2002-05-12 14:23:15 +00:00			`.Sh AUTHORS`
mdoc(7) police: Make this look like an average manpage. 2002-05-30 14:26:02 +00:00			`.An Mike Smith Aq msmith@FreeBSD.org`