man: mkcephfs, cosd man pages

5 files changed, 101 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index 9c07832b0e5..b2bedbe4158 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
 AUTOMAKE_OPTIONS = gnu
 EXTRA_DIST = debian autogen.sh ceph.spec.in
-SUBDIRS = src
+SUBDIRS = src man
 
 dist-hook:
 	src/make_version
diff --git a/configure.ac b/configure.ac
index 45ccc46b7b7..a9bcecb7442 100644
--- a/configure.ac
+++ b/configure.ac
@@ -150,6 +150,7 @@ AC_CHECK_HEADERS([sys/xattr.h arpa/inet.h netdb.h netinet/in.h sys/file.h sys/io
 AC_CONFIG_HEADERS([src/acconfig.h])
 AC_CONFIG_FILES([Makefile
 	src/Makefile
+	man/Makefile
 	ceph.spec])
 AC_OUTPUT
 
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 00000000000..120ced2e69a
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,4 @@
+AUTOMAKE_OPTIONS = gnu
+
+man_MANS = cosd.8
+dist_man_MANS = cosd.8
\ No newline at end of file
diff --git a/man/cosd.8 b/man/cosd.8
new file mode 100644
index 00000000000..0d8e6075c2f
--- /dev/null
+++ b/man/cosd.8
@@ -0,0 +1,52 @@
+.TH COSD 8
+.SH NAME
+cosd \- ceph object storage daemon
+.SH SYNOPSIS
+.B cosd
+[ \fB\-d\fP ]
+\fIdatapath\fP
+[ \fB\-j\fI journal\fP ]
+[ \fB\-c\fI ceph.conf\fP ]
+[ \fB\-\-mkfs_for_osd\fI nodeid\fP ]
+.SH DESCRIPTION
+.B cosd
+is the object storage daemon for the Ceph distributed file system.
+It is responsible for storing objects on a local file system and 
+providing access to them over the network.
+.PP
+The \fIdatapath\fP argument should be a directory on a btrfs file
+system where the object data resides.  The \fIjournal\fP is optional,
+and is only useful performance-wise when it resides on a different
+disk than \fIdatapath\fP with low latency (ideally, an NVRAM device).
+.PP
+If neither \fB-d\fP nor \fB-f\fP is specified, the daemon will run
+in the foreground and log to stdout.
+.SH OPTIONS
+.TP
+\fB\-d\fP
+daemonize after startup.
+.TP
+\fB\-f\fP
+do not daemonize after startup (run in foreground).  Useful when run via 
+.BR crun (8).
+.TP
+\fB\-j\fI journal\fP
+Journal updates to \fIjournal\fP.
+.TP
+\fB\-\-mkfs_for_osd\fI nodeid\fP
+Create an empty object repository for OSD number \fInodeid\fP.  Normally
+invoked by
+.BR mkcephfs (8).
+.TP
+\fB\-c\fI ceph.conf\fR or \fB\-\-conf_file\fI ceph.conf\fP
+Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
+for runtime configuration options.
+.SH AVAILABILITY
+.B cosd
+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),
+.BR mkmonfs (8),
+.BR cmds (8),
+.BR cmon (8)
diff --git a/man/mkcephfs.8 b/man/mkcephfs.8
new file mode 100644
index 00000000000..706bb3c6b70
--- /dev/null
+++ b/man/mkcephfs.8
@@ -0,0 +1,43 @@
+.TH COSD 8
+.SH NAME
+cosd \- ceph object storage daemon
+.SH SYNOPSIS
+.B cosd
+[ \fB\-a\fP ]
+[ \fB\-c\fP\fI cluster.conf\fP ]
+[ \fB\-\-clobber_old_data\fP ]
+[ \fB\-\-mkbtrfs\fP ]
+.SH DESCRIPTION
+.B mkcephfs
+is used to create an empty Ceph file system, possibly spanning multiple
+hosts.  The \fIcluster.conf\fP file describes the composition of the 
+Ceph cluster, including which hosts are participating, which daemons
+run where, and which paths are used to store file system data or
+metadata.
+.SH OPTIONS
+.TP
+\fB\-a\fR, \fB\-\-allhosts\fR
+Performs the necessary initialization steps on all hosts in the cluster,
+executing commands via SSH.
+.TP
+\fB\-c\fR, \fB\-\-conf_file \fIcluster.conf\fR
+Use the given cluster conf file instead of the default \fI/etc/ceph/cluster.conf\fP.
+.TP
+\fB\-\-clobber_old_data\fR
+Overwrite any existing data found in monitor or osd paths.
+.TP
+\fB\-\-mkbtrfs\fR
+Create and mount the any btrfs file systems specified in the
+\fBcluster.conf\fP for OSD data storage using \fBmkfs.btrfs\fP.  The
+"btrfs devs" and (if it differs from 
+"osd data") "btrfs path" options must be defined.
+.SH AVAILABILITY
+.B mkcephfs
+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),
+.BR mkmonfs (8),
+.BR monmaptool (8),
+.BR osdmaptool (8),
+.BR crushmaptool (8)