summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorYehuda Sadeh <yehuda@hq.newdream.net>2010-06-30 19:32:21 +0200
committerYehuda Sadeh <yehuda@hq.newdream.net>2010-06-30 19:32:21 +0200
commite76ce441314bced42a02a140d15db30d2bd26eb0 (patch)
tree718517572d5d152a45fce28782cd2c93dc0a6c84 /man
parentfilejournal: fix buffer realignment condition; useful debug output on error (diff)
downloadceph-e76ce441314bced42a02a140d15db30d2bd26eb0.tar.xz
ceph-e76ce441314bced42a02a140d15db30d2bd26eb0.zip
man: add man pages for cclass and cclsinfo
Diffstat (limited to 'man')
-rw-r--r--man/cclass.834
-rw-r--r--man/cclsinfo.826
2 files changed, 60 insertions, 0 deletions
diff --git a/man/cclass.8 b/man/cclass.8
new file mode 100644
index 00000000000..3cede035c3c
--- /dev/null
+++ b/man/cclass.8
@@ -0,0 +1,34 @@
+.TH CCLASS 8
+.SH NAME
+cclass \- ceph class loading utility
+.SH SYNOPSIS
+.B cclass
+[ \fIoptions\fR ] ... [ \fIcls_filename\fR ]
+.SH DESCRIPTION
+.B cclass
+will load class libraries into the ceph cluster. Ceph classes are loadable libraries that complement
+and extend the \fIosd\fR functionality. They define \fImethods\fR that can be executed on osd objects and
+may read and modify the data on these objects.
+.SH OPTIONS
+.TP
+\fB\-l\fP, \fB\-\-load\fP
+Loads a class, specified by \fIcls_filename\fR, into the system
+.TP
+\fB\-a\fP, \fB\-\-load-all\fP
+Searches for all the classes in the specified libdir and try to load them into the monitor
+.TP
+\fB\-L\fP, \fB\-\-libdir \fIpath\fP
+Specifies the path where classes will be searched for (used in conjuction with \fB\-\-load-all\fP)
+.TP
+\fB\-o\fP, \fB\-\-overwrite\fP
+Overwrite an existing class with the same name, version, and architecture.
+.TP
+\fB\-e\fP, \fB\-\-excl\fP
+Exclusively load class. Will only load the class if one with the same name (and version and architecture) hasn't been loaded yet.
+.SH AVAILABILITY
+.B cclass
+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 cclsinfo (8)
+.BR ceph (8)
diff --git a/man/cclsinfo.8 b/man/cclsinfo.8
new file mode 100644
index 00000000000..222592f2f11
--- /dev/null
+++ b/man/cclsinfo.8
@@ -0,0 +1,26 @@
+.TH CCLSINFO 8
+.SH NAME
+cclsinfo \- show class object information
+.SH SYNOPSIS
+.B cclsinfo
+[ \fIoptions\fR ] ... \fIfilename\fR
+.SH DESCRIPTION
+.B cclsinfo
+can show name, version, and architecture information about a specific class object.
+.SH OPTIONS
+.TP
+\fB\-n\fP, \fB\-\-name\fP
+Shows the class name
+.TP
+\fB\-v\fP, \fB\-\-version\fP
+Shows the class version
+.TP
+\fB\-a\fP, \fB\-\-arch\fP
+Shows the class architecture
+.SH AVAILABILITY
+.B cclsinfo
+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 cclass (8)
+.BR ceph (8)