diff options
Diffstat (limited to 'usr/src/man/man3perl')
-rw-r--r-- | usr/src/man/man3perl/Exacct.3perl | 325 | ||||
-rw-r--r-- | usr/src/man/man3perl/Exacct::Catalog.3perl | 217 | ||||
-rw-r--r-- | usr/src/man/man3perl/Exacct::File.3perl | 234 | ||||
-rw-r--r-- | usr/src/man/man3perl/Exacct::Object.3perl | 201 | ||||
-rw-r--r-- | usr/src/man/man3perl/Exacct::Object::Group.3perl | 116 | ||||
-rw-r--r-- | usr/src/man/man3perl/Exacct::Object::Item.3perl | 103 | ||||
-rw-r--r-- | usr/src/man/man3perl/Makefile | 32 | ||||
-rw-r--r-- | usr/src/man/man3perl/Privilege.3perl | 303 | ||||
-rw-r--r-- | usr/src/man/man3perl/Ucred.3perl | 235 |
9 files changed, 4 insertions, 1762 deletions
diff --git a/usr/src/man/man3perl/Exacct.3perl b/usr/src/man/man3perl/Exacct.3perl deleted file mode 100644 index 5a0aa40be3..0000000000 --- a/usr/src/man/man3perl/Exacct.3perl +++ /dev/null @@ -1,325 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT 3PERL "Dec 1, 2002" -.SH NAME -Exacct \- exacct system calls and error handling -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct qw(:EXACCT_ALL); -my $ea_rec = getacct(P_PID, $$); -.fi - -.SH DESCRIPTION -.sp -.LP -This module provides access to the \fBea_error\fR(3EXACCT) function and for all -the extended accounting system calls. Constants from the various -\fBlibexacct\fR(3LIB) header files are also provided. -.SS "Constants" -.sp -.LP -The \fBP_PID\fR, \fBP_TASKID\fR, \fBP_PROJID\fR and all the \fBEW_*\fR, -\fBEP_*\fR, \fBEXR_*\fR macros are provided as Perl constants. -.SS "Functions" -.sp -.ne 2 -.na -\fB\fBgetacct($idtype, $id)\fR\fR -.ad -.sp .6 -.RS 4n -The \fB$idtype\fR parameter must be either \fBP_TASKID\fR or \fBP_PID\fR and -\fB$id\fR must be a corresponding task or process ID. This function returns an -object of type \fBSun::Solaris::Exacct::Object\fR, representing the unpacked -accounting buffer returned by the underlying \fBgetacct\fR(2) system call. In -the event of error, \fBundef\fR is returned. -.RE - -.sp -.ne 2 -.na -\fB\fBputacct($idtype, $id, $record)\fR\fR -.ad -.sp .6 -.RS 4n -The \fB$idtype\fR parameter must be either \fBP_TASKID\fR or \fBP_PID\fR and -\fB$id\fR must be a corresponding task or process ID. If $record is of type -Sun::Solaris::Exacct::Object, it is converted to the corresponding packed -\fBlibexacct\fR object and passed to the \fBputacct\fR(2) system call. If -\fB$record\fR is not of type \fBSun::Solaris::Exacct::Object\fR it is converted -to a string using the normal Perl conversion rules and stored as a raw buffer. -For predictable and endian-independent results, any raw buffers should be -constructed using the Perl \fBpack()\fR function. This function returns true on -success and false on failure. -.RE - -.sp -.ne 2 -.na -\fB\fBwracct($idtype, $id, $flags)\fR\fR -.ad -.sp .6 -.RS 4n -The \fB$idtype\fR parameter must be either \fBP_TASKID\fR or \fBP_PID\fR and -\fB$id\fR must be a corresponding task or process ID. The \fB$flags\fR -parameter must be either \fBEW_INTERVAL\fR or \fBEW_PARTIAL\fR. The parameters -are passed directly to the underlying \fBwracct\fR(2) system call. This -function returns true on success and false on failure. -.RE - -.sp -.ne 2 -.na -\fB\fBea_error()\fR\fR -.ad -.sp .6 -.RS 4n -This function provides access to the \fBea_error\fR(3EXACCT) function. It -returns a double-typed scalar that becomes one of the EXR_* constants. In a -string context it becomes a descriptive error message. This is the exacct -equivalent to the \fB$!(errno)\fR Perl variable. -.RE - -.sp -.ne 2 -.na -\fB\fBea_error_str()\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a double-typed scalar that in a numeric context will be -one of the EXR_* constants as returned by ea_error. In a string context it -describes the value returned by ea_error. If ea_error returns EXR_SYSCALL_FAIL, -the string value returned is the value returned by \fBstrerror\fR(3C). This -function is provided as a convenience so that repeated blocks of code like the -following can be avoided: -.sp -.in +2 -.nf -if (ea_error() == EXR_SYSCALL_FAIL) { - print("error: $!\en"); -} else { - print("error: ", ea_error(), "\en"); -} -.fi -.in -2 - -.RE - -.sp -.ne 2 -.na -\fB\fBea_register_catalog($cat_pfx, $catalog_id, $export, @idlist)\fR\fR -.ad -.sp .6 -.RS 4n -This convenience function is a wrapper around the -\fBSun::Solaris::Exacct::Catalog->register()\fR method. -.RE - -.sp -.ne 2 -.na -\fB\fBea_new_catalog($integer)\fR\fR -.ad -.br -.na -\fB\fBea_new_catalog($cat_obj)\fR\fR -.ad -.br -.na -\fB\fBea_new_catalog($type, $catalog, $id)\fR\fR -.ad -.sp .6 -.RS 4n -These convenience functions are wrappers around the -\fBSun::Solaris::Exacct::Catalog->new()\fR method. See -\fBExacct::Catalog\fR(3PERL). -.RE - -.sp -.ne 2 -.na -\fB\fBea_new_file($name, $oflags, creator => $creator, aflags => $aflags, mode -=> $mode)\fR\fR -.ad -.sp .6 -.RS 4n -This convenience function is a wrapper around the -\fBSun::Solaris::Exacct::File->new()\fR method. See \fBExacct::File\fR(3PERL). -.RE - -.sp -.ne 2 -.na -\fB\fBea_new_item($catalog, $value)\fR\fR -.ad -.sp .6 -.RS 4n -This convenience function is a wrapper around the -\fBSun::Solaris::Exacct::Object::Item->new()\fR method. See -\fBExacct::Object::Item\fR(3PERL). -.RE - -.sp -.ne 2 -.na -\fB\fBea_new_group($catalog, @objects)\fR\fR -.ad -.sp .6 -.RS 4n -This convenience function is a wrapper around the -\fBSun::Solaris::Exacct::Object::Group->new()\fR method. See -\fBExacct::Object::Group\fR(3PERL). -.RE - -.sp -.ne 2 -.na -\fB\fBea_dump_object($object, $filehandle)\fR\fR -.ad -.sp .6 -.RS 4n -This convenience function is a wrapper around the -\fBSun::Solaris::Exacct::Object->dump()\fR method. See -\fBExacct::Object\fR(3PERL). -.RE - -.SS "Class methods" -.sp -.LP -None. -.SS "Object methods" -.sp -.LP -None. -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants and functions defined in this module: -.sp -.ne 2 -.na -\fB\fB:SYSCALLS\fR\fR -.ad -.RS 21n -\fBgetacct()\fR, \fBputacct()\fR, and \fBwracct()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:LIBCALLS\fR\fR -.ad -.RS 21n -\fBea_error()\fR and \fBea_error_str()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:CONSTANTS\fR\fR -.ad -.RS 21n -\fBP_PID\fR, \fBP_TASKID\fR, \fBP_PROJID\fR, \fBEW_*\fR, \fBEP_*\fR, and -\fBEXR_*\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:SHORTHAND\fR\fR -.ad -.RS 21n -\fBea_register_catalog()\fR, \fBea_new_catalog()\fR, \fBea_new_file()\fR, -\fBea_new_item()\fR, and \fBea_new_group()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.RS 21n -\fB:SYSCALLS\fR, \fB:LIBCALLS\fR, \fB:CONSTANTS\fR, and \fB:SHORTHAND\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:EXACCT_CONSTANTS\fR\fR -.ad -.RS 21n -\fB:CONSTANTS\fR, plus the \fB:CONSTANTS\fR tags for -\fBSun::Solaris::Catalog\fR, \fBSun::Solaris::File\fR, and -\fBSun::Solaris::Object\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:EXACCT_ALL\fR\fR -.ad -.RS 21n -\fB:ALL\fR, plus the \fB:ALL\fR tags for \fBSun::Solaris::Catalog\fR, -\fBSun::Solaris::File\fR, and \fBSun::Solaris::Object\fR -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBgetacct\fR(2), \fBputacct\fR(2), \fBwracct\fR(2), \fBea_error\fR(3EXACCT), -\fBExacct::Catalog\fR(3PERL), \fBExacct::File\fR(3PERL), -\fBExacct::Object\fR(3PERL), \fBExacct::Object::Group\fR(3PERL), -\fBExacct::Object::Item\fR(3PERL), \fBlibexacct\fR(3LIB), \fBattributes\fR(5) -.SH NOTES -.sp -.LP -The modules described in the section 3PERL manual pages make extensive use of -the Perl "double-typed scalar" facility. This facility allows a scalar value to -behave either as an integer or as a string, depending upon context. It is the -same behavior as exhibited by the \fB$!\fR Perl variable (\fBerrno\fR). It is -useful because it avoids the need to map from an integer value to the -corresponding string to display a value. Some examples are provided below: -.sp -.in +2 -.nf -# Assume $obj is a Sun::Solaris::Item -my $type = $obj->type(); - -# Print "2 EO_ITEM" -printf("%d %s\en", $type, $type); - -# Behave as an integer, $i == 2 -my $i = 0 + $type; - -# Behave as a string, $s = "abc EO_ITEM xyx" -my $s = "abc $type xyz"; -.fi -.in -2 - -.sp -.LP -Wherever a function or method is documented as returning a double-typed scalar, -the returned value exhibits this type of behavior. diff --git a/usr/src/man/man3perl/Exacct::Catalog.3perl b/usr/src/man/man3perl/Exacct::Catalog.3perl deleted file mode 100644 index 115636b55b..0000000000 --- a/usr/src/man/man3perl/Exacct::Catalog.3perl +++ /dev/null @@ -1,217 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT::CATALOG 3PERL "Dec 1, 2002" -.SH NAME -Exacct::Catalog \- exacct catalog tag manipulation -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct::Catalog qw(:ALL); -my $ea_cat = Sun::Solaris::Exacct::Catalog->new( - &EXT_UINT64 | &EXC_DEFAULT | &EXD_PROC_PID); -.fi - -.SH DESCRIPTION -.sp -.LP -This class provides a wrapper around the 32-bit integer used as a catalog tag. -The catalog tag is represented as a Perl object blessed into the -\fBSun::Solaris::Exacct::Catalog\fR class so that methods can be used to -manipulate fields in a catalog tag. -.SS "Constants" -.sp -.LP -All the \fBEXT_\fR*, \fBEXC_\fR*, and \fBEXD_\fR* macros are provided as -constants. Constants passed to the methods below can either be the integer -value such as \fBEXT_UINT8\fR or the string representation such as -"\fBEXT_UINT8\fR". -.SS "Functions" -.sp -.LP -None. -.SS "Class methods" -.sp -.ne 2 -.na -\fB\fBregister($cat_pfx, $catalog_id, $export, @idlist)\fR\fR -.ad -.sp .6 -.RS 4n -This method is used to register application-defined \fBlibexacct\fR(3LIB) -catalogs with the exacct Perl library. See -<\fB/usr/include/sys/exacct_catalog.h\fR> for details of the catalog tag -format. This method allows symbolic names and strings to be used for -manipulating application-defined catalogs. The first two parameters define the -catalog prefix and associated numeric catalog ID. If the \fB$export\fR -parameter is true, the constants are exported into the caller's package. The -final parameter is a list of (\fBid\fR, \fBname\fR) pairs that identify the -required constants. The constants created by this method are formed by -appending \fB$cat_pfx\fR and "_" to each name in the list, replacing any spaces -with underscore characters and converting the resulting string to uppercase -characters. The \fB$catalog_name\fR value is also created as a constant by -prefixing it with\fB EXC_\fR and converting it to uppercase characters. Its -value becomes that of \fB$catalog_id\fR shifted left by 24 bits. For example, -the following call: -.sp -.in +2 -.nf -Sun::Solaris::Exacct::Catalog->ea_register("MYCAT", 0x01, 1, - FIRST => 0x00000001, SECOND => 0x00000010); -.fi -.in -2 - -results in the definition of the following constants: -.sp -.in +2 -.nf -EXC_MYCAT 0x01 << 24 -MYCAT_FIRST 0x00000001 -MYCAT_SECOND 0x00000010 -.fi -.in -2 - -Only the catalog ID value of 0x01 is available for application use -(\fBEXC_LOCAL\fR). All other values are reserved. While it is possible to use -values other than 0x01, they might conflict with future extensions to the -\fBlibexacct\fR file format. -.sp -If any errors are detected during this method, a string is returned containing -the appropriate error message. If the call is sucessful, \fBundef\fR is -returned. -.RE - -.sp -.ne 2 -.na -\fB\fBnew($integer)\fR\fR -.ad -.br -.na -\fB\fBnew($cat_obj)\fR\fR -.ad -.br -.na -\fB\fBnew($type, $catalog, $id)\fR\fR -.ad -.sp .6 -.RS 4n -This method creates and returns a new Catalog object, which is a wrapper around -a 32-bit integer catalog tag. Three possible argument lists can be given. The -first variant is to pass an integer formed by bitwise-inclusive OR of the -appropriate \fBEX[TCD]_\fR* constants. The second variant is to pass an -existing Catalog object that will be copied. The final variant is to pass in -the type, catalog and ID fields as separate values. Each of these values can be -either an appropriate integer constant or the string representation of the -constant. -.RE - -.SS "Object methods" -.sp -.ne 2 -.na -\fB\fBvalue()\fR\fR -.ad -.RS 17n -This method allows the value of the catalog tag to be queried. In a scalar -context it returns the 32-bit integer representing the tag. In a list context -it returns a (\fBtype\fR, \fBcatalog\fR, \fBid\fR) triplet, where each member -of the triplet is a dual-typed scalar. -.RE - -.sp -.ne 2 -.na -\fB\fBtype()\fR\fR -.ad -.RS 17n -This method returns the type field of the catalog tag as a dual-typed scalar. -.RE - -.sp -.ne 2 -.na -\fB\fBcatalog()\fR\fR -.ad -.RS 17n -This method returns the catalog field of the catalog tag as a dual-typed -scalar. -.RE - -.sp -.ne 2 -.na -\fB\fBid()\fR\fR -.ad -.RS 17n -This method returns the id field of the catalog tag as a dual-typed scalar. -.RE - -.sp -.ne 2 -.na -\fB\fBtype_str()\fR\fR -.ad -.br -.na -\fB\fBcatalog_str()\fR\fR -.ad -.br -.na -\fB\fBid_str()\fR\fR -.ad -.RS 17n -These methods return string representations of the appropriate value. These -methods can be used for textual output of the various catalog fields. The -string representations of the constants are formed by removing the \fBEXT_\fR, -\fBEXC_\fR, or \fBEXD_\fR prefix, replacing any underscore characters with -spaces, and converting the remaining string to lowercase characters. -.RE - -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants and functions defined in this module: -.sp -.ne 2 -.na -\fB\fB:CONSTANTS\fR\fR -.ad -.RS 14n -\fBEXT_\fR*, \fBEXC_\fR*, and \fBEXD_\fR* -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.RS 14n -\fB:CONSTANTS\fR -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBExacct\fR(3PERL), \fBExacct::File\fR(3PERL), \fBExacct::Object\fR(3PERL), -\fBExacct::Object::Group\fR(3PERL), \fBExacct::Object::Item\fR(3PERL), -\fBlibexacct\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man3perl/Exacct::File.3perl b/usr/src/man/man3perl/Exacct::File.3perl deleted file mode 100644 index 4f3b18a3e4..0000000000 --- a/usr/src/man/man3perl/Exacct::File.3perl +++ /dev/null @@ -1,234 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT::FILE 3PERL "Dec 1, 2002" -.SH NAME -Exacct::File \- exacct file manipulation -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct::File qw(:ALL); -my $ea_file = Sun::Solaris::Exacct::File->new($myfile, &O_RDONLY); -my $ea_obj = $ea_file->get(); -.fi - -.SH DESCRIPTION -.sp -.LP -This module provides access to the \fBlibexacct\fR(3LIB) functions that -manipulate accounting files. The interface is object-oriented and allows the -creation and reading of \fBlibexacct\fR files. The C library calls wrapped by -this module are \fBea_open\fR(3EXACCT), \fBea_close\fR(3EXACCT), -\fBea_next_object\fR(3EXACCT), \fBea_previous_object\fR(3EXACCT), -\fBea_write_object\fR(3EXACCT), \fBea_get_object\fR(3EXACCT), -\fBea_get_creator\fR(3EXACCT), and \fBea_get_hostname\fR(3EXACCT). The file -read and write methods all operate on \fBSun::Solaris::Exacct::Object\fR -objects and perform all the necessary memory management, packing, unpacking, -and structure conversions that are required. -.SS "Constants" -.sp -.LP -\fBEO_HEAD\fR, \fBEO_TAIL\fR, \fBEO_NO_VALID_HDR\fR, \fBEO_POSN_MSK\fR, and -\fBEO_VALIDATE_MSK\fR. Other constants needed by the \fBnew()\fR method below -are in the standard Perl Fcntl module. -.SS "Functions" -.sp -.LP -None. -.SS "Class methods" -.sp -.ne 2 -.na -\fB\fBnew($name, $oflags, creator => $creator,\fR\fR -.ad -.sp .6 -.RS 4n -This method opens a \fBlibexacct\fR file as specified by the mandatory -parameters \fB$name\fR and \fB$oflags\fR, and returns a -\fBSun::Solaris::Exacct::File\fR object, or \fBundef\fR if an error occurs. The -parameters \fB$creator\fR, \fB$aflags\fR, and \fB$mode\fR are optional and are -passed as (\fBname\fR => \fBvalue\fR) pairs. The only valid values for -\fB$oflags\fR are the combinations of \fBO_RDONLY\fR, \fBO_WRONLY\fR, -\fBO_RDWR\fR, and \fBO_CREAT\fR described below. -.sp -The \fB$creator\fR parameter is a string describing the creator of the file. If -it is required (for instance, when writing to a file) but absent, it is set to -the string representation of the caller's UID. The \fB$aflags\fR parameter -describes the required positioning in the file for \fBO_RDONLY\fR access: -either \fBEO_HEAD\fR or \fBEO_TAIL\fR are allowed. If absent, \fBEO_HEAD\fR is -assumed. The \fB$mode\fR parameter is the file creation mode and is ignored -unless \fBO_CREAT\fR is specified in \fB$oflags\fR. If \fB$mode\fR is -unspecified, the file creation mode is set to 0666 (octal). If an error occurs, -it can be retrieved with the \fBSun::Solaris::Exacct::ea_error()\fR function. -See \fBExacct\fR(3PERL). -.sp - -.sp -.TS -c c c -l l l . -\fB$oflags\fR \fB$aflags\fR Action -\fBO_RDONLY\fR Absent or \fBEO_HEAD\fR T{ -Open for reading at the start of the file. -T} -\fBO_RDONLY\fR \fBEO_TAIL\fR Open for reading at the end of the file. -\fBO_WRONLY\fR Ignored T{ -File must exist, open for writing at the end of the file. -T} -\fBO_WRONLY\fR | \fBO_CREAT\fR Ignored T{ -Create file if it does not exist, otherwise truncate and open for writing. -T} -\fBO_RDWR\fR Ignored T{ -File must exist, open for reading/writing, positioned at the end of the file. -T} -\fBO_RDWR\fR | \fBO_CREAT\fR Ignored T{ -Create file if it does not exist, otherwise truncate and open for reading/writing. -T} -.TE - -.RE - -.SS "Object methods" -.sp -.LP -There is no explicit \fBclose()\fR method for a -\fBSun::Solaris::Exacct::File\fR. The file is closed when the file handle -object is undefined or reassigned. -.sp -.ne 2 -.na -\fB\fBcreator()\fR\fR -.ad -.sp .6 -.RS 4n -This method returns a string containing the creator of the file or \fBundef\fR -if the file does not contain the information. -.RE - -.sp -.ne 2 -.na -\fB\fBhostname()\fR\fR -.ad -.sp .6 -.RS 4n -This method returns a string containing the hostname on which the file was -created, or \fBundef\fR if the file does not contain the information. -.RE - -.sp -.ne 2 -.na -\fB\fBnext()\fR\fR -.ad -.sp .6 -.RS 4n -This method reads the header information of the next record in the file. In a -scalar context the value of the type field is returned as a dual-typed scalar -that will be one of \fBEO_ITEM\fR, \fBEO_GROUP\fR, or \fBEO_NONE\fR. In a list -context it returns a two-element list containing the values of the type and -catalog fields. The type element is a dual-typed scalar. The catalog element is -blessed into the \fBSun::Solaris::Exacct::Catalog\fR class. If an error occurs, -\fBundef\fR or (\fBundef\fR, \fBundef\fR) is returned depending upon context. -The status can be accessed with the \fBSun::Solaris::Exacct::ea_error()\fR -function.See \fBExacct\fR(3PERL). -.RE - -.sp -.ne 2 -.na -\fB\fBprevious()\fR\fR -.ad -.sp .6 -.RS 4n -This method reads the header information of the previous record in the file. In -a scalar context it returns the type field. In a list context it returns the -two-element list containing the values of the type and catalog fields, in the -same manner as the \fBnext()\fR method. Error are also returned in the same -manner as the \fBnext()\fR method. -.RE - -.sp -.ne 2 -.na -\fB\fBget()\fR\fR -.ad -.sp .6 -.RS 4n -This method reads in the \fBlibexacct\fR record at the current position in the -file and returns a \fBSun::Solaris::Exacct::Object\fR containing the unpacked -data from the file. This object can then be further manipulated using its -methods. In case of error undef is returned and the error status is made -available with the \fBSun::Solaris::Exacct::ea_error()\fR function. After this -operation, the position in the file is set to the start of the next record in -the file. -.RE - -.sp -.ne 2 -.na -\fB\fBwrite(@ea_obj)\fR\fR -.ad -.sp .6 -.RS 4n -This method converts the passed list of Sun::Solaris::Exacct::Objects into -\fBlibexacct\fR file format and appends them to the \fBlibexacct\fR file, which -must be open for writing. This method returns true if successful and false -otherwise. On failure the error can be examined with the -\fBSun::Solaris::Exacct::ea_error()\fR function. -.RE - -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants defined in this module: -.sp -.ne 2 -.na -\fB\fB:CONSTANTS\fR\fR -.ad -.sp .6 -.RS 4n -\fBEO_HEAD\fR, \fBEO_TAIL\fR, \fBEO_NO_VALID_HDR\fR, \fBEO_POSN_MSK\fR, and -\fBEO_VALIDATE_MSK\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.sp .6 -.RS 4n -\fB:CONSTANTS\fR, Fcntl(\fB:DEFAULT\fR). -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBea_close\fR(3EXACCT), \fBea_get_creator\fR(3EXACCT), -\fBea_get_hostname\fR(3EXACCT), \fBea_get_object\fR(3EXACCT), -\fBea_next_object\fR(3EXACCT), \fBea_open\fR(3EXACCT), -\fBea_previous_object\fR(3EXACCT), \fBea_write_object\fR(3EXACCT), -\fBExacct\fR(3PERL), \fBExacct::Catalog\fR(3PERL), \fBExacct::Object\fR(3PERL), -\fBExacct::Object::Group\fR(3PERL), \fBExacct::Object::Item\fR(3PERL), -\fBlibexacct\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man3perl/Exacct::Object.3perl b/usr/src/man/man3perl/Exacct::Object.3perl deleted file mode 100644 index eb8fae94bc..0000000000 --- a/usr/src/man/man3perl/Exacct::Object.3perl +++ /dev/null @@ -1,201 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT::OBJECT 3PERL "Dec 1, 2002" -.SH NAME -Exacct::Object \- exacct object manipulation -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct::Object qw(:ALL); -print($ea_obj->value(), "\en"); -.fi - -.SH DESCRIPTION -.sp -.LP -This module is used as a parent of the two possible types of Perl exacct -objects: Items and Groups. An Item is either a single data value such as the -number of seconds of user CPU time consumed by a process, an embedded Perl -exacct object, or a block of raw data. A Group is an ordered collection of -Perl exacct Items such as all of the resource usage values for a particular -process or task. If Groups need to be nested within each other, the inner -Groups can be stored as embedded Perl exacct objects inside the enclosing -Group. -.sp -.LP -This module contains methods that are common to both Perl exacct Items and -Groups. The attributes of \fBSun::Solaris::Exacct::Object\fR and all classes -derived from it are read-only after initial creation with \fBnew()\fR. This -behavior prevents the inadvertent modification of the attributes that could -produce inconsistent catalog tags and data values. The only exception is the -array used to store the Items inside a Group object, which can be modified -using the normal Perl array operators. See the \fBvalue()\fR method below. -.SS "Constants" -.sp -.LP -\fBEO_ERROR\fR, \fBEO_NONE\fR, \fBEO_ITEM\fR, and \fBEO_GROUP\fR. -.SS "Functions" -.sp -.LP -None. -.SS "Class methods" -.sp -.ne 2 -.na -\fB\fBdump($object, $filehandle)\fR\fR -.ad -.RS 30n -This method dumps formatted text representation of a Perl exacct object to the -supplied file handle. If no file handle is specified, the text representation -is dumped to \fBSTDOUT\fR. See EXAMPLES below for sample output. -.RE - -.SS "Object methods" -.sp -.ne 2 -.na -\fB\fBtype()\fR\fR -.ad -.RS 27n -This method returns the type field of the Perl exacct object. The value of the -type field is returned as a dual-typed scalar and is either \fBEO_ITEM\fR, -\fBEO_GROUP\fR, or \fBEO_NONE\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBcatalog()\fR\fR -.ad -.RS 27n -This method returns the catalog field of the Perl exacct object. The value is -returned as a \fBSun::Solaris::Exacct::Catalog\fR object. -.RE - -.sp -.ne 2 -.na -\fB\fBmatch_catalog($catalog)\fR\fR -.ad -.RS 27n -This method matches the passed catalog tag against the object. True is returned -of a match occurs. Otherwise false is returned. This method has the same -behavior as the underlying \fBea_match_object_catalog\fR(3EXACCT) function. -.RE - -.sp -.ne 2 -.na -\fB\fBvalue()\fR\fR -.ad -.RS 27n -This method returns the value of the Perl exacct object. In the case of an -Item, this object will normally be a Perl scalar, either a number or string. -For raw Items, the buffer contained inside the object is returned as a Perl -string that can be manipulated with the Perl \fBunpack()\fR function. If the -Item contains either a nested Item or a nested Group, the enclosed Item is -returned as a reference to an object of the appropriate subtype of the -\fBSun::Solaris::Exacct::Object\fR class. -.sp -For Group objects, if \fBvalue()\fR is called in a scalar context, the return -value is a reference to the underlying array used to store the component Items -of the Group. Since this array can be manipulated with the normal Perl array -indexing syntax and array operators, the objects inside the Group can be -manipulated. All objects in the array must be derived from the -\fBSun::Solaris::Exacct::Object\fR class. Any attempt to insert something else -into the array will generate a fatal runtime error that can be caught with an -\fBeval { }\fR block. -.sp -If \fBvalue()\fR is called in a list context for a Group object, it returns a -list of all the objects in the Group. Unlike the array reference returned in a -scalar context, this list cannot be manipulated to add or delete Items from a -Group. This mechanism is considerably faster than the array mechanism described -above and is the preferred mechanism if a Group is being examined in a -read-only manner. -.RE - -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants and functions defined in this module: -.sp -.ne 2 -.na -\fB\fB:CONSTANTS\fR\fR -.ad -.RS 14n -\fBEO_ERROR\fR, \fBEO_NONE\fR, \fBEO_ITEM\fR, and \fBEO_GROUP\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.RS 14n -\fB:CONSTANTS\fR -.RE - -.SH EXAMPLES -.LP -\fBExample 1 \fROutput of the \fBdump()\fR method for a Perl exacct Group -object. -.sp -.LP -The following is an example of output of the \fBdump()\fR method for a Perl -exacct Group object. - -.sp -.in +2 -.nf -GROUP - Catalog = EXT_GROUP|EXC_DEFAULT|EXD_GROUP_PROC_PARTIAL - ITEM - Catalog = EXT_UINT32|EXC_DEFAULT|EXD_PROC_PID - Value = 3 - ITEM - Catalog = EXT_UINT32|EXC_DEFAULT|EXD_PROC_UID - Value = 0 - ITEM - Catalog = EXT_UINT32|EXC_DEFAULT|EXD_PROC_GID - Value = 0 - ITEM - Catalog = EXT_UINT32|EXC_DEFAULT|EXD_PROC_PROJID - Value = 0 - ITEM - Catalog = EXT_UINT32|EXC_DEFAULT|EXD_PROC_TASKID - Value = 0 - ITEM - Catalog = EXT_STRING|EXC_DEFAULT|EXD_PROC_COMMAND - Value = fsflush -ENDGROUP -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBea_match_object_catalog\fR(3EXACCT), \fBExacct\fR(3PERL), -\fBExacct::Catalog\fR(3PERL), \fBExacct::File\fR(3PERL), -\fBExacct::Object::Group\fR(3PERL), \fBExacct::Object::Item\fR(3PERL), -\fBlibexacct\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man3perl/Exacct::Object::Group.3perl b/usr/src/man/man3perl/Exacct::Object::Group.3perl deleted file mode 100644 index aef4d35fab..0000000000 --- a/usr/src/man/man3perl/Exacct::Object::Group.3perl +++ /dev/null @@ -1,116 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT::OBJECT::GROUP 3PERL "Dec 1, 2002" -.SH NAME -Exacct::Object::Group \- exacct group manipulation -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct::Object; -my $ea_grp = Sun::Solaris::Exacct::Object::Group->new( - & EXT_GROUP | &EXC_DEFAULT | &EXD_GROUP_PROC); -.fi - -.SH DESCRIPTION -.sp -.LP -This module is used for manipulating \fBlibexacct\fR(3LIB) Group objects. A -\fBlibexacct\fR Group object is represented as an opaque reference blessed into -the \fBSun::Solaris::Exacct::Object::Group\fR class, which is a subclass of the -\fBSun::Solaris::Exacct::Object\fR class. The Items within a Group are stored -inside a Perl array. A reference to the array can be accessed with the -inherited \fBvalue()\fR method. The individual Items within a Group can be -manipulated with the normal Perl array syntax and operators. All data elements -of the array must be derived from the \fBSun::Solaris::Exacct::Object\fR class. -Group objects can also be nested inside each other simply by adding an existing -Group as a data Item. -.SS "Constants" -.sp -.LP -None. -.SS "Functions" -.sp -.LP -None. -.SS "Class methods" -.sp -.LP -Class methods include those inherited from the -\fBSun::Solaris::Exacct::Object\fR base class, plus the following: -.sp -.ne 2 -.na -\fB\fBnew($catalog, @objects)\fR\fR -.ad -.RS 27n -This method creates and returns a new -\fBSun::Solaris::Exacct::Object::Group\fR. The catalog tag can be either an -integer or a \fBSun::Solaris::Exacct::Catalog\fR. The catalog tag should be a -valid catalog tag for a Perl exacct Group object. The \fB@objects\fR parameter -is a list of \fBSun::Solaris::Exacct::Object\fR to be stored inside the Group. -A copy of all the passed Items is taken and any Group objects are recursively -copied. The contents of the returned Group object can be accessed with the -array returned by the value method. -.RE - -.SS "Object methods" -.sp -.ne 2 -.na -\fB\fBas_hash()\fR\fR -.ad -.RS 17n -This method returns the contents of the group as a hash reference. It uses the -string value of each item's catalog ID as the hash entry key and the scalar -value returned by \fBvalue()\fR as the hash entry value. This form should be -used if there are no duplicate catalog tags in the group. -.sp -This method and its companion \fBas_hashlist()\fR are the fastest ways to -access the contents of a Group. -.RE - -.sp -.ne 2 -.na -\fB\fBas_hashlist()\fR\fR -.ad -.RS 17n -This method returns the contents of the group as a hash reference. It uses the -string value of each item's catalog id as the hash entry key and an array of -the scalar values returned by \fBvalue()\fR as the hash entry value for all the -items that share a common key. This form should be used if there might be -duplicate catalog tags in the group. -.sp -This method and its companion \fBas_hash()\fR are the fastest ways to access -the contents of a Group. -.RE - -.SS "Exports" -.sp -.LP -None. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBExacct\fR(3PERL), \fBExacct::Catalog\fR(3PERL), \fBExacct::File\fR(3PERL), -\fBExacct::Object\fR(3PERL), \fBExacct::Object::Item\fR(3PERL), -\fBlibexacct\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man3perl/Exacct::Object::Item.3perl b/usr/src/man/man3perl/Exacct::Object::Item.3perl deleted file mode 100644 index 2372acd484..0000000000 --- a/usr/src/man/man3perl/Exacct::Object::Item.3perl +++ /dev/null @@ -1,103 +0,0 @@ -'\" te -.\" Copyright (c) 2002, 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 EXACCT::OBJECT::ITEM 3PERL "Dec 1, 2002" -.SH NAME -Exacct::Object::Item \- exacct item manipulation -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Exacct::Object; -my $ea_item = Sun::Solaris::Exacct::Object::Item->new( - &EXT_UINT64 | &EXC_DEFAULT | &EXD_PROC_PID, $$); -.fi - -.SH DESCRIPTION -.sp -.LP -This module is used for manipulating \fBlibexacct\fR(3LIB) data Items. A -\fBlibexacct\fR Item is represented as an opaque reference blessed into the -\fBSun::Solaris::Exacct::Object::Item\fR class, which is a subclass of the -\fBSun::Solaris::Exacct::Object\fR class. The underlying \fBlibexacct\fR data -types are mapped onto Perl types as follows: -.sp - -.sp -.TS -c c -l l . -libexacct type Perl internal type -\fBEXT_UINT8\fR IV (integer) -\fBEXT_UINT16\fR IV (integer) -\fBEXT_UINT32\fR IV (integer) -\fBEXT_UINT64\fR IV (integer) -\fBEXT_DOUBLE\fR NV (double) -\fBEXT_STRING\fR PV (string) -\fBEXT_RAW\fR PV (string) -\fBEXT_EXACCT_OBJECT\fR \fBSun::Solaris::Exacct::Object subclass\fR -.TE - -.SS "Constants" -.sp -.LP -None. -.SS "Functions" -.sp -.LP -None. -.SS "Class methods" -.sp -.LP -Class methods include those inherited from the -\fBSun::Solaris::Exacct::Object\fR base class, plus the following: -.sp -.ne 2 -.na -\fB\fBnew($catalog, $value)\fR\fR -.ad -.RS 25n -This method creates and returns a new \fBSun::Solaris::Exacct::Object::Item\fR. -The catalog tag can be either an integer or a -\fBSun::Solaris::Exacct::Catalog\fR. This catalog tag controls the conversion -of the Perl value to the corresponding Perl exacct data type as described in -the table above. If the catalog tag has a type field of -\fBEXT_EXACCT_OBJECT\fR, the value must be a reference to either an Item or a -Group object and the passed object is recursively copied and stored inside the -new Item. Because the returned Item is constant, it is impossible, for example, -to create an Item representing CPU seconds and subsequently modify its value or -change its catalog value. This behavior is intended to prevent mismatches -between the catalog tag and the data value. -.RE - -.SS "Object methods" -.sp -.LP -Object methods are those inherited from the \fBSun::Solaris::Exacct::Object\fR. -.SS "Exports" -.sp -.LP -None. -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBExacct\fR(3PERL), \fBExacct::Catalog\fR(3PERL), \fBExacct::File\fR(3PERL), -\fBExacct::Object\fR(3PERL), \fBExacct::Object::Group\fR(3PERL), -\fBlibexacct\fR(3LIB), \fBattributes\fR(5) diff --git a/usr/src/man/man3perl/Makefile b/usr/src/man/man3perl/Makefile index a0e1935095..909c8291b5 100644 --- a/usr/src/man/man3perl/Makefile +++ b/usr/src/man/man3perl/Makefile @@ -12,44 +12,20 @@ # # Copyright 2011, Richard Lowe # Copyright 2013 Nexenta Systems, Inc. All rights reserved. +# Copyright (c) 2014 Racktop Systems. # include $(SRC)/Makefile.master MANSECT= 3perl -MANFILES= Exacct.3perl \ - Exacct\:\:Catalog.3perl \ - Exacct\:\:File.3perl \ - Exacct\:\:Object.3perl \ - Exacct\:\:Object\:\:Group.3perl \ - Exacct\:\:Object\:\:Item.3perl \ - Kstat.3perl \ +MANFILES= Kstat.3perl \ Lgrp.3perl \ - Privilege.3perl \ Project.3perl \ - Task.3perl \ - Ucred.3perl + Task.3perl .KEEP_STATE: include $(SRC)/man/Makefile.man -# -# When KEEP_STATE is in effect and a target has a colon in the name (like the -# Exacct::* pages above, dmake will write them to the state file unescaped, -# creating a file which then cannot be reparsed, breaking any build other than -# the first in this directory: -# -# See CR 6987108 make will write un-escaped :'s to .make.state, break itself -# -# As a workaround, install the files manually in a FRC target. -CMD= $(INS) -s -m $(FILEMODE) -f $(ROOTMAN)/man$(MANSECT) -install: FRC - @for file in $(MANFILES); do \ - if [[ $$file -nt $(ROOTMAN)/man$(MANSECT)/$$file ]]; then \ - $(ECHO) $(CMD) $$file; \ - $(RM) $(ROOTMAN)/man$(MANSECT)/$$file; \ - $(CMD) $$file; \ - fi \ - done; +install: $(ROOTMANFILES) $(ROOTMANLINKS) diff --git a/usr/src/man/man3perl/Privilege.3perl b/usr/src/man/man3perl/Privilege.3perl deleted file mode 100644 index 0b0ad0548d..0000000000 --- a/usr/src/man/man3perl/Privilege.3perl +++ /dev/null @@ -1,303 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 PRIVILEGE 3PERL "Jan 30, 2004" -.SH NAME -Privilege \- Perl interface to Privileges -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Privilege qw(:ALL); -.fi - -.SH DESCRIPTION -.sp -.LP -This module provides wrappers for the Privilege-related system and library -calls. Also provided are constants from the various Privilege-related headers -and dynamically-generated constants for all the privileges and privilege sets. -.SS "Constants" -.sp -.LP -\fBPRIV_STR_SHORT\fR, \fBPRIV_STR_LIT\fR, \fBPRIV_STR_PORT\fR, \fBPRIV_ON\fR, -\fBPRIV_OFF\fR, \fBPRIV_SET\fR, \fBPRIV_AWARE\fR, and \fBPRIV_DEBUG\fR. -.SS "Functions" -.sp -.ne 2 -.na -\fB\fBgetppriv($which)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the process privilege set specified by -\fB\fR\fB$which\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsetppriv($op, $which, $set)\fR\fR -.ad -.sp .6 -.RS 4n -This function modified the privilege set specified by $which in the as -specified by the \fB$op\fR and \fB$set\fR arguments. If \fB$op\fR is -\fBPRIV_ON\fR, the privileges in \fB$set\fR are added to the set specified. If -\fB$op\fR is \fBPRIV_OFF\fR, the privileges in \fB$set\fR are removed from the -set specified. If \fB$op\fR is \fBPRIV_SET\fR, the specified set is made equal -to \fB$set\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBgetpflags($flag)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the value associated with process \fB$flag\fR or -\fBundef\fR on error. Possible values for \fB$flag\fR are \fBPRIV_AWARE\fR and -\fBPRIV_DEBUG\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBsetppflags($flag, $val)\fR\fR -.ad -.sp .6 -.RS 4n -This function sets the process flag \fB$flag\fR to \fB$val\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_fillset()\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a new privilege set with all privileges set. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_emptyset()\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a new empty privilege set. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_isemptyset($set)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns whether or not \fB$set\fR is empty. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_isfullset($set)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns whether or not \fB$set\fR is full. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_isequalset($a, $b)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns whether sets \fB$a\fR and \fB$b\fR are equal. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_issubset($a, $b)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns whether set \fB$a\fR is a subset of \fB$b\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_ismember($set, $priv)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns whether \fB$priv\fR is a member of \fB$set\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_ineffect($priv)\fR\fR -.ad -.sp .6 -.RS 4n -This function returned whether \fB$priv\fR is in the process's effective set. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_intersect($a, $b)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a new privilege set which is the intersection of \fB$a\fR -and \fB$b\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_union($a, $b)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a new privilege set which is the union of \fB$a\fR and -\fB$b\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_inverse($a)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a new privilege set which is the inverse of \fB$a\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_addset($set, $priv)\fR\fR -.ad -.sp .6 -.RS 4n -This functon adds the privilege \fB$priv\fR to \fB$set\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_copyset($a)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns a copy of the privilege set \fB$a\fR. -.RE - -.sp -.ne 2 -.na -\fB\fBpriv_delset($set, $priv)\fR\fR -.ad -.sp .6 -.RS 4n -This function remove the privilege \fB$priv\fR from \fB$set\fR. -.RE - -.SS "Class methods" -.sp -.LP -None. -.SS "Object methods" -.sp -.LP -None. -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants and functions defined in this module: -.sp -.ne 2 -.na -\fB\fB:SYSCALLS\fR\fR -.ad -.RS 14n -\fBgetppriv()\fR, \fBsetppriv()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:LIBCALLS\fR\fR -.ad -.RS 14n -\fBpriv_addset()\fR, \fBpriv_copyset()\fR, \fBpriv_delset()\fR, -\fBpriv_emptyset()\fR, \fBpriv_fillset()\fR, \fBpriv_intersect()\fR, -\fBpriv_inverse()\fR, \fBpriv_isemptyset()\fR, \fBpriv_isequalset()\fR, -\fBpriv_isfullset()\fR, \fBpriv_ismember()\fR, \fBpriv_issubset()\fR, -\fBpriv_gettext()\fR, \fBpriv_union()\fR, \fBpriv_set_to_str()\fR, -\fBpriv_str_to_set()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:CONSTANTS\fR\fR -.ad -.RS 14n -\fBPRIV_STR_SHORT\fR, \fBPRIV_STR_LIT\fR, \fBPRIV_STR_PORT\fR, \fBPRIV_ON\fR, -\fBPRIV_OFF\fR, \fBPRIV_SET\fR, \fBPRIV_AWARE\fR, \fBPRIV_DEBUG\fR, plus -constants for all privileges and privilege sets. -.RE - -.sp -.ne 2 -.na -\fB\fB:VARIABLES\fR\fR -.ad -.RS 14n -\fB%PRIVILEGES\fR, \fB%PRIVSETS\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.RS 14n -\fB:SYSCALLS\fR, \fB:LIBCALLS\fR, \fB:CONSTANTS\fR, \fB:VARIABLES\fR -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBgetpflags\fR(2), \fBgetppriv\fR(2), \fBpriv_addset\fR(3C), -\fBpriv_set\fR(3C), \fBpriv_str_to_set\fR(3C), \fBattributes\fR(5), -\fBprivileges\fR(5) diff --git a/usr/src/man/man3perl/Ucred.3perl b/usr/src/man/man3perl/Ucred.3perl deleted file mode 100644 index e6b55d99da..0000000000 --- a/usr/src/man/man3perl/Ucred.3perl +++ /dev/null @@ -1,235 +0,0 @@ -'\" te -.\" Copyright (c) 2004, 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 UCRED 3PERL "Jan 30, 2004" -.SH NAME -Ucred \- Perl interface to User Credentials -.SH SYNOPSIS -.LP -.nf -use Sun::Solaris::Ucred qw(:ALL); -.fi - -.SH DESCRIPTION -.sp -.LP -This module provides wrappers for the Ucred-related system and library calls. -.SS "Constants" -.sp -.LP -None. -.SS "Functions" -.sp -.ne 2 -.na -\fB\fBucred_get($pid)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the credential of the process specified by \fB$pid\fR if -the process exists and the calling process is permitted to obtain the -credentials of that process. -.RE - -.sp -.ne 2 -.na -\fB\fBgetpeerucred($fd)\fR\fR -.ad -.sp .6 -.RS 4n -If \fB$fd\fR is a connected connection-oriented TLI endpoint, a connected -\fBSOCK_STREAM\fR, or a \fBSOCK_SEQPKT\fR socket, \fBgetpeerucred()\fR returns -the user credential of the peer at the time the connection was established, if -availble. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_geteuid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the effective uid of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getruid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the real uid of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getsuid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the saved uid of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getegid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the effective group of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getrgid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the real group of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getsgid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the saved group of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getgroups($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the list of supplemental groups of a user credential, if -available.An array of groups is returned in \fBARRAY\fR context; the number of -groups is returned in \fBSCALAR\fR context. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getprivset($ucred, $which)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the privilege set specified by \fB$which\fR of a user -credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getpflags($ucred, $flags)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the value of a specific process flag of a user -credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getpid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the process ID of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getprojid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the project ID of a user credential, if available. -.RE - -.sp -.ne 2 -.na -\fB\fBucred_getzoneid($ucred)\fR\fR -.ad -.sp .6 -.RS 4n -This function returns the zone ID of a user credential, if available. -.RE - -.SS "Class methods" -.sp -.LP -None. -.SS "Object methods" -.sp -.LP -None. -.SS "Exports" -.sp -.LP -By default nothing is exported from this module. The following tags can be used -to selectively import constants and functions defined in this module: -.sp -.ne 2 -.na -\fB\fB:SYSCALLS\fR\fR -.ad -.RS 13n -\fBucred_get()\fR, \fBgetpeerucred()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:LIBCALLS\fR\fR -.ad -.RS 13n -\fBucred_geteuid()\fR, \fBucred_getruid()\fR, \fBucred_getsuid()\fR, -\fBucred_getegid()\fR, \fBucred_getrgid()\fR, \fBucred_getsgid()\fR, -\fBucred_getgroups()\fR, \fBucred_getprivset()\fR, \fBucred_getpflags()\fR, -\fBucred_getpid()\fR, \fBucred_getzone()\fR -.RE - -.sp -.ne 2 -.na -\fB\fB:ALL\fR\fR -.ad -.RS 13n -\fB:SYSCALLS()\fR, \fB:LIBCALLS()\fR -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Interface Stability Evolving -.TE - -.SH SEE ALSO -.sp -.LP -\fBgetpeerucred\fR(3C), \fBucred_get\fR(3C), \fBattributes\fR(5) |