11622 clean up rarer mandoc lint warnings
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" Copyright 2012, Joyent, Inc. All Rights Reserved
4 .\" Copyright 2019, Peter tribble.
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
6 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
7 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH PRTCONF 1M "Jan 21, 2019"
9 .SH NAME
10 prtconf \- print system configuration
11 .SH SYNOPSIS
12 .nf
13 \fB/usr/sbin/prtconf\fR [\fB-V\fR] | [\fB-F\fR] | [\fB-m\fR] | [\fB-x\fR] | [\fB-bpv\fR] | [\fB-acdDPv\fR]
14 [\fIdev_path\fR]
15 .fi
16
17 .SH DESCRIPTION
18 The \fBprtconf\fR command prints the system configuration information. The
19 output includes the total amount of memory, and the configuration of system
20 peripherals formatted as a device tree.
21 .sp
22 .LP
23 If a device path is specified on the command line for those command options
24 that can take a device path, \fBprtconf\fR will only display information for
25 that device node.
26 .SH OPTIONS
27 The following options are supported:
28 .sp
29 .ne 2
30 .na
31 \fB-a\fR
32 .ad
33 .RS 6n
34 Display all the ancestors device nodes, up to the root node of the device tree,
35 for the device specified on the command line.
36 .RE
37
38 .sp
39 .ne 2
40 .na
41 \fB-b\fR
42 .ad
43 .RS 6n
44 Display the firmware device tree root properties for the purpose of platform
45 identification. These properties are "name", "compatible", "banner-name" and
46 "model".
47 .RE
48
49 .sp
50 .ne 2
51 .na
52 \fB-c\fR
53 .ad
54 .RS 6n
55 Display the device subtree rooted at the device node specified on the command
56 line, that is, display all the children of the device node specified on the
57 command line.
58 .RE
59
60 .sp
61 .ne 2
62 .na
63 \fB-d\fR
64 .ad
65 .RS 6n
66 Display vendor ID and device ID for PCI and PCI Express devices, in addition to
67 the nodename. If the information is known, the vendor name and device name will
68 also be shown.
69 .RE
70
71 .sp
72 .ne 2
73 .na
74 \fB-D\fR
75 .ad
76 .RS 6n
77 For each system peripheral in the device tree, displays the name of the device
78 driver used to manage the peripheral.
79 .RE
80
81 .sp
82 .ne 2
83 .na
84 \fB-F\fR
85 .ad
86 .RS 6n
87 Returns the device path name of the console frame buffer,
88 if one exists. If there is no frame buffer, \fBprtconf\fR returns a non-zero
89 exit code. This flag must be used by itself. It returns only the name of the
90 console, frame buffer device or a non-zero exit code. For example, if the
91 console frame buffer on a SUNW,Ultra-30 is \fBffb\fR, the command returns:
92 \fB/SUNW,ffb@1e,0:ffb0\fR. This option could be used to create a symlink for
93 \fB/dev/fb\fR to the actual console device.
94 .RE
95
96 .sp
97 .ne 2
98 .na
99 \fB-m\fR
100 .ad
101 .RS 6n
102 Displays the amount of system memory in megabytes.
103 This flag must be used by itself.
104 .RE
105
106
107 .ne 2
108 .na
109 \fB-p\fR
110 .ad
111 .RS 6n
112 Displays information derived from the device tree provided by the firmware
113 (PROM) on SPARC platforms or the booting system on x86 platforms.The device
114 tree information displayed using this option is a snapshot of the initial
115 configuration and may not accurately reflect reconfiguration events that occur
116 later.
117 .RE
118
119 .sp
120 .ne 2
121 .na
122 \fB-P\fR
123 .ad
124 .RS 6n
125 Includes information about pseudo devices. By default, information regarding
126 pseudo devices is omitted.
127 .RE
128
129 .sp
130 .ne 2
131 .na
132 \fB-v\fR
133 .ad
134 .RS 6n
135 Specifies verbose mode.
136 .RE
137
138 .sp
139 .ne 2
140 .na
141 \fB-V\fR
142 .ad
143 .RS 6n
144 Displays platform-dependent \fBPROM\fR (on SPARC platforms) or booting system
145 (on x86 platforms) version information. This flag must be used by itself. The
146 output is a string. The format of the string is arbitrary and
147 platform-dependent.
148 .RE
149
150 .sp
151 .ne 2
152 .na
153 \fB-x\fR
154 .ad
155 .RS 6n
156 A legacy flag that reported if the firmware on this system is 64-bit ready.
157 As illumos only runs on 64-bit platforms, this flag is kept for compatibility
158 only, and zero is always returned.
159 .sp
160 This flag overrides all other flags and must be used by itself.
161 .RE
162
163 .SH OPERANDS
164 The following operands are supported:
165 .sp
166 .ne 2
167 .na
168 \fIdev_path\fR
169 .ad
170 .RS 12n
171 The path to a target device minor node, device nexus node, or device link for
172 which device node configuration information is displayed
173 .RE
174
175 .SH EXIT STATUS
176 The following exit values are returned:
177 .sp
178 .ne 2
179 .na
180 \fB0\fR
181 .ad
182 .RS 12n
183 No error occurred.
184 .RE
185
186 .sp
187 .ne 2
188 .na
189 \fBnon-zero\fR
190 .ad
191 .RS 12n
192 With the \fB-F\fR option, a non-zero return value means that the
193 output device is not a frame buffer. In all other cases, a
194 non-zero return value means that an error occurred.
195 .RE
196
197 .SH ATTRIBUTES
198 See \fBattributes\fR(5) for descriptions of the following attributes:
199 .sp
200
201 .sp
202 .TS
203 box;
204 c | c
205 l | l .
206 ATTRIBUTE TYPE ATTRIBUTE VALUE
207 Interface Stability Unstable
208 .TE
209
210 .SH SEE ALSO
211 \fBfuser\fR(1M), \fBmodinfo\fR(1M), \fBsysdef\fR(1M), \fBattributes\fR(5),
212 \fBopenprom\fR(7D)
213 .SH NOTES
214 The output of the \fBprtconf\fR command is highly dependent on the version of
215 the \fBPROM\fR installed in the system. The output will be affected in
216 potentially all circumstances.
217 .sp
218 .LP
219 The \fBdriver not attached\fR message means that no driver is currently
220 attached to that instance of the device. In general, drivers are loaded and
221 installed (and attached to hardware instances) on demand, and when needed, and
222 may be uninstalled and unloaded when the device is not in use.
223 .sp
224 .LP
225 On x86 platforms, the use of \fBprtconf\fR \fB-vp\fR provides a subset of
226 information from \fBprtconf\fR \fB-v\fR. The value of integer properties from
227 \fBprtconf\fR \fB-vp\fR might require byte swapping for correct interpretation.
--- EOF ---