From: Christoph Hellwig <hch@lst.de>
Date: Sat, 21 Mar 2009 19:33:27 +0000 (+0100)
Subject: xfsprogs: add projects(5) and projid(5) manpages
X-Git-Tag: v3.0.1~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8bc1110d8a6087cfeddc1656c6b4095149fb6240;p=thirdparty%2Fxfsprogs-dev.git

xfsprogs: add projects(5) and projid(5) manpages

Document the /etc/projects and /etc/projid files in their own manpages
instead of in xfs_quota(8).

Signed-off-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: Eric Sandeen <sandeen@sandeen.net>
---

diff --git a/man/man5/projects.5 b/man/man5/projects.5
new file mode 100644
index 000000000..d8fb56dff
--- /dev/null
+++ b/man/man5/projects.5
@@ -0,0 +1,31 @@
+.TH projects 5
+.SH NAME
+projects \- persistent project root defintion
+.SH DESCRIPTION
+The
+.I /etc/projects
+file provides a mapping between numeric project identifiers and those directories
+which are the roots of the quota tree.  Its format is simply:
+
+.nf
+.sp
+.in +5
+# comments are hash-prefixed
+# ...
+10:/export/cage
+42:/var/log
+.in -5
+.fi
+.PP
+The
+.I /etc/projects
+file is optional, instead
+.BR xfs_quota (8)
+can be used with the
+.B \-p
+argument to specify a project root directly for each operation.
+
+.SH SEE ALSO
+.BR xfs_quota (8),
+.BR xfsctl (3),
+.BR projid (5).
diff --git a/man/man5/projid.5 b/man/man5/projid.5
new file mode 100644
index 000000000..c8ef71eb8
--- /dev/null
+++ b/man/man5/projid.5
@@ -0,0 +1,29 @@
+.TH projid 5
+.SH NAME
+projid \- the project name mapping file
+.SH DESCRIPTION
+The
+.I /etc/projid
+file provides a mapping between numeric project identifiers and a
+simple human readable name (similar relationship to the one that
+exists between usernames and uids).
+Its format is simply:
+.nf
+.sp
+.in +5
+# comments are hash-prefixed
+# ...
+cage:10
+logfiles:42
+
+.in -5
+.fi
+.PP
+
+This file is optional, if a project identifier cannot be mapped to
+a name, it will be parsed and displayed as a numeric value.
+
+.SH SEE ALSO
+.BR xfs_quota (8),
+.BR xfsctl (3),
+.BR projects (5).
diff --git a/man/man8/xfs_quota.8 b/man/man8/xfs_quota.8
index e9afa2e62..08c354ad0 100644
--- a/man/man8/xfs_quota.8
+++ b/man/man8/xfs_quota.8
@@ -628,46 +628,6 @@ for
 .I /etc/projects
 to exist. Note that if projects file exists then it is also used.
 
-.SH FILE FORMATS
-There are two files involved with the tree quota mechanism, namely
-.I /etc/projects
-and
-.IR /etc/projid .
-The latter is optional.
-The
-.I /etc/projects
-file provides a mapping between numeric project identifiers and those
-directories which are the roots of the quota tree.
-Its format is simply:
-.nf
-.sp
-.in +5
-# comments are hash-prefixed
-# ...
-10:/export/cage
-42:/var/log
-.in -5
-.fi
-.PP
-The
-.I /etc/projid
-file provides a mapping between numeric project identifiers and a
-simple human readable name (similar relationship to the one that
-exists between usernames and uids).
-Its format is simply:
-.nf
-.sp
-.in +5
-# comments are hash-prefixed
-# ...
-cage:10
-logfiles:42
-.in -5
-.fi
-.PP
-This file is optional, if a project identifier cannot be mapped to
-a name, it will be displayed as a number only.
-.PP
 .SH EXAMPLES
 Enabling quota enforcement on an XFS filesystem (restrict a user
 to a set amount of space).
@@ -752,4 +712,6 @@ Mapping of numeric project identifiers to project names.
 .SH SEE ALSO
 .BR df (1),
 .BR mount (1),
-.BR sync (2).
+.BR sync (2),
+.BR projid (5),
+.BR projects (5).