xref: /freebsd/usr.sbin/devinfo/devinfo.8 (revision acd546f01e58354af049455472980c6c4a52e18b)
1.\"
2.\" SPDX-License-Identifer: BSD-2-Clause
3.\"
4.\" Copyright (c) 2002 Hiten Pandya
5.\" Copyright (c) 2002 Robert N. M. Watson
6.\"
7.\" All rights reserved.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.Dd August 28, 2025
30.Dt DEVINFO 8
31.Os
32.Sh NAME
33.Nm devinfo
34.Nd print information about system device configuration
35.Sh SYNOPSIS
36.Nm
37.Op Fl -libxo
38.Op Fl rv
39.Nm
40.Op Fl -libxo
41.Fl p Ar dev Op Fl v
42.Nm
43.Op Fl -libxo
44.Fl u Op Fl v
45.Sh DESCRIPTION
46The
47.Nm
48utility, without any arguments, shows the hierarchy of devices available
49in the system, starting from the
50.Dq nexus
51device.
52.Pp
53The following options are accepted:
54.Bl -tag -width "--libxo"
55.It Fl -libxo
56Generate output via
57.Xr libxo 3
58in a selection of different human and machine readable formats.
59See
60.Xr xo_options 7
61for details on command line arguments.
62.It Fl p Ar dev
63Display the path of
64.Ar dev
65back to the root of the device tree.
66.It Fl r
67Causes hardware resource information
68.Pq such as IRQ, I/O ports, I/O memory addresses
69to be also listed, under each device that has reserved those resources.
70.It Fl u
71Displays the same information as with
72.Fl r
73but sorts by resource type rather than by device, allowing to review the
74set of system resources by usage and available resources.
75I.e., it lists all
76the IRQ consumers together.
77.It Fl v
78Display all devices in the driver tree, not just those that are attached or
79busy.
80Without this flag, only those devices that have attached are reported.
81This flag also displays verbose information about each device.
82.El
83.Sh SEE ALSO
84.Xr systat 1 ,
85.Xr devinfo 3 ,
86.Xr libxo 3 ,
87.Xr xo_options 7 ,
88.Xr devctl 8 ,
89.Xr iostat 8 ,
90.Xr pciconf 8 ,
91.Xr vmstat 8 ,
92.Xr devclass 9 ,
93.Xr device 9
94.Sh HISTORY
95The
96.Nm
97utility appeared in
98.Fx 5.0 .
99.Sh AUTHORS
100.An Mike Smith Aq Mt msmith@FreeBSD.org
101