Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

Commit

Permalink
man: rebuild manpages
Browse files Browse the repository at this point in the history
Signed-off-by: Sage Weil <[email protected]>
  • Loading branch information
liewegas committed Sep 22, 2011
1 parent 3e9a936 commit bfbda96
Show file tree
Hide file tree
Showing 24 changed files with 101 additions and 101 deletions.
16 changes: 8 additions & 8 deletions man/ceph-authtool.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "CAUTHTOOL" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-AUTHTOOL" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
ceph-authtool \- ceph keyring manipulation tool
.
Expand Down Expand Up @@ -32,14 +32,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBceph-authtool\fP \fIkeyringfile\fP [ \-l | \-\-list ] [ \-C | \-\-create\-keyring
\fBceph\-authtool\fP \fIkeyringfile\fP [ \-l | \-\-list ] [ \-C | \-\-create\-keyring
] [ \-p | \-\-print ] [ \-n | \-\-name \fIentityname\fP ] [ \-\-gen\-key ] [ \-a |
\-\-add\-key \fIbase64_key\fP ] [ \-\-caps \fIcapfils\fP ] [ \-b | \-\-bin ]
.fi
.sp
.SH DESCRIPTION
.sp
\fBceph-authtool\fP is a utility to create, view, and modify a Ceph keyring
\fBceph\-authtool\fP is a utility to create, view, and modify a Ceph keyring
file. A keyring file stores one or more Ceph authentication keys and
possibly an associated capability specification. Each key is
associated with an entity name, of the form
Expand Down Expand Up @@ -144,7 +144,7 @@ To create a new keyring containing a key for client.foo:
.sp
.nf
.ft C
ceph-authtool \-c \-n client.foo \-\-gen\-key keyring
ceph\-authtool \-c \-n client.foo \-\-gen\-key keyring
.ft P
.fi
.sp
Expand All @@ -153,28 +153,28 @@ mount a Ceph filesystem):
.sp
.nf
.ft C
ceph-authtool \-n client.foo \-\-cap mds \(aqallow\(aq \-\-cap osd \(aqallow rw pool=data\(aq \-\-cap mon \(aqallow r\(aq keyring
ceph\-authtool \-n client.foo \-\-cap mds \(aqallow\(aq \-\-cap osd \(aqallow rw pool=data\(aq \-\-cap mon \(aqallow r\(aq keyring
.ft P
.fi
.sp
To display the contents of the keyring:
.sp
.nf
.ft C
ceph-authtool \-l keyring
ceph\-authtool \-l keyring
.ft P
.fi
.sp
When mount a Ceph file system, you can grab the appropriately encoded secret key with:
.sp
.nf
.ft C
mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gaceph-authtool \-p \-n client.foo keyring\(ga
mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gaceph\-authtool \-p \-n client.foo keyring\(ga
.ft P
.fi
.SH AVAILABILITY
.sp
\fBceph-authtool\fP is part of the Ceph distributed file system. Please
\fBceph\-authtool\fP is part of the Ceph distributed file system. Please
refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
information.
.SH SEE ALSO
Expand Down
10 changes: 5 additions & 5 deletions man/ceph-clsinfo.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CCLSINFO" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-CLSINFO" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cclsinfo \- show class object information
ceph-clsinfo \- show class object information
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -32,12 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBcclsinfo\fP [ \fIoptions\fP ] ... \fIfilename\fP
\fBceph\-clsinfo\fP [ \fIoptions\fP ] ... \fIfilename\fP
.fi
.sp
.SH DESCRIPTION
.sp
\fBcclsinfo\fP can show name, version, and architecture information
\fBceph\-clsinfo\fP can show name, version, and architecture information
about a specific class object.
.SH OPTIONS
.INDENT 0.0
Expand All @@ -57,7 +57,7 @@ Shows the class architecture
.UNINDENT
.SH AVAILABILITY
.sp
\fBcclsinfo\fP is part of the Ceph distributed file system. Please
\fBceph\-clsinfo\fP is part of the Ceph distributed file system. Please
refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
information.
.SH SEE ALSO
Expand Down
30 changes: 15 additions & 15 deletions man/ceph-conf.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CCONF" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-CONF" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cconf \- ceph conf file tool
ceph-conf \- ceph conf file tool
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -32,22 +32,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBcconf\fP \-c \fIconffile\fP \-\-list\-all\-sections
\fBcconf\fP \-c \fIconffile\fP \-L
\fBcconf\fP \-c \fIconffile\fP \-l \fIprefix\fP
\fBcconf\fP \fIkey\fP \-s \fIsection1\fP ...
\fBcconf\fP [\-s \fIsection\fP ] \-\-lookup \fIkey\fP
\fBcconf\fP [\-s \fIsection\fP ] \fIkey\fP
\fBceph\-conf\fP \-c \fIconffile\fP \-\-list\-all\-sections
\fBceph\-conf\fP \-c \fIconffile\fP \-L
\fBceph\-conf\fP \-c \fIconffile\fP \-l \fIprefix\fP
\fBceph\-conf\fP \fIkey\fP \-s \fIsection1\fP ...
\fBceph\-conf\fP [\-s \fIsection\fP ] \-\-lookup \fIkey\fP
\fBceph\-conf\fP [\-s \fIsection\fP ] \fIkey\fP
.fi
.sp
.SH DESCRIPTION
.sp
\fBcconf\fP is a utility for getting information about a ceph
\fBceph\-conf\fP is a utility for getting information about a ceph
configuration file. As with most Ceph programs, you can specify which
Ceph configuration file to use with the \fB\-c\fP flag.
.SH ACTIONS
.sp
\fBcconf\fP will perform one of the following actions:
\fBceph\-conf\fP will perform one of the following actions:
.sp
\-\-list\-all\-sections or \-L prints out a list of all the section names in the configuration
file.
Expand Down Expand Up @@ -75,36 +75,36 @@ To find out what value osd 0 will use for the "osd data" option:
.sp
.nf
.ft C
cconf \-c foo.conf \-\-name osd.0 \-\-lookup "osd data"
ceph\-conf \-c foo.conf \-\-name osd.0 \-\-lookup "osd data"
.ft P
.fi
.sp
To find out what value will mds a use for the "log file" option:
.sp
.nf
.ft C
cconf \-c foo.conf \-\-name mds.a "log file"
ceph\-conf \-c foo.conf \-\-name mds.a "log file"
.ft P
.fi
.sp
To list all sections that begin with osd:
.sp
.nf
.ft C
cconf \-c foo.conf \-l osd
ceph\-conf \-c foo.conf \-l osd
.ft P
.fi
.sp
To list all sections:
.sp
.nf
.ft C
cconf \-c foo.conf \-L
ceph\-conf \-c foo.conf \-L
.ft P
.fi
.SH AVAILABILITY
.sp
\fBcconf\fP is part of the Ceph distributed file system. Please refer
\fBceph\-conf\fP is part of the Ceph distributed file system. Please refer
to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
information.
.SH SEE ALSO
Expand Down
12 changes: 6 additions & 6 deletions man/ceph-debugpack.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CDEBUGPACK" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-DEBUGPACK" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cdebugpack \- ceph debug packer utility
ceph-debugpack \- ceph debug packer utility
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -32,16 +32,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBcdebugpack\fP [ \fIoptions\fP ] \fIfilename.tar.gz\fP
\fBceph\-debugpack\fP [ \fIoptions\fP ] \fIfilename.tar.gz\fP
.fi
.sp
.SH DESCRIPTION
.sp
\fBcdebugpack\fP will build a tarball containing various items that are
\fBceph\-debugpack\fP will build a tarball containing various items that are
useful for debugging crashes. The resulting tarball can be shared with
Ceph developers when debugging a problem.
.sp
The tarball will include the binaries for ceph-mds, ceph-osd, and ceph-mon, any
The tarball will include the binaries for ceph\-mds, ceph\-osd, and ceph\-mon, any
log files, the ceph.conf configuration file, any core files we can
find, and (if the system is running) dumps of the current osd, mds,
and pg maps from the monitor.
Expand All @@ -55,7 +55,7 @@ startup.
.UNINDENT
.SH AVAILABILITY
.sp
\fBcdebugpack\fP is part of the Ceph distributed file system. Please
\fBceph\-debugpack\fP is part of the Ceph distributed file system. Please
refer to the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more
information.
.SH SEE ALSO
Expand Down
14 changes: 7 additions & 7 deletions man/ceph-fuse.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CFUSE" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-FUSE" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cfuse \- FUSE-based client for ceph
ceph-fuse \- FUSE-based client for ceph
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -32,12 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBcfuse\fP [ \-m \fImonaddr\fP:\fIport\fP ] \fImountpoint\fP [ \fIfuse options\fP ]
\fBceph\-fuse\fP [ \-m \fImonaddr\fP:\fIport\fP ] \fImountpoint\fP [ \fIfuse options\fP ]
.fi
.sp
.SH DESCRIPTION
.sp
\fBcfuse\fP is a FUSE (File system in USErspace) client for Ceph
\fBceph\-fuse\fP is a FUSE (File system in USErspace) client for Ceph
distributed file system. It will mount a ceph file system (specified
via the \-m option for described by ceph.conf (see below) at the
specific mount point.
Expand All @@ -50,10 +50,10 @@ fusermount \-u mountpoint
.ft P
.fi
.sp
or by sending \fBSIGINT\fP to the \fBcfuse\fP process.
or by sending \fBSIGINT\fP to the \fBceph\-fuse\fP process.
.SH OPTIONS
.sp
Any options not recognized by cfuse will be passed on to libfuse.
Any options not recognized by ceph\-fuse will be passed on to libfuse.
.INDENT 0.0
.TP
.B \-d
Expand All @@ -77,7 +77,7 @@ Use root_directory as the mounted root, rather than the full Ceph tree.
.UNINDENT
.SH AVAILABILITY
.sp
\fBcfuse\fP is part of the Ceph distributed file system. Please refer to
\fBceph\-fuse\fP is part of the Ceph distributed file system. Please refer to
the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
.sp
Expand Down
20 changes: 10 additions & 10 deletions man/ceph-mds.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CMDS" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-MDS" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cmds \- ceph metadata server daemon
ceph-mds \- ceph metadata server daemon
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -32,16 +32,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.
.SH SYNOPSIS
.nf
\fBcmds\fP \-i \fIname\fP [[ \-\-hot\-standby [\fIrank\fP] ]|[\-\-journal_check \fIrank\fP]]
\fBceph\-mds\fP \-i \fIname\fP [[ \-\-hot\-standby [\fIrank\fP] ]|[\-\-journal_check \fIrank\fP]]
.fi
.sp
.SH DESCRIPTION
.sp
\fBcmds\fP is the metadata server daemon for the Ceph distributed file
system. One or more instances of cmds collectively manage the file
\fBceph\-mds\fP is the metadata server daemon for the Ceph distributed file
system. One or more instances of ceph\-mds collectively manage the file
system namespace, coordinating access to the shared OSD cluster.
.sp
Each cmds daemon instance should have a unique name. The name is used
Each ceph\-mds daemon instance should have a unique name. The name is used
to identify daemon instances in the ceph.conf.
.sp
Once the daemon has started, the monitor cluster will normally assign
Expand All @@ -59,7 +59,7 @@ overrides specifying the name.
.TP
.B \-f, \-\-foreground
Foreground: do not daemonize after startup (run in foreground). Do
not generate a pid file. Useful when run via \fBceph-run\fP(8).
not generate a pid file. Useful when run via \fBceph\-run\fP(8).
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -81,13 +81,13 @@ Connect to specified monitor (instead of looking through
.UNINDENT
.SH AVAILABILITY
.sp
\fBcmon\fP is part of the Ceph distributed file system. Please refer to the Ceph wiki at
\fBceph\-mon\fP is part of the Ceph distributed file system. Please refer to the Ceph wiki at
\fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBceph-mon\fP(8),
\fBceph-osd\fP(8)
\fBceph\-mon\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
2011, New Dream Network
.\" Generated by docutils manpage writer.
Expand Down
10 changes: 5 additions & 5 deletions man/ceph-mon.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "CMON" "8" "September 09, 2011" "dev" "Ceph"
.TH "CEPH-MON" "8" "September 22, 2011" "dev" "Ceph"
.SH NAME
cmon \- ceph monitor daemon
ceph-mon \- ceph monitor daemon
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -50,7 +50,7 @@ the configuration file.
.TP
.B \-f, \-\-foreground
Foreground: do not daemonize after startup (run in foreground). Do
not generate a pid file. Useful when run via \fBcrun\fP(8).
not generate a pid file. Useful when run via \fBceph\-run\fP(8).
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -71,8 +71,8 @@ the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBceph-mds\fP(8),
\fBceph-osd\fP(8)
\fBceph\-mds\fP(8),
\fBceph\-osd\fP(8)
.SH COPYRIGHT
2011, New Dream Network
.\" Generated by docutils manpage writer.
Expand Down
Loading

0 comments on commit bfbda96

Please sign in to comment.