From f5f3cbec075f8308da054292c7c7d96373c956ee Mon Sep 17 00:00:00 2001 From: Peter Tribble Date: Sat, 8 Feb 2020 16:49:42 +0000 Subject: 12288 getfacl and setfacl could stand improvement Reviewed by: Andy Fiddaman Approved by: Robert Mustacchi --- usr/src/man/man5/acl.5 | 58 ++++++++++++++++++++++---------------------------- 1 file changed, 26 insertions(+), 32 deletions(-) (limited to 'usr/src/man/man5') diff --git a/usr/src/man/man5/acl.5 b/usr/src/man/man5/acl.5 index b1db6df1ae..cc42c5d4df 100644 --- a/usr/src/man/man5/acl.5 +++ b/usr/src/man/man5/acl.5 @@ -1,17 +1,17 @@ '\" te +.\" Copyright (c) 2020 Peter Tribble. .\" Copyright 2014 Nexenta Systems, Inc. All rights reserved. .\" Copyright (c) 2008, 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 ACL 5 "Nov 24, 2014" +.TH ACL 5 "Feb 8, 2020" .SH NAME acl \- Access Control Lists .SH DESCRIPTION -.LP Access control lists (ACLs) are discretionary access control mechanisms that grant and deny access to files and directories. Two different ACL models are -supported in the Solaris release: POSIX-draft ACLs and NFSv4 ACLs. +supported in this release: POSIX-draft ACLs and NFSv4 ACLs. .sp .LP The older, POSIX-draft model is supported by the UFS file system. This model is @@ -23,10 +23,9 @@ The other model is based on the standards of the NFSv4 working group and is an approved standard from the Internet Engineering Task Force (IETF). The ZFS file system uses the NFSv4 model, and provides richer semantics and finer grained permission capabilities than the POSIX-draft model. -.SS "\fBPOSIX\fR-draft \fBACL\fRs" -.LP +.SS "POSIX-draft ACLs" POSIX-draft ACLs provide an alternative security mechanism to basic UNIX file -permissions in the Solaris release. Their purpose is to further restrict access +permissions. Their purpose is to further restrict access to files and directories or to extend permissions to a particular user. ACLs can be used to change the permissions for the standard owner, group and other class bits of a file's mode. ACLs can give additional users and groups access @@ -104,9 +103,8 @@ user:joe:rw- .in -2 .sp -.SS "\fBNFS\fRv4 \fBACL\fRs" -.LP -NFSv4 ACL model is based loosely on the Windows NT ACL model. NFSv4 ACLs +.SS "NFSv4 ACLs" +The NFSv4 ACL model is based loosely on the Windows NT ACL model. NFSv4 ACLs provide a much richer ACL model than POSIX-draft ACLs. .sp .LP @@ -151,7 +149,7 @@ subdirectories of the directory. .ie t \(bu .el o NFSv4 ACLs provide a mechanism for hooking into a system's audit trail. -Currently, Solaris does not support this mechanism. +Currently, illumos does not support this mechanism. .RE .RS +4 .TP @@ -540,10 +538,9 @@ user:fred:rwR:f------:allow .in -2 .sp -.SS "Shell-level Solaris \fBAPI\fR" -.LP -The Solaris command interface supports the manipulation of ACLs. The following -Solaris utilities accommodate both ACL models: +.SS "Shell-level API" +Several utilities support the manipulation of ACLs. The following +utilities accommodate both ACL models: .sp .ne 2 .na @@ -656,12 +653,11 @@ When a file with an ACL is unpacked, the unpacked file retains the ACL information. .RE -.SS "Application-level \fBAPI\fR" -.LP +.SS "Application-level API" The primary interfaces required to access file system ACLs at the programmatic level are the \fBacl_get()\fR and \fBacl_set()\fR functions. These functions -support both POSIX draft ACLs and NFSv4 ACLs. -.SS "Retrieving a file's \fBACL\fR" +support both POSIX-draft ACLs and NFSv4 ACLs. +.SS "Retrieving a file's ACL" .in +2 .nf int acl_get(const char *path, int flag, acl_t **aclp); @@ -671,23 +667,23 @@ int facl_get(int fd, int flag, acl_t **aclp); .sp .LP -The \fBacl_get\fR(3SEC) and \fBfacl_get\fR(3SEC) functions retrieves an ACL on +The \fBacl_get\fR(3SEC) and \fBfacl_get\fR(3SEC) functions retrieve an ACL on a file whose name is given by path or referenced by the open file descriptor fd. The flag argument specifies whether a trivial ACL should be retrieved. When -the flag argument equals \fBACL_NO_TRIVIAL\fR then only ACLs that are not +the flag argument equals \fBACL_NO_TRIVIAL\fR only ACLs that are not trivial are retrieved. The ACL is returned in the \fBaclp\fR argument. -.SS "Freeing \fBACL\fR structure" +.SS "Freeing ACL structure" .in +2 .nf -void acl_free(acl_t *aclp)s; +void acl_free(acl_t *aclp); .fi .in -2 .sp .LP The \fBacl_free()\fR function frees up memory allocated for the argument -\fBaclp;\fR. -.SS "Setting an \fBACL\fR on a file" +\fBaclp\fR. +.SS "Setting an ACL on a file" .in +2 .nf int acl_set(const char *path, acl_t *aclp); @@ -700,10 +696,10 @@ int facl_set(int fd, acl_t *aclp); The \fBacl_set\fR(3SEC) and \fBfacl_get\fR(3SEC) functions are used for setting an ACL on a file whose name is given by path or referenced by the open file descriptor \fBfd\fR. The \fBaclp\fR argument specifies the ACL to set. The -\fBacl_set\fR(3SEC) translates an POSIX-draft ACL into a NFSv4 ACL when the -target file systems supports NFSv4 ACLs. No translation is performed when +\fBacl_set\fR(3SEC) function translates a POSIX-draft ACL into a NFSv4 ACL when +the target file system supports NFSv4 ACLs. No translation is performed when trying to set an NFSv4 ACL on a POSIX-draft ACL supported file system. -.SS "Determining an \fBACL\fR's trivialness" +.SS "Determining an ACL's trivialness" .in +2 .nf int acl_trivial(const char *path); @@ -714,7 +710,7 @@ int acl_trivial(const char *path); .LP The \fBacl_trivial()\fR function is used to determine whether a file has a trivial ACL. -.SS "Removing all \fBACL\fRs from a file" +.SS "Removing all ACLs from a file" .in +2 .nf int acl_strip(const char *path, uid_t uid, gid_t gid, mode_t mode); @@ -727,7 +723,7 @@ The \fBacl_strip()\fR function removes all ACLs from a file and replaces them with a trivial ACL based off of the passed in argument mode. After replacing the ACL the owner and group of the file are set to the values specified in the uid and gid parameters. -.SS "Converting \fBACL\fRs to/from external representation" +.SS "Converting ACLs to/from external representation" .in +2 .nf int acl_fromtext(const char *path, acl_t **aclp); @@ -742,11 +738,10 @@ to by aclp into an external representation. See \fBDESCRIPTION\fR for details about external representation. .sp .LP -The \fBacl_fromtext()\fR functions converts and external representation into an +The \fBacl_fromtext()\fR function converts an external representation into an internal representation. See \fBDESCRIPTION\fR for details about external representation. .SH EXAMPLES -.LP The following examples demonstrate how the API can be used to perform basic operations on ACLs. .LP @@ -831,7 +826,6 @@ error = acl_strip("file", 10, 100, 0644); .in -2 .SH SEE ALSO -.LP \fBchgrp\fR(1), \fBchmod\fR(1), \fBchown\fR(1), \fBcp\fR(1), \fBcpio\fR(1), \fBfind\fR(1), \fBls\fR(1), \fBmv\fR(1), \fBtar\fR(1), \fBsetfacl\fR(1), \fBchmod\fR(2), \fBacl\fR(2), \fBstat\fR(2), \fBacl_get\fR(3SEC), -- cgit v1.2.3 From 0dc3799518631a169651844259f4357ece16ffa6 Mon Sep 17 00:00:00 2001 From: Peter Tribble Date: Thu, 13 Feb 2020 18:56:16 +0000 Subject: 12305 typos in dhcp man pages Reviewed by: Robert Mustacchi Approved by: Joshua M. Clulow --- usr/src/man/man1/dhcpinfo.1 | 29 +++++++---------------------- usr/src/man/man1m/dhcpagent.1m | 13 ++----------- usr/src/man/man5/dhcp.5 | 8 ++------ 3 files changed, 11 insertions(+), 39 deletions(-) (limited to 'usr/src/man/man5') diff --git a/usr/src/man/man1/dhcpinfo.1 b/usr/src/man/man1/dhcpinfo.1 index 24b8918a8b..7222ffeb60 100644 --- a/usr/src/man/man1/dhcpinfo.1 +++ b/usr/src/man/man1/dhcpinfo.1 @@ -1,14 +1,14 @@ '\" te .\" Copyright (c) 1992-1996 Competitive Automation, Inc. .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2020 Peter Tribble .\" 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 DHCPINFO 1 "May 15, 2009" +.TH DHCPINFO 1 "Feb 13, 2020" .SH NAME dhcpinfo \- display values of parameters received through DHCP .SH SYNOPSIS -.LP .nf \fBdhcpinfo\fR [\fB-c\fR] [\fB-i\fR \fIinterface\fR] [\fB-n\fR \fIlimit\fR] [\fB-v 4|6\fR] \fIcode\fR .fi @@ -19,14 +19,11 @@ dhcpinfo \- display values of parameters received through DHCP .fi .SH DESCRIPTION -.sp -.LP The \fBdhcpinfo\fR utility prints the \fBDHCP\fR-supplied value(s) of the parameter requested on the command line. The parameter can be identified either by its numeric code in the \fBDHCP\fR specification, or by its mnemonic identifier, as listed in \fBdhcp_inittab\fR(4). This command is intended to be -used in command substitutions in the shell scripts invoked by \fBinit\fR(1M) at -system boot. It first contacts the \fBDHCP\fR client daemon at system boot or +used in command substitutions in the shell scripts invoked at system boot or in event scripts as described in \fBdhcpagent\fR(1M). It first contacts the DHCP client daemon \fBdhcpagent\fR(1M) to verify that \fBDHCP\fR has successfully completed on the requested interface. If \fBDHCP\fR has @@ -41,8 +38,6 @@ Extensions\fR for more details on DHCPv4 parameters, and RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), for more details on DHCPv6 parameters. .SS "Output Format" -.sp -.LP The output from \fBdhcpinfo\fR consists of one or more lines of \fBASCII\fR text; the format of the output depends upon the requested parameter. The number of values returned per line and the total number of lines output for a given @@ -81,8 +76,6 @@ T} \fBDOMAIN\fR .TE .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -130,16 +123,14 @@ Limits the list of values displayed to \fIlimit\fR lines. .sp .ne 2 .na -\fB\fB-v\fR\fB4 | 6\fR\fR +\fB\fB-v 4|6\fR\fR .ad .RS 16n -Specifies the DHCP version to query. Use \fB-v4\fRfor DHCPv4 and \fB-v6\fR for -DHCPv6. +Specifies the DHCP version to query. Use \fB-v 4\fR for DHCPv4 and \fB-v 6\fR +for DHCPv6. .RE .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -163,8 +154,6 @@ Mnemonic symbol for the requested \fBDHCP\fR parameter, as listed in .RE .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -214,8 +203,6 @@ System error (should never occur). .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -230,9 +217,7 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp -.LP -\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBdhcp_inittab\fR(4), +\fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBdhcp_inittab\fR(4), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man1m/dhcpagent.1m b/usr/src/man/man1m/dhcpagent.1m index 90cc77e321..780af863ee 100644 --- a/usr/src/man/man1m/dhcpagent.1m +++ b/usr/src/man/man1m/dhcpagent.1m @@ -4,17 +4,15 @@ .\" 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 DHCPAGENT 1M "Jun 30, 2017" +.TH DHCPAGENT 1M "Feb 13, 2020" .SH NAME dhcpagent \- Dynamic Host Configuration Protocol (DHCP) client daemon .SH SYNOPSIS -.LP .nf \fBdhcpagent\fR [\fB-a\fR] [ \fB-d\fR \fIn\fR] [\fB-f\fR] [\fB-v\fR] .fi .SH DESCRIPTION -.LP \fBdhcpagent\fR implements the client half of the Dynamic Host Configuration Protocol \fB(DHCP)\fR for machines running illumos software. .sp @@ -141,7 +139,6 @@ If the name does not start with a stock symbol and a comma, it is automatically prefixed with \fBSUNW\fR. .RE .SS "Messages" -.LP The \fBdhcpagent\fR daemon writes information and error messages in five categories: .sp @@ -211,7 +208,6 @@ to the system logger \fBsyslog\fR(3C) at the appropriate matching priority and with a facility identifier \fBLOG_DAEMON\fR. When \fBdhcpagent\fR is run with the \fB-f\fR option, all messages are directed to standard error. .SS "DHCP Events and User-Defined Actions" -.LP If an executable (binary or script) is placed at \fB/etc/dhcp/eventhook\fR, the \fBdhcpagent\fR daemon will automatically run that program when any of the following events occur: @@ -351,7 +347,6 @@ is terminated by a \fBSIGKILL\fR signal. .LP See EXAMPLES for an example event program. .SH OPTIONS -.LP The following options are supported: .sp .ne 2 @@ -426,7 +421,6 @@ Provide verbose output useful for debugging site configuration problems. .RE .SH EXAMPLES -.LP \fBExample 1 \fRExample Event Program .sp .LP @@ -454,7 +448,7 @@ case $2 in ;; "EXTEND") echo "Lease extended for " \e - `sbin/dhcpinfo -i $1 LeaseTim`" seconds" + `/sbin/dhcpinfo -i $1 LeaseTim`" seconds" ;; "EXTEND6") echo "New lease information obtained on $i" @@ -823,7 +817,6 @@ Location of a DHCP event program. .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -838,7 +831,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBdhcpinfo\fR(1), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBin.mpathd\fR(1M), \fBin.ndpd\fR(1M), \fBipadm\fR(1M), \fBnwamcfg\fR(1M), \fBsyslog\fR(3C), \fBnodename\fR(4), \fBresolv.conf\fR(4), \fBattributes\fR(5), \fBdhcp\fR(5) @@ -863,7 +855,6 @@ Microsystems. February 2006. Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. July 2003. .SH NOTES -.LP The \fBdhcpagent\fR daemon can be used on IPv4 logical interfaces, just as with physical interfaces. When used on a logical interface, the daemon automatically constructs a Client ID value based on the DUID and IAID values, according to diff --git a/usr/src/man/man5/dhcp.5 b/usr/src/man/man5/dhcp.5 index 6a662bd6b1..33b8707449 100644 --- a/usr/src/man/man5/dhcp.5 +++ b/usr/src/man/man5/dhcp.5 @@ -4,11 +4,10 @@ .\" 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 DHCP 5 "Aug 15, 2014" +.TH DHCP 5 "Feb 13, 2020" .SH NAME dhcp \- Dynamic Host Configuration Protocol .SH DESCRIPTION -.LP Dynamic Host Configuration Protocol (\fBDHCP\fR) enables host systems in a \fBTCP/IP\fR network to be configured automatically for the network as they boot. \fBDHCP\fR uses a client/server mechanism: servers store configuration @@ -19,7 +18,6 @@ network services available to the client. This manual page provides a brief summary of the \fBDHCP\fR implementation. .SS "DHCP Client" -.LP The DHCP client is implemented as background daemon, \fBdhcpagent\fR(1M). .LP @@ -40,13 +38,11 @@ changing the tunables in the \fB/etc/default/dhcpagent\fR file. The daemon is controlled by the \fBifconfig\fR(1M) utility. Check the status of the daemon using the \fBnetstat\fR(1M) and \fBifconfig\fR(1M) commands. .SH SEE ALSO -.LP \fBdhcpinfo\fR(1), \fBdhcpagent\fR(1M), \fBifconfig\fR(1M), \fBin.ndpd\fR(1M), \fBnetstat\fR(1M), \fBsyslog\fR(3C), -\fBdhcp_network\fR(4), \fBdhcptab\fR(4), \fBdhcpsvc.conf\fR(4), -\fBdhcp_inittab\fR(4), \fBndpd.conf\fR(4), \fBdhcp_modules\fR(5) +\fBdhcp_inittab\fR(4), \fBndpd.conf\fR(4) .LP Alexander, S., and R. Droms. \fIRFC 2132, DHCP Options and BOOTP Vendor Extensions\fR. Silicon Graphics, Inc. Bucknell University. March 1997. -- cgit v1.2.3