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

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