Print this page
11583 Some man3lib pages are missing parts of the SYNOPSIS
*** 1,22 ****
'\" te
.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.\" 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. 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
! .TH LIBPOOL 3LIB "April 9, 2016"
.SH NAME
libpool \- pool configuration manipulation library
.SH SYNOPSIS
- .LP
.nf
! \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
#include <\fBpool.h\fR>
.fi
.SH DESCRIPTION
- .LP
The functions in this library define the interface for reading and writing
resource pools configuration files, as well as that for committing an existing
configuration to becoming the running OS configuration (with respect to
partitioning subsystems). The <\fBpool.h\fR> header provides type and function
declarations for all library services.
--- 1,20 ----
'\" te
.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.\" 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. 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
! .TH LIBPOOL 3LIB "Aug 19, 2019"
.SH NAME
libpool \- pool configuration manipulation library
.SH SYNOPSIS
.nf
! \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpool\fR [ \fIlibrary\fR... ]
#include <\fBpool.h\fR>
.fi
.SH DESCRIPTION
The functions in this library define the interface for reading and writing
resource pools configuration files, as well as that for committing an existing
configuration to becoming the running OS configuration (with respect to
partitioning subsystems). The <\fBpool.h\fR> header provides type and function
declarations for all library services.
*** 126,136 ****
and the specified pool exists, this property has no effect. If the specified
pool does not exist, perhaps because of a reconfiguration, then this property
controls the binding behavior for the project member. If
\fBsystem.bind-default\fR is true, then the project member is bound to the
default pool (identified as the pool for which \fBpool.default\fR is true);
! otherise the project member is refused access to the system. Care should be
taken with the pools configuration if this property is set to false, so as to
avoid denying users access to the system.
.sp
.LP
The various \fBpoold\fR properties are used to configure the operation of
--- 124,134 ----
and the specified pool exists, this property has no effect. If the specified
pool does not exist, perhaps because of a reconfiguration, then this property
controls the binding behavior for the project member. If
\fBsystem.bind-default\fR is true, then the project member is bound to the
default pool (identified as the pool for which \fBpool.default\fR is true);
! otherwise the project member is refused access to the system. Care should be
taken with the pools configuration if this property is set to false, so as to
avoid denying users access to the system.
.sp
.LP
The various \fBpoold\fR properties are used to configure the operation of
*** 278,314 ****
.LP
There are two types of objectives that can be set on a \fBpset\fR:
.sp
.ne 2
.na
! \fB\fBlocality\fR\fR
.ad
.RS 15n
This objective influences the impact that locality, as measured by lgroup data,
has upon the chosen configuration. This objective can take one of three values:
.sp
.ne 2
.na
! \fB\fBtight\fR\fR
.ad
.RS 9n
If set, configurations that maximize resource locality are favored.
.RE
.sp
.ne 2
.na
! \fB\fBloose\fR\fR
.ad
.RS 9n
If set, configurations that minimize resource locality are favored.
.RE
.sp
.ne 2
.na
! \fB\fBnone\fR\fR
.ad
.RS 9n
This is the default value for this objective. If set, configuration
favorability is uninfluenced by resource locality.
.RE
--- 276,312 ----
.LP
There are two types of objectives that can be set on a \fBpset\fR:
.sp
.ne 2
.na
! \fBlocality\fR
.ad
.RS 15n
This objective influences the impact that locality, as measured by lgroup data,
has upon the chosen configuration. This objective can take one of three values:
.sp
.ne 2
.na
! \fBtight\fR
.ad
.RS 9n
If set, configurations that maximize resource locality are favored.
.RE
.sp
.ne 2
.na
! \fBloose\fR
.ad
.RS 9n
If set, configurations that minimize resource locality are favored.
.RE
.sp
.ne 2
.na
! \fBnone\fR
.ad
.RS 9n
This is the default value for this objective. If set, configuration
favorability is uninfluenced by resource locality.
.RE
*** 316,326 ****
.RE
.sp
.ne 2
.na
! \fB\fButilization\fR\fR
.ad
.RS 15n
This objective favors configurations that allocate resources to partitions that
are failing to preserve the specified utilization objective.
.RE
--- 314,324 ----
.RE
.sp
.ne 2
.na
! \fButilization\fR
.ad
.RS 15n
This objective favors configurations that allocate resources to partitions that
are failing to preserve the specified utilization objective.
.RE
*** 330,360 ****
These objectives are specified in terms of an operator and a value. The
operators are
.sp
.ne 2
.na
! \fB\fB<\fR\fR
.ad
.RS 5n
The ``less than'' operator is used to indicate that the specified value should
be treated as a maximum target value.
.RE
.sp
.ne 2
.na
! \fB\fB>\fR\fR
.ad
.RS 5n
The ``greater than'' operator is used to indicate that the specified value
should be treated as a minimum target value.
.RE
.sp
.ne 2
.na
! \fB\fB~\fR\fR
.ad
.RS 5n
The ``about'' operator is used to indicate that the specified value should be
treated as a target value about which some fluctuation is acceptable.
.RE
--- 328,358 ----
These objectives are specified in terms of an operator and a value. The
operators are
.sp
.ne 2
.na
! \fB<\fR
.ad
.RS 5n
The ``less than'' operator is used to indicate that the specified value should
be treated as a maximum target value.
.RE
.sp
.ne 2
.na
! \fB>\fR
.ad
.RS 5n
The ``greater than'' operator is used to indicate that the specified value
should be treated as a minimum target value.
.RE
.sp
.ne 2
.na
! \fB~\fR
.ad
.RS 5n
The ``about'' operator is used to indicate that the specified value should be
treated as a target value about which some fluctuation is acceptable.
.RE
*** 387,415 ****
.LP
The \fBcpu.status\fR property can be set only to the following values:
.sp
.ne 2
.na
! \fB\fBoff-line\fR\fR
.ad
.RS 12n
Set the CPU offline.
.RE
.sp
.ne 2
.na
! \fB\fBon-line\fR\fR
.ad
.RS 12n
Set the CPU online.
.RE
.sp
.ne 2
.na
! \fB\fBno-intr\fR\fR
.ad
.RS 12n
Disable interrupt processing on the CPU.
.RE
--- 385,413 ----
.LP
The \fBcpu.status\fR property can be set only to the following values:
.sp
.ne 2
.na
! \fBoff-line\fR
.ad
.RS 12n
Set the CPU offline.
.RE
.sp
.ne 2
.na
! \fBon-line\fR
.ad
.RS 12n
Set the CPU online.
.RE
.sp
.ne 2
.na
! \fBno-intr\fR
.ad
.RS 12n
Disable interrupt processing on the CPU.
.RE
*** 416,426 ****
.sp
.LP
These values are defined in <\fBsys/processor.h\fR> as the \fBPS_OFFLINE\fR,
\fBPS_ONLINE\fR, and \fBPS_NOINTR\fR macros.
.SH INTERFACES
- .LP
The shared object \fBlibpool.so.1\fR provides the public interfaces defined
below. See \fBIntro\fR(3) for additional information on shared object
interfaces.
.sp
--- 414,423 ----
*** 466,492 ****
.TE
.SH FILES
.ne 2
.na
! \fB\fB/usr/lib/libpool.so.1\fR\fR
.ad
.RS 28n
shared object
.RE
.sp
.ne 2
.na
! \fB\fB/usr/lib/64/libpool.so.1\fR\fR
.ad
.RS 28n
64-bit shared object
.RE
.SH ATTRIBUTES
- .LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
--- 463,488 ----
.TE
.SH FILES
.ne 2
.na
! \fB/usr/lib/libpool.so.1\fR
.ad
.RS 28n
shared object
.RE
.sp
.ne 2
.na
! \fB/usr/lib/64/libpool.so.1\fR
.ad
.RS 28n
64-bit shared object
.RE
.SH ATTRIBUTES
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
*** 501,519 ****
_
MT-Level Safe
.TE
.SH SEE ALSO
- .LP
\fBIntro\fR(3), \fBpool_component_info\fR(3POOL), \fBpool_conf_open\fR(3POOL),
\fBpool_conf_to_elem\fR(3POOL), \fBpool_create\fR(3POOL),
\fBpool_error\fR(3POOL), \fBpool_get_binding\fR(3POOL),
\fBpool_get_property\fR(3POOL), \fBpool_get_resource\fR(3POOL),
\fBpool_resource_create\fR(3POOL), \fBpool_value_alloc\fR(3POOL),
\fBpool_walk_pools\fR(3POOL), \fBattributes\fR(5), \fBsmf\fR(5)
.SH NOTES
- .LP
Functions in \fBlibpool\fR can be used to manipulate static configurations even
when the pools facility is not enabled. See \fBpooladm\fR(1M) and
\fBpool_set_status\fR(3POOL) for more information about enabling the pools
facility. The pools facility must be enabled, however, to modify the dynamic
configuration.
--- 497,513 ----