usr/src/man/man1m/pmconfig.1m

   1 '\" te
   2 .\"  Copyright (c) 2004, 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 PMCONFIG 1M "Aug 12, 2004"
   7 .SH NAME
   8 pmconfig \- Configure the Power Management system
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/pmconfig\fR [\fB-r\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBpmconfig\fR utility sets the Power Management and  suspend-resume
  19 configuration. User has permission to change Power Management configuration
  20 using \fBpmconfig\fR only if he is allowed to do so according to
  21 \fBPMCHANGEPERM \fRkeyword of \fB/etc/default/power\fR. User has permission to
  22 change  the suspend-resume  configuration using \fBpmconfig\fR only if he is
  23 allowed to do so according to the \fBCPRCHANGEPERM \fRkeyword of
  24 \fB/etc/default/power\fR. See FILES section below for a description of the
  25 \fBPMCHANGEPERM \fRand \fBCPRCHANGEPERM \fR keywords of
  26 \fB/etc/default/power\fR.
  27 .sp
  28 .LP
  29 Based on user permissions, \fBpmconfig\fR first resets the  Power Management
  30 and/or   suspend-resume  state back to its default and then reads the new
  31 Power Management and/or   suspend-resume  configuration from
  32 \fB/etc/power.conf\fR and issues the commands to activiate the new
  33 configuration. The \fBpmconfig\fR utility is run at system boot. This utility
  34 can also be run from the command line after manual changes have been made to
  35 the \fB/etc/power.conf\fR file. For editing changes made to the
  36 \fB/etc/power.conf\fR file to take effect, users must run \fBpmconfig\fR.
  37 .sp
  38 .LP
  39 The preferred interface for changing  Power Management and suspend-resume
  40 configuration is \fBdtpower\fR(1M).
  41 .SH OPTIONS
  42 .sp
  43 .LP
  44 The following options are supported:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB-r\fR\fR
  49 .ad
  50 .RS 6n
  51  Reset  Power Management and suspend-resume  state to default and exit. User
  52 must have both  Power Management and suspend-resume  configuration permission
  53 for this option.
  54 .RE
  55
  56 .SH EXIT STATUS
  57 .sp
  58 .LP
  59 The following exit values are returned:
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB0\fR\fR
  64 .ad
  65 .RS 5n
  66 Upon successful completion
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB>0\fR\fR
  73 .ad
  74 .RS 6n
  75 An error occurred
  76 .RE
  77
  78 .SH FILES
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB/etc/power.conf\fR\fR
  83 .ad
  84 .RS 22n
  85 System  Power Management configuration file
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fB/etc/default/power\fR\fR
  92 .ad
  93 .RS 22n
  94 File that controls permissions for system's  Power Management and
  95 suspend-resume  features. The \fBPMCHANGEPERM\fR keyboard controls the Power
  96 Management configuration permissions, while the \fBCPRCHANGEPERM \fRkeyword
  97 controls the  suspend-resume  configuration permissions.
  98 .RE
  99
 100 .sp
 101 .LP
 102 Allowed values are:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBall\fR\fR
 107 .ad
 108 .RS 22n
 109 Any user can change the configuration.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-\fR\fR
 116 .ad
 117 .RS 22n
 118 No one except super-user can change the configuration.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB<user1, user2,...>\fR\fR
 125 .ad
 126 .RS 22n
 127 A  user in this user list or a super-user can change the configuration. The
 128 user list is a space and/or comma (,) separated list. You must enclose the list
 129 in < and > characters.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBconsole-owner\fR\fR
 136 .ad
 137 .RS 22n
 138 A  user who owns the system console device node or a super-user can change the
 139 configuration.
 140 .RE
 141
 142 .sp
 143 .LP
 144 The default values are \fBPMCHANGEPERM=console-owner\fR and
 145 \fBCPRCHANGEPERM=console-owner\fR.
 146 .SH ATTRIBUTES
 147 .sp
 148 .LP
 149 See \fBattributes\fR(5) for descriptions of the following attributes:
 150 .sp
 151
 152 .sp
 153 .TS
 154 box;
 155 c | c
 156 l | l .
 157 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 158 _
 159 Interface stability     Unstable
 160 .TE
 161
 162 .SH SEE ALSO
 163 .sp
 164 .LP
 165 \fBsvcs\fR(1), \fBpowerd\fR(1M), \fBpower.conf\fR(4), \fBsvcadm\fR(1M),
 166 \fBattributes\fR(5), \fBsmf\fR(5), \fBcpr\fR(7), \fBpm\fR(7D)
 167 .sp
 168 .LP
 169 \fIUsing Power Management\fR
 170 .SH NOTES
 171 .sp
 172 .LP
 173 The \fBpmconfig\fR service is managed by the service management facility,
 174 \fBsmf\fR(5), under the service identifier:
 175 .sp
 176 .in +2
 177 .nf
 178 svc:/system/power:default
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .sp
 184 .LP
 185 Administrative actions on this service, such as enabling, disabling, or
 186 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 187 status can be queried using the \fBsvcs\fR(1) command.
 188 .SH DIAGNOSTICS
 189 .sp
 190 .LP
 191 If the program cannot open the configuration file, it prints an error message
 192 to standard error. If the program encounters a syntax error in the
 193 configuration file, it prints an error message and the line number of the error
 194 in the  configuration file. It then skips the rest of the information on that
 195 line and processes the next line. Any configuration information already
 196 processed on the line containing the error is used. If user does not have
 197 permission to change Power Management and/or  suspend-resume configuration, and
 198 configuration file has entries for which user doesn't have permission, it
 199 process the entries for which user has permissions and prints error on rest.