Re: [PATCH] man: make attr.1 man page generic

[Achilles Gaikwad]

Hello,

Any feedback on this? Shall I make modifications as per Guillem's patch?

Best,
- Achilles
---

On Fri, Feb 7, 2020 at 11:59 AM Achilles Gaikwad <address@hidden> wrote:
>
> The attr(1) man page states it is specifically for XFS filesystem,
> however the command works for other filesystems as well. Therefore, we
> remove the XFS specific bits and pieces from the man page and make the
> man page more generic.
>
> Signed-off-by: Achilles Gaikwad <address@hidden>
> ---
>  man/man1/attr.1 | 46 ++--------------------------------------------
>  1 file changed, 2 insertions(+), 44 deletions(-)
>
> diff --git a/man/man1/attr.1 b/man/man1/attr.1
> index 84e80de..09d8919 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 \- extended attributes on filesystem objects
>  .SH SYNOPSIS
>  .nf
>  \f3attr\f1 [ \f3\-LRSq\f1 ] \f3\-s attrname\f1 [ \f3\-V attrvalue\f1 ] \c
> @@ -37,55 +37,13 @@ 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.
> -.PP
> -This document describes the
> -.I 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
> -.IR getfattr (1)
> -and
> -.IR setfattr (1)
> -documentation.
> +name:value pairs to objects within the filesystem.
>  .PP
>  Extended attributes can be used to store meta-information about the file.
>  For example "character-set=kanji" could tell a document browser to
>  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
> -.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)
> -names for the attribute.
> -The
> -.I values
> -can be up to 64KB of arbitrary binary data.
> -.PP
> -Attributes can be attached to all types of XFS 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
> -.B user
> -address space 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
>  .I attr
> --
> 2.24.1
>