From af749e62cb0d006fdcb32a1e361394823d06b2af Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Thu, 7 Oct 2010 09:38:37 -0700 Subject: [PATCH] cdebugpack: man page Signed-off-by: Sage Weil --- ceph.spec.in | 1 + debian/ceph.install | 1 + man/Makefile.am | 3 ++- man/cdebugpack.8 | 27 +++++++++++++++++++++++++++ 4 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 man/cdebugpack.8 diff --git a/ceph.spec.in b/ceph.spec.in index 8f47f5354f3..143cd6dfc40 100644 --- 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 ee090755040..ee998647fe7 100644 --- 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 1f367f90611..148bae7afc7 100644 --- 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 index 00000000000..e56dc93c569 --- /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)