ceph/man/rbd-fuse.8
Dan Mick 334568e005 rbd-fuse: quick and dirty manpage
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-01-31 19:29:26 -08:00

80 lines
2.0 KiB
Groff

.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.
.