cdebugpack: man page

Signed-off-by: Sage Weil <sage@newdream.net>

diff --git a/ceph.spec.in b/ceph.spec.in
index 8f47f5354f336dbb8672d594368705bd1d039b83..143cd6dfc4043cb45eea19914e6fc07e617a101a 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -142,6 +142,7 @@ fi
 %{_mandir}/man8/rados.8*
 %{_mandir}/man8/rbd.8*
 %{_mandir}/man8/cauthtool.8*
+%{_mandir}/man8/cdebugpack.8*
 %{_mandir}/man8/cclass.8.gz
 %{_mandir}/man8/cclsinfo.8.gz
 %dir %{_localstatedir}/lib/ceph/

diff --git a/debian/ceph.install b/debian/ceph.install
index ee0907550401bc1ff6551dd2549ca88a721c7490..ee998647fe752bbe500fa4e797f51f7e728f3cf7 100644 (file)
--- a/debian/ceph.install
+++ b/debian/ceph.install
@@ -29,3 +29,4 @@ usr/share/man/man8/ceph.8
 usr/share/man/man8/cauthtool.8
 usr/share/man/man8/cclass.8
 usr/share/man/man8/cclsinfo.8
+usr/share/man/man8/cdebugpack.8

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

diff --git a/man/cdebugpack.8 b/man/cdebugpack.8
new file mode 100644 (file)
index 0000000..e56dc93
--- /dev/null
+++ b/man/cdebugpack.8
@@ -0,0 +1,27 @@
+.TH CDEBUGPACK 8
+.SH NAME
+cdebugpack \- ceph debug packer utility
+.SH SYNOPSIS
+.B cdebugpack
+[ \fIoptions\fR ] \fIfilename.tar.gz\fR
+.SH DESCRIPTION
+.B cdebugpack
+will build a tarball containing various items that are useful for
+debugging crashes.  The resulting tarball can be shared with Ceph
+developers when debugging a problem.
+.P
+The tarball will include the binaries for cmds, cosd, and cmon, any
+log files, the ceph.conf configuration file, any core files we can
+find, and (if the system is running) dumps of the current osd, mds,
+and pg maps from the monitor.
+.SH OPTIONS
+.TP
+\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
+Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
+to determine monitor addresses during startup.
+.SH AVAILABILITY
+.B cdebugpack
+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)