From 3e9a9360625dff3b9bc87f94c0b5109535b58b5e Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Thu, 22 Sep 2011 15:16:56 -0700 Subject: [PATCH] doc: more c* -> ceph-* renames Signed-off-by: Sage Weil --- ceph.spec.in | 2 +- debian/ceph.install | 2 +- doc/man/8/{cauthtool.rst => ceph-authtool.rst} | 18 +++++++++--------- doc/man/8/{cclsinfo.rst => ceph-clsinfo.rst} | 0 doc/man/8/{cconf.rst => ceph-conf.rst} | 0 .../8/{cdebugpack.rst => ceph-debugpack.rst} | 10 +++++----- doc/man/8/{cfuse.rst => ceph-fuse.rst} | 0 doc/man/8/{cmds.rst => ceph-mds.rst} | 4 ++-- doc/man/8/{cmon.rst => ceph-mon.rst} | 4 ++-- doc/man/8/{cosd.rst => ceph-osd.rst} | 8 ++++---- doc/man/8/{crbdnamer.rst => ceph-rbdnamer.rst} | 0 doc/man/8/{crun.rst => ceph-run.rst} | 6 +++--- doc/man/8/{csyn.rst => ceph-syn.rst} | 10 +++++----- doc/start/block.rst | 2 +- man/ceph-authtool.8 | 16 ++++++++-------- man/ceph-osd.8 | 4 ++-- qa/rbd/common.sh | 2 +- qa/workunits/caps/mon_commands.sh | 2 +- src/cauthtool.cc | 2 +- .../{libceph_config.cc => libcephfs_config.cc} | 0 20 files changed, 46 insertions(+), 46 deletions(-) rename doc/man/8/{cauthtool.rst => ceph-authtool.rst} (85%) rename doc/man/8/{cclsinfo.rst => ceph-clsinfo.rst} (100%) rename doc/man/8/{cconf.rst => ceph-conf.rst} (100%) rename doc/man/8/{cdebugpack.rst => ceph-debugpack.rst} (75%) rename doc/man/8/{cfuse.rst => ceph-fuse.rst} (100%) rename doc/man/8/{cmds.rst => ceph-mds.rst} (96%) rename doc/man/8/{cmon.rst => ceph-mon.rst} (95%) rename doc/man/8/{cosd.rst => ceph-osd.rst} (93%) rename doc/man/8/{crbdnamer.rst => ceph-rbdnamer.rst} (100%) rename doc/man/8/{crun.rst => ceph-run.rst} (88%) rename doc/man/8/{csyn.rst => ceph-syn.rst} (88%) rename src/test/{libceph_config.cc => libcephfs_config.cc} (100%) diff --git a/ceph.spec.in b/ceph.spec.in index 4cce04ef7c071..c029e5dca2f73 100644 --- a/ceph.spec.in +++ b/ceph.spec.in @@ -163,7 +163,7 @@ fi %{_bindir}/crushtool %{_bindir}/monmaptool %{_bindir}/osdmaptool -%{_bindir}/cauthtool +%{_bindir}/ceph-authtool %{_bindir}/ceph-syn %{_bindir}/ceph-run %{_bindir}/ceph-mon diff --git a/debian/ceph.install b/debian/ceph.install index 8d452454aca75..3a0b75d6a2df1 100644 --- a/debian/ceph.install +++ b/debian/ceph.install @@ -9,7 +9,7 @@ usr/bin/ceph-run usr/bin/ceph-mon usr/bin/ceph-mds usr/bin/ceph-osd -usr/bin/cauthtool +usr/bin/ceph-authtool usr/bin/ceph-debugpack sbin/mkcephfs usr/lib/ceph/ceph_common.sh diff --git a/doc/man/8/cauthtool.rst b/doc/man/8/ceph-authtool.rst similarity index 85% rename from doc/man/8/cauthtool.rst rename to doc/man/8/ceph-authtool.rst index 7d3fadd92fef3..88f592ffa58ca 100644 --- a/doc/man/8/cauthtool.rst +++ b/doc/man/8/ceph-authtool.rst @@ -1,13 +1,13 @@ ============================================= - cauthtool -- ceph keyring manipulation tool + ceph-authtool -- ceph keyring manipulation tool ============================================= -.. program:: cauthtool +.. program:: ceph-authtool Synopsis ======== -| **cauthtool** *keyringfile* [ -l | --list ] [ -C | --create-keyring +| **ceph-authtool** *keyringfile* [ -l | --list ] [ -C | --create-keyring ] [ -p | --print ] [ -n | --name *entityname* ] [ --gen-key ] [ -a | --add-key *base64_key* ] [ --caps *capfils* ] [ -b | --bin ] @@ -15,7 +15,7 @@ Synopsis Description =========== -**cauthtool** is a utility to create, view, and modify a Ceph keyring +**ceph-authtool** 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 @@ -110,26 +110,26 @@ Example To create a new keyring containing a key for client.foo:: - cauthtool -c -n client.foo --gen-key keyring + ceph-authtool -c -n client.foo --gen-key keyring To associate some capabilities with the key (namely, the ability to mount a Ceph filesystem):: - cauthtool -n client.foo --cap mds 'allow' --cap osd 'allow rw pool=data' --cap mon 'allow r' keyring + ceph-authtool -n client.foo --cap mds 'allow' --cap osd 'allow rw pool=data' --cap mon 'allow r' keyring To display the contents of the keyring:: - cauthtool -l keyring + ceph-authtool -l keyring When mount a Ceph file system, you can grab the appropriately encoded secret key with:: - mount -t ceph serverhost:/ mountpoint -o name=foo,secret=`cauthtool -p -n client.foo keyring` + mount -t ceph serverhost:/ mountpoint -o name=foo,secret=`ceph-authtool -p -n client.foo keyring` Availability ============ -**cauthtool** is part of the Ceph distributed file system. Please +**ceph-authtool** is part of the Ceph distributed file system. Please refer to the Ceph wiki at http://ceph.newdream.net/wiki for more information. diff --git a/doc/man/8/cclsinfo.rst b/doc/man/8/ceph-clsinfo.rst similarity index 100% rename from doc/man/8/cclsinfo.rst rename to doc/man/8/ceph-clsinfo.rst diff --git a/doc/man/8/cconf.rst b/doc/man/8/ceph-conf.rst similarity index 100% rename from doc/man/8/cconf.rst rename to doc/man/8/ceph-conf.rst diff --git a/doc/man/8/cdebugpack.rst b/doc/man/8/ceph-debugpack.rst similarity index 75% rename from doc/man/8/cdebugpack.rst rename to doc/man/8/ceph-debugpack.rst index 259cf87d1928e..ede3a88953cb9 100644 --- a/doc/man/8/cdebugpack.rst +++ b/doc/man/8/ceph-debugpack.rst @@ -1,19 +1,19 @@ ========================================= - cdebugpack -- ceph debug packer utility + ceph-debugpack -- ceph debug packer utility ========================================= -.. program:: cdebugpack +.. program:: ceph-debugpack Synopsis ======== -| **cdebugpack** [ *options* ] *filename.tar.gz* +| **ceph-debugpack** [ *options* ] *filename.tar.gz* Description =========== -**cdebugpack** will build a tarball containing various items that are +**ceph-debugpack** 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. @@ -36,7 +36,7 @@ Options Availability ============ -**cdebugpack** is part of the Ceph distributed file system. Please +**ceph-debugpack** is part of the Ceph distributed file system. Please refer to the Ceph wiki at http://ceph.newdream.net/wiki for more information. diff --git a/doc/man/8/cfuse.rst b/doc/man/8/ceph-fuse.rst similarity index 100% rename from doc/man/8/cfuse.rst rename to doc/man/8/ceph-fuse.rst diff --git a/doc/man/8/cmds.rst b/doc/man/8/ceph-mds.rst similarity index 96% rename from doc/man/8/cmds.rst rename to doc/man/8/ceph-mds.rst index 936bb99eea197..8383bca0bd455 100644 --- a/doc/man/8/cmds.rst +++ b/doc/man/8/ceph-mds.rst @@ -68,5 +68,5 @@ See also ======== :doc:`ceph `\(8), -:doc:`ceph-mon `\(8), -:doc:`ceph-osd `\(8) +:doc:`ceph-mon `\(8), +:doc:`ceph-osd `\(8) diff --git a/doc/man/8/cmon.rst b/doc/man/8/ceph-mon.rst similarity index 95% rename from doc/man/8/cmon.rst rename to doc/man/8/ceph-mon.rst index 6bf94c291c0b6..9430017a334a9 100644 --- a/doc/man/8/cmon.rst +++ b/doc/man/8/ceph-mon.rst @@ -52,5 +52,5 @@ See also ======== :doc:`ceph `\(8), -:doc:`ceph-mds `\(8), -:doc:`ceph-osd `\(8) +:doc:`ceph-mds `\(8), +:doc:`ceph-osd `\(8) diff --git a/doc/man/8/cosd.rst b/doc/man/8/ceph-osd.rst similarity index 93% rename from doc/man/8/cosd.rst rename to doc/man/8/ceph-osd.rst index 7bf2c175fa435..3a1c70f3a5186 100644 --- a/doc/man/8/cosd.rst +++ b/doc/man/8/ceph-osd.rst @@ -54,7 +54,7 @@ Options Generate a new secret key. This is normally used in combination with ``--mkfs`` as it is more convenient than generating a key by - hand with :doc:`cauthtool `\(8). + hand with :doc:`ceph-authtool `\(8). .. option:: --mkjournal @@ -90,6 +90,6 @@ See also ======== :doc:`ceph `\(8), -:doc:`ceph-mds `\(8), -:doc:`ceph-mon `\(8), -:doc:`ceph-authtool `\(8) +:doc:`ceph-mds `\(8), +:doc:`ceph-mon `\(8), +:doc:`ceph-authtool `\(8) diff --git a/doc/man/8/crbdnamer.rst b/doc/man/8/ceph-rbdnamer.rst similarity index 100% rename from doc/man/8/crbdnamer.rst rename to doc/man/8/ceph-rbdnamer.rst diff --git a/doc/man/8/crun.rst b/doc/man/8/ceph-run.rst similarity index 88% rename from doc/man/8/crun.rst rename to doc/man/8/ceph-run.rst index 3ab97fa2be119..bba301369f0af 100644 --- a/doc/man/8/crun.rst +++ b/doc/man/8/ceph-run.rst @@ -38,6 +38,6 @@ See also ======== :doc:`ceph `\(8), -:doc:`ceph-mon `\(8), -:doc:`ceph-mds `\(8), -:doc:`ceph-osd `\(8) +:doc:`ceph-mon `\(8), +:doc:`ceph-mds `\(8), +:doc:`ceph-osd `\(8) diff --git a/doc/man/8/csyn.rst b/doc/man/8/ceph-syn.rst similarity index 88% rename from doc/man/8/csyn.rst rename to doc/man/8/ceph-syn.rst index 4a540fc54cae1..4303c1683e3c5 100644 --- a/doc/man/8/csyn.rst +++ b/doc/man/8/ceph-syn.rst @@ -1,19 +1,19 @@ =========================================== - csyn -- ceph synthetic workload generator + ceph-syn -- ceph synthetic workload generator =========================================== -.. program:: csyn +.. program:: ceph-syn Synopsis ======== -| **csyn** [ -m *monaddr*:*port* ] --syn *command* *...* +| **ceph-syn** [ -m *monaddr*:*port* ] --syn *command* *...* Description =========== -**csyn** is a simple synthetic workload generator for the Ceph +**ceph-syn** is a simple synthetic workload generator for the Ceph distributed file system. It uses the userspace client library to generate simple workloads against a currently running file system. The file system need not be mounted via ceph-fuse(8) or the kernel client. @@ -87,7 +87,7 @@ line. This is not a complete list. Availability ============ -**csyn** is part of the Ceph distributed file system. Please refer to +**ceph-syn** is part of the Ceph distributed file system. Please refer to the Ceph wiki at http://ceph.newdream.net/wiki for more information. See also diff --git a/doc/start/block.rst b/doc/start/block.rst index 01f866c0d4a88..947adfc01ed7d 100644 --- a/doc/start/block.rst +++ b/doc/start/block.rst @@ -56,7 +56,7 @@ And then make that visible as a block device:: touch secretfile chmod go= secretfile - cauthtool --name=bar --print-key /etc/ceph/client.bar.keyring >secretfile + ceph-authtool --name=bar --print-key /etc/ceph/client.bar.keyring >secretfile rbd map tengigs --user bar --secret secretfile .. todo:: the secretfile part is really clumsy diff --git a/man/ceph-authtool.8 b/man/ceph-authtool.8 index 3abbba343268a..afb5abb7fb67f 100644 --- a/man/ceph-authtool.8 +++ b/man/ceph-authtool.8 @@ -1,6 +1,6 @@ .TH "CAUTHTOOL" "8" "September 09, 2011" "dev" "Ceph" .SH NAME -cauthtool \- ceph keyring manipulation tool +ceph-authtool \- ceph keyring manipulation tool . .nr rst2man-indent-level 0 . @@ -32,14 +32,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] . .SH SYNOPSIS .nf -\fBcauthtool\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 -\fBcauthtool\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 @@ -144,7 +144,7 @@ To create a new keyring containing a key for client.foo: .sp .nf .ft C -cauthtool \-c \-n client.foo \-\-gen\-key keyring +ceph-authtool \-c \-n client.foo \-\-gen\-key keyring .ft P .fi .sp @@ -153,7 +153,7 @@ mount a Ceph filesystem): .sp .nf .ft C -cauthtool \-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 @@ -161,7 +161,7 @@ To display the contents of the keyring: .sp .nf .ft C -cauthtool \-l keyring +ceph-authtool \-l keyring .ft P .fi .sp @@ -169,12 +169,12 @@ When mount a Ceph file system, you can grab the appropriately encoded secret key .sp .nf .ft C -mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gacauthtool \-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 -\fBcauthtool\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 diff --git a/man/ceph-osd.8 b/man/ceph-osd.8 index 79d9839bd4020..edaa884da6bc7 100644 --- a/man/ceph-osd.8 +++ b/man/ceph-osd.8 @@ -80,7 +80,7 @@ Create an empty object repository. Normally invoked by .B \-\-mkkey Generate a new secret key. This is normally used in combination with \fB\-\-mkfs\fP as it is more convenient than generating a key by -hand with \fBcauthtool\fP(8). +hand with \fBceph-authtool\fP(8). .UNINDENT .INDENT 0.0 .TP @@ -118,7 +118,7 @@ the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information. \fBceph\fP(8), \fBcmds\fP(8), \fBcmon\fP(8), -\fBcauthtool\fP(8) +\fBceph-authtool\fP(8) .SH COPYRIGHT 2011, New Dream Network .\" Generated by docutils manpage writer. diff --git a/qa/rbd/common.sh b/qa/rbd/common.sh index 4c4ff0d38b13c..e1926f7f9c042 100644 --- a/qa/rbd/common.sh +++ b/qa/rbd/common.sh @@ -34,7 +34,7 @@ set_variables() { [ -z "$imgsize" ] && imgsize=1024 [ -z "$user" ] && user=admin [ -z "$keyring" ] && keyring="`$CCONF keyring`" - [ -z "$secret" ] && secret="`cauthtool $keyring -n client.$user -p`" + [ -z "$secret" ] && secret="`ceph-authtool $keyring -n client.$user -p`" monip="`echo $monhost | sed 's/:/ /g' | awk '{print $1}'`" monport="`echo $monhost | sed 's/:/ /g' | awk '{print $2}'`" diff --git a/qa/workunits/caps/mon_commands.sh b/qa/workunits/caps/mon_commands.sh index 237055c3c1691..5b5bce62ea198 100755 --- a/qa/workunits/caps/mon_commands.sh +++ b/qa/workunits/caps/mon_commands.sh @@ -1,6 +1,6 @@ #!/bin/sh -ex -cauthtool --create-keyring k --gen-key -p --name client.xx +ceph-authtool --create-keyring k --gen-key -p --name client.xx ceph auth add -i k client.xx mon "allow command foo; allow command bar *; allow command baz ...; allow command foo add * mon allow\\ rwx osd allow\\ *" ( ceph -k k -n client.xx foo || true ) | grep 'unrecog' diff --git a/src/cauthtool.cc b/src/cauthtool.cc index cde058917cd47..bef361b7c0ded 100644 --- a/src/cauthtool.cc +++ b/src/cauthtool.cc @@ -29,7 +29,7 @@ using namespace std; void usage() { - cout << "usage: cauthtool keyringfile [OPTIONS]...\n" + cout << "usage: ceph-authtool keyringfile [OPTIONS]...\n" << "where the options are:\n" << " -l, --list will list all keys and capabilities present in\n" << " the keyring\n" diff --git a/src/test/libceph_config.cc b/src/test/libcephfs_config.cc similarity index 100% rename from src/test/libceph_config.cc rename to src/test/libcephfs_config.cc -- 2.39.5