man: mkmonfs, monmaptool, ceph

4 files changed, 162 insertions, 2 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
index 1ec5a27815c..2eed7abc99d 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,4 +1,18 @@
 AUTOMAKE_OPTIONS = gnu
 
-man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 cfuse.8 csyn.8 crushtool.8 osdmaptool.8 cconf.8
-dist_man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 cfuse.8 csyn.8 crushtool.8 osdmaptool.8 cconf.8
\ No newline at end of file
+man_MANS = \
+	cosd.8 \
+	cmds.8 \
+	cmon.8 \
+	mkcephfs.8 \
+	mkmonfs.8 \
+	cfuse.8 \
+	csyn.8 \
+	crushtool.8 \
+	osdmaptool.8 \
+	monmaptool.8 \
+	cconf.8 \
+	crun.8 \
+	ceph.8
+
+dist_man_MANS = $(man_MANS)
\ No newline at end of file
diff --git a/man/ceph.8 b/man/ceph.8
new file mode 100644
index 00000000000..e036ad4d1dc
--- /dev/null
+++ b/man/ceph.8
@@ -0,0 +1,61 @@
+.TH CEPH 8
+.SH NAME
+ceph \- ceph file system control utility
+.SH SYNOPSIS
+.B ceph
+[ \fB\-m\fI monaddr\fR ]
+[ \fB\-w\fP | \fIcommand ...\fR ]
+.SH DESCRIPTION
+.B ceph
+is a control utility for communicating with the monitor cluster of a running
+Ceph distributed file system.
+.PP
+There are three basic modes of operation.
+.SH INTERACTIVE MODE
+To start in interactive
+mode, no arguments are necessary.  Control-d or 'quit' will exit.
+.SH WATCH MODE
+To watch cluster state changes in real time,
+starting in \fB\-w\fP (watch) mode will print updates to stdout as they occur.  For example,
+to keep an eye on cluster state,
+.IP
+ceph -C cluster.conf -w
+.SH COMMAND LINE MODE
+Finally, to send a single instruction to the monitor cluster (and wait for a 
+response), the command can be specified on the command line.
+.SH OPTIONS
+.TP
+\fB\-i \fIinfile\fP
+will specify an input file to be passed along as a payload with the \fIcommand\fP to the
+monitor cluster.  This is only used for specific monitor commands.
+.TP
+\fB\-o \fIoutfile\fP
+will write any payload returned by the monitor cluster with its reply to \fIoutfile\fP.
+Only specific monitor commands (e.g. \fIosd getmap\fP) return a payload.
+.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 EXAMPLES
+To grab a copy of the current OSD map:
+.IP
+ceph -m 1.2.3.4:6789 osd getmap -o osdmap
+.PP
+To get a dump of placement group (PG) state:
+.IP
+ceph pg dump -o pg.txt
+.SH MONITOR COMMANDS
+A more complete summary of commands understood by the monitor cluster can be found
+in the wiki, at
+.IP
+http://ceph.newdream.net/wiki/Monitor_commands
+.SH AVAILABILITY
+.B ceph
+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 mkcephfs (8)
diff --git a/man/mkmonfs.8 b/man/mkmonfs.8
new file mode 100644
index 00000000000..e72a19a3cce
--- /dev/null
+++ b/man/mkmonfs.8
@@ -0,0 +1,24 @@
+.TH MKMONFS 8
+.SH NAME
+mkmonfs \- create a ceph monitor data store
+.SH SYNOPSIS
+.B mkmonfs
+\fIdatadir\fR
+\fB\-\-mon \fImonid\fR
+\fB\-\-monmap \fImonmapfile\fR
+\fB\-\-osdmap \fIosdmapfile\fR
+[ \fB\-\-clobber\fR ]
+.SH DESCRIPTION
+.B mkmonfs
+will create a fresh monitor data directory in \fIdatadir\fP for
+monitor \fImonid\fP based on the specified \fImonmap\fP and
+\fIosdmap\fP.  It will refuse to overwrite any existing data unless
+\fB\-\-clobber\fP is specified.
+.SH AVAILABILITY
+.B mkmonfs
+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 osdmaptool (8),
+.BR monmaptool (8),
+.BR mkcephfs (8)
diff --git a/man/monmaptool.8 b/man/monmaptool.8
new file mode 100644
index 00000000000..bccf5270a7e
--- /dev/null
+++ b/man/monmaptool.8
@@ -0,0 +1,61 @@
+.TH MONMAPTOOL 8
+.SH NAME
+monmaptool \- ceph monutir cluster map manipulation tool
+.SH SYNOPSIS
+.B monmaptool
+\fImapfilename\fP
+[ \fB\-\-clobber\fR ]
+[ \fB\-\-print\fR ]
+[ \fB\-\-create\fR ]
+[ \fB\-\-add \fIip:port\fP ... ]
+[ \fB\-\-rm \fIip:port\fP ... ]
+.SH DESCRIPTION
+.B monmaptool
+is a utility to create, view, and modify a monitor cluster map for the
+Ceph distributed file system.  The monitor map specifies the only fixed
+addresses in the Ceph distributed system.  All other daemons bind to
+arbitrary addresses and register themselves with the monitors.
+.PP
+When creating a map with \fB\-\-create\fP, a new monitor map with a
+new, random UUID will be created.  It should be followed by one or
+more monitor addresses.
+.PP
+The default Ceph monitor port is \fB6789\fP.
+.SH OPTIONS
+.TP
+\fB\-\-print\fP
+will print a plaintext dump of the map, after any modifications are made.
+.TP
+\fB\-\-clobber\fP
+will allow
+.B monmaptool
+to overwrite \fImapfilename\fP if changes are made.
+.TP
+\fB\-\-create\fP
+will create a new monitor map with a new UUID (and with it, a new, empty Ceph file system).
+.TP
+\fB\-\-add\fI ip:port\fP
+will add a monitor with the specified \fIip:port\fP to the map.
+.TP
+\fB\-\-rm\fI ip:port\fP
+will remove the monitor with the specified \fIip:port\fP from the map.
+.SH EXAMPLE
+To create a new map with three monitors (for a fresh Ceph file system):
+.IP
+monmaptool --create --add 192.168.0.10:6789 --add 192.168.0.11:6789 --add 192.168.0.12:6789 --clobber monmap
+.PP
+To display the contents of the map:
+.IP
+monmaptool --print onmap
+.PP
+To replace one monitor:
+.IP
+monmaptool --rm 192.168.0.10:6789 --add 192.168.0.9:6789 --clobber monmap
+.SH AVAILABILITY
+.B monmaptool
+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 crushtool (8),
+.BR mkcephfs (8)