From: Dan Mick <dan.mick@inktank.com>
Date: Fri, 1 Feb 2013 02:43:29 +0000 (-0800)
Subject: rbd-fuse: quick and dirty manpage
X-Git-Tag: v0.57~64
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=91f8c3c859235d01f3bfd1b131c9cc6c83aac7a4;p=ceph.git

rbd-fuse: quick and dirty manpage

Signed-off-by: Dan Mick <dan.mick@inktank.com>
---

diff --git a/doc/man/8/rbd-fuse.rst b/doc/man/8/rbd-fuse.rst
new file mode 100644
index 000000000000..c717a9366046
--- /dev/null
+++ b/doc/man/8/rbd-fuse.rst
@@ -0,0 +1,54 @@
+=======================================
+ rbd-fuse -- expose rbd images as files
+=======================================
+
+.. program:: rbd-fuse
+
+Synopsis
+========
+
+| **rbd-fuse** [ -p pool ] [-c conffile] *mountpoint* [ *fuse options* ]
+
+
+Description
+===========
+
+**rbd-fuse** is a FUSE (File system in USErspace) client for RADOS
+block device (rbd) images.  Given a pool containing rbd images,
+it will mount a userspace filesystem allowing access to those images
+as regular files at **mountpoint**.
+
+The file system can be unmounted with::
+
+        fusermount -u mountpoint
+
+or by sending ``SIGINT`` to the ``rbd-fuse`` process.
+
+
+Options
+=======
+
+Any options not recognized by rbd-fuse will be passed on to libfuse.
+
+.. option:: -c ceph.conf
+
+   Use *ceph.conf* configuration file instead of the default
+   ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
+
+.. option:: -p pool
+
+   Use *pool* as the pool to search for rbd images.  Default is ``rbd``.
+
+
+Availability
+============
+
+**rbd-fuse** is part of the Ceph distributed file system. Please refer to
+the Ceph documentation at http://ceph.com/docs for more information.
+
+
+See also
+========
+
+fusermount(8),
+:doc:`rbd <rbd>`\(8)
diff --git a/man/rbd-fuse.8 b/man/rbd-fuse.8
new file mode 100644
index 000000000000..335e06fac7bb
--- /dev/null
+++ b/man/rbd-fuse.8
@@ -0,0 +1,79 @@
+.TH "RBD-FUSE" "8" "January 31, 2013" "dev" "Ceph"
+.SH NAME
+rbd-fuse \- expose rbd images as files
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructuredText.
+.
+.SH SYNOPSIS
+.nf
+\fBrbd\-fuse\fP [ \-p pool ] [\-c conffile] \fImountpoint\fP [ \fIfuse options\fP ]
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+\fBrbd\-fuse\fP is a FUSE (File system in USErspace) client for RADOS
+block device (rbd) images.  Given a pool containing rbd images,
+it will mount a userspace filesystem allowing access to those images
+as regular files at \fBmountpoint\fP.
+.sp
+The file system can be unmounted with:
+.sp
+.nf
+.ft C
+fusermount \-u mountpoint
+.ft P
+.fi
+.sp
+or by sending \fBSIGINT\fP to the \fBrbd\-fuse\fP process.
+.SH OPTIONS
+.sp
+Any options not recognized by rbd\-fuse will be passed on to libfuse.
+.INDENT 0.0
+.TP
+.B \-c ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-p pool
+Use \fIpool\fP as the pool to search for rbd images.  Default is \fBrbd\fP.
+.UNINDENT
+.SH AVAILABILITY
+.sp
+\fBrbd\-fuse\fP is part of the Ceph distributed file system. Please refer to
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
+.SH SEE ALSO
+.sp
+fusermount(8),
+\fBrbd\fP(8)
+.SH COPYRIGHT
+2010-2012, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
+.\" Generated by docutils manpage writer.
+.