From: Sage Weil Date: Wed, 11 Mar 2009 03:49:30 +0000 (-0700) Subject: man: cconf X-Git-Tag: v0.7.1^2~116 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=8929cf92ddf7513ecf5bbf83147e85ed779ae7cd;p=ceph.git man: cconf --- diff --git a/debian/ceph.install b/debian/ceph.install index bafceac02a67..e4eb101b81d6 100644 --- a/debian/ceph.install +++ b/debian/ceph.install @@ -23,3 +23,4 @@ usr/share/man/man8/crun.8 usr/share/man/man8/csyn.8 usr/share/man/man8/crushtool.8 usr/share/man/man8/osdmaptool.8 +usr/share/man/man8/cconf.8 diff --git a/man/Makefile.am b/man/Makefile.am index ed0b54d995f1..1ec5a27815c7 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 cfuse.8 csyn.8 crushtool.8 osdmaptool.8 -dist_man_MANS = cosd.8 cmds.8 cmon.8 mkcephfs.8 cfuse.8 csyn.8 crushtool.8 osdmaptool.8 \ No newline at end of file +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 diff --git a/man/cconf.8 b/man/cconf.8 new file mode 100644 index 000000000000..eeefb5985118 --- /dev/null +++ b/man/cconf.8 @@ -0,0 +1,33 @@ +.TH CCONF 8 +.SH NAME +cconf \- ceph conf file tool +.SH SYNOPSIS +.B cconf +\fB\-c \fIconffile\fR +( \fB\-l \fIprefix\fR | \fIkey\fR [ \fIdefault\fR ] \fB\-s \fIsection\fR [ \fB\-s \fIsection2\fP ... ] ) +.SH DESCRIPTION +.B cconf +is a utility for extracting values from a "INI" style configuration files. It has +two basic modes of operation. +.PP +The first mode simply prints all section names that begin with \fIprefix\fP. +.PP +The second mode extracts an option value by searching through one or more \fIsection\fPs, +in the order specified on the command line. If the option does not exist in +\fIconffile\fP, an optional \fIdefault\fP value may be output instead. +.SH EXAMPLES +To extract the value of the "osd data" option from section \fI[osd0]\fP, +\fI[osd]\fP, or \fI[global]\fP, in that order of preference: +.IP +cconf -c foo.conf "osd data" -s osd0 -s osd -s global +.PP +To list all sections that begin with \fIosd\fP: +.IP +cconf -c foo.conf -l osd +.SH AVAILABILITY +.B cconf +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/src/cconf.cc b/src/cconf.cc index b19118db28a6..3a3afa087e81 100644 --- a/src/cconf.cc +++ b/src/cconf.cc @@ -14,7 +14,7 @@ using namespace std; void usage() { - cerr << "usage: cconf [--conf_file filename] [-l|--list_sections prefix] [-s
] [[-s section] ... ] [default]" << std::endl; + cerr << "usage: cconf [-c filename] [-l|--list_sections ] [-s
] [[-s section] ... ] [default]" << std::endl; exit(1); } @@ -34,8 +34,7 @@ int main(int argc, const char **argv) usage(); for (unsigned i=0; i