Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1 | From 6047c8522b91235ad1e835f44f5e36472d9d49b2 Mon Sep 17 00:00:00 2001 |
| 2 | From: Andreas Gruenbacher <andreas.gruenbacher@gmail.com> |
| 3 | Date: Wed, 22 Apr 2015 11:46:59 +0200 |
| 4 | Subject: [PATCH 2/2] Remove the attr.5 man page (moved to man-pages) |
| 5 | |
| 6 | Commit dce9b4448c7f2b22bd206cd068fb05cb2f3255b9 from |
| 7 | https://git.savannah.nongnu.org/git/attr.git |
| 8 | |
| 9 | The attr.5 page is part of the extended attribute system call documentation, |
| 10 | which has been moved into the man-pages package. Move the attr.5 page there |
| 11 | as well. |
| 12 | |
| 13 | Upstream-Status: Backport |
| 14 | |
| 15 | [MA: updated to apply directly to v2.4.47] |
| 16 | Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com> |
| 17 | --- |
| 18 | man/Makefile | 2 +- |
| 19 | man/man5/Makefile | 35 ------------- |
| 20 | man/man5/attr.5 | 153 ------------------------------------------------------ |
| 21 | 3 files changed, 1 insertion(+), 189 deletions(-) |
| 22 | delete mode 100644 man/man5/Makefile |
| 23 | delete mode 100644 man/man5/attr.5 |
| 24 | |
| 25 | diff --git a/man/Makefile b/man/Makefile |
| 26 | index 755daed..9301f09 100644 |
| 27 | --- a/man/Makefile |
| 28 | +++ b/man/Makefile |
| 29 | @@ -19,7 +19,7 @@ |
| 30 | TOPDIR = .. |
| 31 | include $(TOPDIR)/include/builddefs |
| 32 | |
| 33 | -SUBDIRS = man1 man3 man5 |
| 34 | +SUBDIRS = man1 man3 |
| 35 | |
| 36 | default : $(SUBDIRS) |
| 37 | |
| 38 | diff --git a/man/man5/Makefile b/man/man5/Makefile |
| 39 | deleted file mode 100644 |
| 40 | index 6b70d3d..0000000 |
| 41 | --- a/man/man5/Makefile |
| 42 | +++ /dev/null |
| 43 | @@ -1,35 +0,0 @@ |
| 44 | -# |
| 45 | -# Copyright (c) 2000, 2002 Silicon Graphics, Inc. All Rights Reserved. |
| 46 | -# Copyright (C) 2009 Andreas Gruenbacher <agruen@suse.de> |
| 47 | -# |
| 48 | -# This program is free software: you can redistribute it and/or modify it |
| 49 | -# under the terms of the GNU General Public License as published by |
| 50 | -# the Free Software Foundation, either version 2 of the License, or |
| 51 | -# (at your option) any later version. |
| 52 | -# |
| 53 | -# This program is distributed in the hope that it will be useful, |
| 54 | -# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 55 | -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 56 | -# GNU General Public License for more details. |
| 57 | -# |
| 58 | -# You should have received a copy of the GNU General Public License |
| 59 | -# along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 60 | -# |
| 61 | - |
| 62 | -TOPDIR = ../.. |
| 63 | -include $(TOPDIR)/include/builddefs |
| 64 | - |
| 65 | -MAN_SECTION = 5 |
| 66 | - |
| 67 | -MAN_PAGES = $(shell echo *.$(MAN_SECTION)) |
| 68 | -MAN_DEST = $(PKG_MAN_DIR)/man$(MAN_SECTION) |
| 69 | -LSRCFILES = $(MAN_PAGES) |
| 70 | - |
| 71 | -default : $(MAN_PAGES) |
| 72 | - |
| 73 | -include $(BUILDRULES) |
| 74 | - |
| 75 | -install : default |
| 76 | - $(INSTALL) -m 755 -d $(MAN_DEST) |
| 77 | - $(INSTALL_MAN) |
| 78 | -install-dev install-lib: |
| 79 | diff --git a/man/man5/attr.5 b/man/man5/attr.5 |
| 80 | deleted file mode 100644 |
| 81 | index a02757d..0000000 |
| 82 | --- a/man/man5/attr.5 |
| 83 | +++ /dev/null |
| 84 | @@ -1,153 +0,0 @@ |
| 85 | -.\" Extended attributes manual page |
| 86 | -.\" |
| 87 | -.\" Copyright (C) 2000, 2002, 2007 Andreas Gruenbacher <agruen@suse.de> |
| 88 | -.\" Copyright (C) 2001, 2002, 2004, 2007 Silicon Graphics, Inc. |
| 89 | -.\" All rights reserved. |
| 90 | -.\" |
| 91 | -.\" This is free documentation; you can redistribute it and/or |
| 92 | -.\" modify it under the terms of the GNU General Public License as |
| 93 | -.\" published by the Free Software Foundation; either version 2 of |
| 94 | -.\" the License, or (at your option) any later version. |
| 95 | -.\" |
| 96 | -.\" The GNU General Public License's references to "object code" |
| 97 | -.\" and "executables" are to be interpreted as the output of any |
| 98 | -.\" document formatting or typesetting system, including |
| 99 | -.\" intermediate and printed output. |
| 100 | -.\" |
| 101 | -.\" This manual is distributed in the hope that it will be useful, |
| 102 | -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 103 | -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 104 | -.\" GNU General Public License for more details. |
| 105 | -.\" |
| 106 | -.\" You should have received a copy of the GNU General Public |
| 107 | -.\" License along with this manual. If not, see |
| 108 | -.\" <http://www.gnu.org/licenses/>. |
| 109 | -.\" |
| 110 | -.TH ATTR 5 |
| 111 | -.SH NAME |
| 112 | -attr - Extended attributes |
| 113 | -.SH DESCRIPTION |
| 114 | -Extended attributes are name:value pairs associated permanently with |
| 115 | -files and directories, similar to the environment strings associated |
| 116 | -with a process. |
| 117 | -An attribute may be defined or undefined. |
| 118 | -If it is defined, its value may be empty or non-empty. |
| 119 | -.PP |
| 120 | -Extended attributes are extensions to the normal attributes which are |
| 121 | -associated with all inodes in the system (i.e. the |
| 122 | -.BR stat (2) |
| 123 | -data). |
| 124 | -They are often used to provide additional functionality |
| 125 | -to a filesystem \- for example, additional security features such as |
| 126 | -Access Control Lists (ACLs) may be implemented using extended attributes. |
| 127 | -.PP |
| 128 | -Users with search access to a file or directory may retrieve a list of |
| 129 | -attribute names defined for that file or directory. |
| 130 | -.PP |
| 131 | -Extended attributes are accessed as atomic objects. |
| 132 | -Reading retrieves the whole value of an attribute and stores it in a buffer. |
| 133 | -Writing replaces any previous value with the new value. |
| 134 | -.PP |
| 135 | -Space consumed for extended attributes is counted towards the disk quotas |
| 136 | -of the file owner and file group. |
| 137 | -.PP |
| 138 | -Currently, support for extended attributes is implemented on Linux by the |
| 139 | -ext2, ext3, ext4, XFS, JFS and reiserfs filesystems. |
| 140 | -.SH EXTENDED ATTRIBUTE NAMESPACES |
| 141 | -Attribute names are zero-terminated strings. |
| 142 | -The attribute name is always specified in the fully qualified |
| 143 | -.IR namespace.attribute |
| 144 | -form, eg. |
| 145 | -.IR user.mime_type , |
| 146 | -.IR trusted.md5sum , |
| 147 | -.IR system.posix_acl_access , |
| 148 | -or |
| 149 | -.IR security.selinux . |
| 150 | -.PP |
| 151 | -The namespace mechanism is used to define different classes of extended |
| 152 | -attributes. |
| 153 | -These different classes exist for several reasons, e.g. the permissions |
| 154 | -and capabilities required for manipulating extended attributes of one |
| 155 | -namespace may differ to another. |
| 156 | -.PP |
| 157 | -Currently the |
| 158 | -.IR security , |
| 159 | -.IR system , |
| 160 | -.IR trusted , |
| 161 | -and |
| 162 | -.IR user |
| 163 | -extended attribute classes are defined as described below. Additional |
| 164 | -classes may be added in the future. |
| 165 | -.SS Extended security attributes |
| 166 | -The security attribute namespace is used by kernel security modules, |
| 167 | -such as Security Enhanced Linux. |
| 168 | -Read and write access permissions to security attributes depend on the |
| 169 | -policy implemented for each security attribute by the security module. |
| 170 | -When no security module is loaded, all processes have read access to |
| 171 | -extended security attributes, and write access is limited to processes |
| 172 | -that have the CAP_SYS_ADMIN capability. |
| 173 | -.SS Extended system attributes |
| 174 | -Extended system attributes are used by the kernel to store system |
| 175 | -objects such as Access Control Lists and Capabilities. Read and write |
| 176 | -access permissions to system attributes depend on the policy implemented |
| 177 | -for each system attribute implemented by filesystems in the kernel. |
| 178 | -.SS Trusted extended attributes |
| 179 | -Trusted extended attributes are visible and accessible only to processes that |
| 180 | -have the CAP_SYS_ADMIN capability (the super user usually has this |
| 181 | -capability). |
| 182 | -Attributes in this class are used to implement mechanisms in user |
| 183 | -space (i.e., outside the kernel) which keep information in extended attributes |
| 184 | -to which ordinary processes should not have access. |
| 185 | -.SS Extended user attributes |
| 186 | -Extended user attributes may be assigned to files and directories for |
| 187 | -storing arbitrary additional information such as the mime type, |
| 188 | -character set or encoding of a file. The access permissions for user |
| 189 | -attributes are defined by the file permission bits. |
| 190 | -.PP |
| 191 | -The file permission bits of regular files and directories are |
| 192 | -interpreted differently from the file permission bits of special files |
| 193 | -and symbolic links. For regular files and directories the file |
| 194 | -permission bits define access to the file's contents, while for device special |
| 195 | -files they define access to the device described by the special file. |
| 196 | -The file permissions of symbolic links are not used in access |
| 197 | -checks. These differences would allow users to consume filesystem resources in |
| 198 | -a way not controllable by disk quotas for group or world writable special files and directories. |
| 199 | -.PP |
| 200 | -For this reason, extended user attributes are only allowed for regular files and directories, and access to extended user attributes is restricted to the |
| 201 | -owner and to users with appropriate capabilities for directories with the |
| 202 | -sticky bit set (see the |
| 203 | -.BR chmod (1) |
| 204 | -manual page for an explanation of Sticky Directories). |
| 205 | -.SH FILESYSTEM DIFFERENCES |
| 206 | -The kernel and the filesystem may place limits on the maximum number |
| 207 | -and size of extended attributes that can be associated with a file. |
| 208 | -Some file systems, such as ext2/3 and reiserfs, require the filesystem |
| 209 | -to be mounted with the |
| 210 | -.B user_xattr |
| 211 | -mount option in order for extended user attributes to be used. |
| 212 | -.PP |
| 213 | -In the current ext2, ext3 and ext4 filesystem implementations, each |
| 214 | -extended attribute must fit on a single filesystem block (1024, 2048 |
| 215 | -or 4096 bytes, depending on the block size specified when the |
| 216 | -filesystem was created). |
| 217 | -.PP |
| 218 | -In the XFS and reiserfs filesystem implementations, there is no |
| 219 | -practical limit on the number or size of extended attributes |
| 220 | -associated with a file, and the algorithms used to store extended |
| 221 | -attribute information on disk are scalable. |
| 222 | -.PP |
| 223 | -In the JFS filesystem implementation, names can be up to 255 bytes and |
| 224 | -values up to 65,535 bytes. |
| 225 | -.SH ADDITIONAL NOTES |
| 226 | -Since the filesystems on which extended attributes are stored might also |
| 227 | -be used on architectures with a different byte order and machine word |
| 228 | -size, care should be taken to store attribute values in an architecture |
| 229 | -independent format. |
| 230 | -.SH AUTHORS |
| 231 | -Andreas Gruenbacher, |
| 232 | -.RI < a.gruenbacher@bestbits.at > |
| 233 | -and the SGI XFS development team, |
| 234 | -.RI < linux-xfs@oss.sgi.com >. |
| 235 | -.SH SEE ALSO |
| 236 | -getfattr(1), |
| 237 | -setfattr(1). |
| 238 | -- |
| 239 | 2.7.4 |
| 240 | |