Unleashed v1.4
[unleashed.git] / share / man / man8 / devprop.8
blobd0cd33f41a73fa6ff87a07ab397683d44f35504e
1 '\" te
2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DEVPROP 8 "Sep 26, 2007"
7 .SH NAME
8 devprop \- display device properties
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/sbin/devprop\fR [\fB-n\fR \fIdevice-path\fR] [\fB-vq\fR] [-\fB{b|i|l|s}\fR] [\fIproperty\fR[...]]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBdevprop\fR command displays named device properties from the device
19 tree.
20 .sp
21 .LP
22 If a device path is specified on the command line, \fBdevprop\fR displays
23 device properties for that device node.
24 .sp
25 .LP
26 The output formats, while Volatile, are patterned after those of
27 \fBprtconf\fR(8).
28 .SH OPTIONS
29 .sp
30 .LP
31 The following options are supported:
32 .sp
33 .ne 2
34 .na
35 \fB\fB-b\fR\fR
36 .ad
37 .sp .6
38 .RS 4n
39 The properties to be output are sequences of bytes (\fBDI_PROP_TYPE_BYTES\fR).
40 \fB-b\fR, \fB-i\fR, \fB-l\fR, and \fB-s\fR are mutually exclusive of one
41 another.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fB-i\fR\fR
48 .ad
49 .sp .6
50 .RS 4n
51 The properties to be output are integers (\fBDI_PROP_TYPE_INT\fR).
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fB-l\fR\fR
58 .ad
59 .sp .6
60 .RS 4n
61 The properties to be output are 64-bit integers (\fBDI_PROP_TYPE_INT64\fR).
62 .RE
64 .sp
65 .ne 2
66 .na
67 \fB\fB-s\fR\fR
68 .ad
69 .sp .6
70 .RS 4n
71 The properties to be output are strings (\fBDI_PROP_TYPE_STRING\fR) (the
72 default).
73 .RE
75 .sp
76 .ne 2
77 .na
78 \fB\fB-n\fR \fIdevice-path\fR\fR
79 .ad
80 .sp .6
81 .RS 4n
82 The path to a target device node for which properties are displayed. The
83 default path is that of the root node (equivalent to specifying \fB-n\fR
84 \fB/\fR).
85 .RE
87 .sp
88 .ne 2
89 .na
90 \fB\fB-q\fR\fR
91 .ad
92 .sp .6
93 .RS 4n
94 Specifies quoted output mode, in which string properties are output surrounded
95 by double quotation marks (\fB"\fR).
96 .RE
98 .sp
99 .ne 2
101 \fB\fB-v\fR\fR
103 .sp .6
104 .RS 4n
105 Specifies verbose mode, in which the name of the property is output before its
106 value.
109 .SH OPERANDS
112 The following operand is supported:
114 .ne 2
116 \fB\fIproperty\fR...\fR
118 .sp .6
119 .RS 4n
120 Name of the property to be displayed.
123 .SH EXIT STATUS
125 .ne 2
127 \fB\fB0\fR\fR
129 .sp .6
130 .RS 4n
131 No error occurred.
135 .ne 2
137 \fB\fBnon-zero\fR\fR
139 .sp .6
140 .RS 4n
141 An error occurred.
144 .SH ATTRIBUTES
147 See \fBattributes\fR(5) for descriptions of the following attributes:
152 box;
153 c | c
154 l | l .
155 ATTRIBUTE TYPE  ATTRIBUTE VALUE
157 Interface Stability     See below.
162 The command invocation and output are both Volatile. The location of the
163 utility is Committed.
164 .SH SEE ALSO
167 \fBprtconf\fR(8), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)