usr/src/man/man1m/hal-get-property.1m

   1 '\" te
   2 .\" Copyright (c) 2006, 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 HAL-GET-PROPERTY 1M "Sep 7, 2018"
   7 .SH NAME
   8 hal-get-property, hal-set-property \- get and set HAL device properties
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBhal-get-property\fR \fB--udi\fR \fIudi\fR \fB--key\fR \fIkey\fR [\fB--help\fR] [\fB--verbose\fR]
  13  [\fB--version\fR]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fBhal-set-property\fR  \fB--udi\fR \fIudi\fR \fB--key\fR \fIkey\fR {\fB--int\fR \fIvalue\fR |  \fB--uint64\fR \fIvalue\fR
  19  |  \fB--string\fR \fIvalue\fR |  \fB--bool\fR \fIvalue\fR |  \fB--strlist-pre\fR \fIvalue\fR
  20  |  \fB--strlist-post\fR \fIvalue\fR |  \fB--strlist-rem\fR \fIvalue\fR |  \fB--double\fR \fIvalue\fR
  21  |  \fB--remove\fR \fIvalue\fR} [\fB--direct\fR] [\fB--help\fR] [\fB--version\fR]
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .LP
  26 The Hardware Abstraction Layer (HAL) provides a view of the various hardware
  27 attached to a system. This view is updated dynamically as hardware
  28 configuration changes by means of hotplug or other mechanisms. HAL represents a
  29 piece of hardware as a device object. A device object is identified by a unique
  30 identifier and carries a set of key/value pairs, referred to as device
  31 properties. Some properties are derived from the actual hardware, some are
  32 merged from device information files (\fB\&.fdi\fR files), and some are related
  33 to the actual device configuration.
  34 .sp
  35 .LP
  36 The \fBhal-get-property\fR and \fBhal-set-property\fR commands allow you to get
  37 and set properties of hardware that conforms to HAL specifications.
  38 .SH OPTIONS
  39 .LP
  40 The following options are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB--udi\fR \fIudi\fR\fR
  45 .ad
  46 .sp .6
  47 .RS 4n
  48 Unique device ID.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB--key\fR \fIkey\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 Key of the property to set.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB--int\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Set value to an integer. Accepts decimal or hexadecimal value prefixed with
  69 \fB0x\fR or \fBx\fR.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB--uint64\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Set value to an integer. Accepts decimal or hexadecimal value prefixed with
  80 \fB0x\fR or \fBx\fR.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fB--string\fR \fIvalue\fR\fR
  87 .ad
  88 .sp .6
  89 .RS 4n
  90 Set value to a string.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB--double\fR \fIvalue\fR\fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 Set value to a floating point number.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fB--boolean\fR \fIvalue\fR\fR
 107 .ad
 108 .sp .6
 109 .RS 4n
 110 Set value to a boolean, that is, true or false
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB--strlist-pre\fR \fIvalue\fR\fR
 117 .ad
 118 .sp .6
 119 .RS 4n
 120 Prepend a string to a list.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB--strlist-post\fR \fIvalue\fR\fR
 127 .ad
 128 .sp .6
 129 .RS 4n
 130 Append a string to a list.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fB--strlist-rem\fR \fIvalue\fR\fR
 137 .ad
 138 .sp .6
 139 .RS 4n
 140 Remove a string from a list.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fB--remove\fR \fIvalue\fR\fR
 147 .ad
 148 .sp .6
 149 .RS 4n
 150 Indicates that the property should be removed.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fB--direct\fR\fR
 157 .ad
 158 .sp .6
 159 .RS 4n
 160 Use direct HAL connection
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB--version\fR\fR
 167 .ad
 168 .sp .6
 169 .RS 4n
 170 Display version and exit.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fB--help\fR\fR
 177 .ad
 178 .sp .6
 179 .RS 4n
 180 Display list of options and exit
 181 .RE
 182
 183 .SH ATTRIBUTES
 184 .LP
 185 See \fBattributes\fR(5) for descriptions of the following attributes:
 186 .sp
 187
 188 .sp
 189 .TS
 190 box;
 191 c | c
 192 l | l .
 193 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 194 _
 195 Interface Stability     Volatile
 196 .TE
 197
 198 .SH SEE ALSO
 199 .LP
 200 \fBhald\fR(1M), \fBattributes\fR(5), \fBhal\fR(5)