File: 0004-man-Clarify-attr-1-manual-page.patch

package info (click to toggle)
attr 1%3A2.5.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,748 kB
  • sloc: sh: 5,287; ansic: 2,454; perl: 272; makefile: 45; sed: 16
file content (138 lines) | stat: -rw-r--r-- 4,644 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
From 622be1ba3c92be641fb0e7337e0145b25ffc7461 Mon Sep 17 00:00:00 2001
From: Guillem Jover <guillem@hadrons.org>
Date: Sun, 24 Dec 2023 20:20:53 +0100
Subject: [PATCH attr 4/7] man: Clarify attr(1) manual page

- Use namespace instead of address space.
- Update xattr namespaces used.
- Make it clear the command is a legacy tool for compatibility with
  the IRIX command of the same name.
- Mention that the initial intended filesystem was XFS, but can work
  with other filesystems.
- Change reference to xfsdump() to reference to GNU tar xattr support.

Origin: vendor
Forwarded: https://lists.nongnu.org/archive/html/acl-devel/2020-02/msg00003.html
Signed-off-by: Guillem Jover <guillem@hadrons.org>
---
 man/man1/attr.1 | 58 ++++++++++++++++++++++++-------------------------
 1 file changed, 29 insertions(+), 29 deletions(-)

diff --git a/man/man1/attr.1 b/man/man1/attr.1
index afc8d6c..037b50d 100644
--- a/man/man1/attr.1
+++ b/man/man1/attr.1
@@ -22,7 +22,7 @@
 .\"
 .TH ATTR 1 "Extended Attributes" "Dec 2001" "XFS Compatibility API"
 .SH NAME
-attr \- extended attributes on XFS filesystem objects
+attr \- legacy tool to handle extended attributes on filesystem objects
 .SH SYNOPSIS
 .nf
 \fBattr\fP [ \fB\-LRSq\fP ] \fB\-s\fP \fIattrname\fP [ \fB\-V\fP \fIattrvalue\fP ] \c
@@ -37,13 +37,15 @@ attr \- extended attributes on XFS filesystem objects
 .fi
 .SH OVERVIEW
 Extended attributes implement the ability for a user to attach
-name:value pairs to objects within the XFS filesystem.
+name:value pairs to objects within the filesystem.
 .PP
 This document describes the
 .B attr
 command, which is mostly compatible with the IRIX command of the same name.
-It is thus aimed specifically at users of the XFS filesystem - for
-filesystem independent extended attribute manipulation, consult the
+It was originally aimed specifically at users of the XFS filesystem, even
+though it can be used now on any filesystem that supports extended attributes,
+but for the generic and more portable interface for filesystem independent
+extended attribute manipulation, consult the
 .BR getfattr (1)
 and
 .BR setfattr (1)
@@ -55,7 +57,7 @@ use the Kanji character set when displaying that document
 and "thumbnail=..." could provide a reduced resolution overview of a
 high resolution graphic image.
 .PP
-In the XFS filesystem, the
+In supported filesystems, the
 .I names
 can be up to 256 bytes in length, terminated by the first 0 byte.
 The intent is that they be printable ASCII (or other character set)
@@ -64,30 +66,26 @@ The
 .I values
 can be up to 64KB of arbitrary binary data.
 .PP
-Attributes can be attached to all types of XFS inodes:
+Attributes can be attached to all types of inodes:
 regular files, directories, symbolic links, device nodes, etc.
 .PP
-XFS uses 2 disjoint attribute name spaces associated with every
-filesystem object.
-They are the
-.B root
-and
-.B user
-address spaces.
-The
-.B root
-address space is accessible only to the superuser,
-and then only by specifying a flag argument to the function call.
-Other users will not see or be able to modify attributes in the
-.B root
-address space.
-The
+Extended attributes use several disjoint attribute namespaces associated with
+every filesystem object: the
+.B trusted
+(or
+.B xfsroot
+for compatibility with IRIX) namespace, only accessible and visible to the
+superuser and when requested explicitly with an option,
+the
+.B security
+namespace with the same properties except used for security metadata,
+and the
 .B user
-address space is protected by the normal file permissions mechanism,
+namespace, which is protected by the normal file permissions mechanism,
 so the owner of the file can decide who is able to see and/or modify
 the value of attributes on any particular file.
 .SH DESCRIPTION
-The
+The legacy
 .B attr
 utility allows the manipulation of extended attributes associated with
 filesystem objects from within shell scripts.
@@ -162,9 +160,11 @@ When the
 .B \-R
 option is given and the process has appropriate privileges,
 operate in the
-.B root
+.B trusted
+(or
+.BR xfsroot )
 attribute namespace rather that the
-.I USER
+.B user
 attribute namespace.
 .PP
 The
@@ -185,10 +185,10 @@ The standard file interchange/archive programs
 .BR tar (1),
 and
 .BR cpio (1)
-will not archive or restore extended attributes,
-while the
-.BR xfsdump (8)
-program will.
+will not archive or restore extended attributes.
+Although GNU tar supports handling extended attributes with its
+.B \-\-xattrs
+option.
 .SH "CAVEATS"
 The list option present in the IRIX version of this command is not supported.
 .B getfattr
-- 
2.47.2