summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorSage Weil <sage@newdream.net>2009-03-10 16:30:15 -0700
committerSage Weil <sage@newdream.net>2009-03-10 16:31:16 -0700
commitebd9a942e1fff0d12b3a1d59c1bd39b357535592 (patch)
tree60a115906f2c9936f514d2a12f2490043b7516fd /man
parentcdc34bc12bd58d243dd39bbbca66071f91cec084 (diff)
downloadceph-ebd9a942e1fff0d12b3a1d59c1bd39b357535592.tar.gz
man: add cfuse man page
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am4
-rw-r--r--man/cfuse.843
2 files changed, 45 insertions, 2 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index 0eb2d0c30e6..3693319bf09 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,4 +1,4 @@
AUTOMAKE_OPTIONS = gnu
-man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8
-dist_man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 \ No newline at end of file
+man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 cfuse.8
+dist_man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 cfuse.8 \ No newline at end of file
diff --git a/man/cfuse.8 b/man/cfuse.8
new file mode 100644
index 00000000000..430a2f3d174
--- /dev/null
+++ b/man/cfuse.8
@@ -0,0 +1,43 @@
+.TH CFUSE 8
+.SH NAME
+cfuse \- FUSE-based client for ceph
+.SH SYNOPSIS
+.B cfuse
+[ \fB\-m monaddr:port\fP ]
+\fImountpoint\fP
+[ \fIfuse options\fP ]
+.SH DESCRIPTION
+.B cfuse
+is a FUSE (File system in USErspace) client for Ceph distributed
+file system. It will mount a ceph file system (specified via the
+\fB\-m\fP option for described by \fIcluster.conf\fP (see below) at
+the specific mount point.
+.PP
+The file system can be unmounted with:
+.IP
+fusermount -u \fImountpoint\fP
+.PP
+or by sending SIGINT to the \fBcfuse\fP process.
+.SH OPTIONS
+Any options not recognized by \fBcfuse\fP will be passed on to libfuse.
+.TP
+\fB\-d\fP
+Detach from console and daemonize after startup.
+.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
+for runtime configuration options.
+.TP
+\fB\-C\fI cluster.conf\fR, \fB\-\-cluster-conf=\fIcluster.conf\fR
+Use \fIcluster.conf\fP cluster configuration file instead of the default \fI/etc/ceph/cluster.conf\fP
+to determine monitor addresses during startup.
+.TP
+\fB\-m\fI monaddress[:port]\fR
+Connect to specified monitor (instead of looking through \fIcluster.conf\fR).
+.SH AVAILABILITY
+.B cfuse
+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 fusermount (8),
+.BR ceph (8)