man: add man page for cephfs

Add to Makefile, debian, and ceph.spec.in bits

diff --git a/ceph.spec.in b/ceph.spec.in
index f2f393084c60ee5a6ea6a97bdc336329ce5eaea1..73544f86eae15baf0753221a4743fed6dabf8d99 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -143,6 +143,7 @@ fi
 %{_mandir}/man8/monmaptool.8*
 %{_mandir}/man8/cconf.8*
 %{_mandir}/man8/ceph.8*
+%{_mandir}/man8/cephfs.8*
 %{_mandir}/man8/mount.ceph.8*
 %{_mandir}/man8/radosgw.8*
 %{_mandir}/man8/radosgw_admin.8*

diff --git a/debian/ceph.install b/debian/ceph.install
index b4f0f89f512da93901b2bdde3231e80f46cef764..ad7c4b89c845b1ca5a1fd0505525c1d37d5717e6 100644 (file)
--- a/debian/ceph.install
+++ b/debian/ceph.install
@@ -27,6 +27,7 @@ usr/share/man/man8/osdmaptool.8
 usr/share/man/man8/monmaptool.8
 usr/share/man/man8/cconf.8
 usr/share/man/man8/ceph.8
+usr/share/man/man8/cephfs.8
 usr/share/man/man8/cauthtool.8
 usr/share/man/man8/cclass.8
 usr/share/man/man8/cclsinfo.8

diff --git a/man/Makefile.am b/man/Makefile.am
index 148bae7afc749a8c335f6282e7855701a124fcaa..d3e07141de7df0643fb4a8c5d392f7cd0207c536 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -21,4 +21,5 @@ dist_man_MANS = \
        rbd.8 \
        cclass.8 \
        cclsinfo.8 \
-       cdebugpack.8
+       cdebugpack.8 \
+       cephfs.8

diff --git a/man/cephfs.8 b/man/cephfs.8
new file mode 100644 (file)
index 0000000..409c37b
--- /dev/null
+++ b/man/cephfs.8
@@ -0,0 +1,68 @@
+.TH CEPHFS 8
+.SH NAME
+cephfs \- ceph file system options utility
+.SH SYNOPSIS
+.B cephfs
+[ \fIpath \fIcommand \fBoptions]
+.SH DESCRIPTION
+.B cephfs
+is a control utility for accessing and manipulating file layout
+and location data in the Ceph distributed file system.
+
+Choose one of the following three commands:
+.TP
+\fBshow_layout \fPView the layout information on a file or directory
+.TP
+\fBset_layout  \fPSet the layout information on a file or directory.
+.TP
+\fBshow_location \fPView the location information on a file
+
+.SH OPTIONS
+Your applicable options differ depending on whether you are setting
+or viewing layout/location.
+.TP
+\fBViewing options:
+.IP
+\fB\-l \--offset
+\fPSpecify an offset for which to retrieve location data
+
+.TP
+\fBSetting options:
+.IP
+\fB\-u
+\--stripe_unit \fP
+Set the size of each stripe
+.IP
+\fB\-c
+\--stripe_count \fP
+Set the number of stripes per object
+.IP
+\fB\-s
+\--object_size \fP
+Set the size of the objects to stripe across
+.IP
+\fB\-p
+\--pool \fP
+Set the pool (by numeric value, not name!) to use
+.IP
+\fB\-o
+\--osd \fP
+Set the preferred OSD to use as the primary
+
+.SH LIMITATIONS
+When setting layout data, the specified stripe unit and stripe count
+must multiply to the size of an object. Any parameters you don't set explicitly are left at the system defaults.
+
+Obviously setting the layout of a file and a directory means different things.
+Setting the layout of a file specifies exactly how to place the individual file. This must be done before writing *any* data to it. Truncating a file does not allow you to change the layout either.
+
+Setting the layout of a directory sets the "default layout", which is used to set the file layouts on any files subsequently created in the directory (or any subdirectory). Pre-existing files do not have their layouts changed.
+
+You'll notice that the layout information allows you to specify a preferred OSD for placement. This is allowed but is not recommended since it can dramatically unbalance your storage cluster's space utilization.
+
+.SH AVAILABILITY
+.B cephfs
+is part of the Ceph distributed file system.  Please refer to the Ceph wiki at
+http://ceph.newdream.net/wiki for more information.
+.SH SEE ALSO
+.BR ceph (8)