From: Sage Weil Date: Wed, 28 Oct 2009 19:08:54 +0000 (-0700) Subject: radosgw: fix man page names, include in package X-Git-Tag: v0.18~128^2~62 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=307382f302d4e79728fc44fbc55b582ed65b08c0;p=ceph.git radosgw: fix man page names, include in package --- diff --git a/debian/radosgw.install b/debian/radosgw.install index 88f8b3ccc4ea..077a94e44dcf 100644 --- a/debian/radosgw.install +++ b/debian/radosgw.install @@ -1,3 +1,5 @@ usr/bin/radosgw usr/bin/radosgw_admin -usr/share/lintian/overrides/radosgw \ No newline at end of file +usr/share/lintian/overrides/radosgw +usr/share/man/man8/radosgw.8 +usr/share/man/man8/radosgw_admin.8 diff --git a/man/Makefile.am b/man/Makefile.am index 318fbb76298e..56bc6e15d222 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -14,6 +14,8 @@ man_MANS = \ cconf.8 \ crun.8 \ ceph.8 \ - mount.ceph.8 + mount.ceph.8 \ + radosgw.8 \ + radosgw_admin.8 dist_man_MANS = $(man_MANS) \ No newline at end of file diff --git a/man/radosgw.8 b/man/radosgw.8 index cce15a8c5b34..b7ff17bf7cd8 100644 --- a/man/radosgw.8 +++ b/man/radosgw.8 @@ -1,4 +1,4 @@ -.TH RGW 8 +.TH RADOSGW 8 .SH NAME radosgw \- rados REST gateway .SH SYNOPSIS @@ -38,7 +38,7 @@ An apache example configuration for using the RADOS gateway: Options +ExecCGI AllowOverride All SetHandler fcgid-script - FCGIWrapper /var/www/fcgi-scripts/web1/rgw .fcgi + FCGIWrapper /var/www/fcgi-scripts/web1/radosgw .fcgi Order allow,deny Allow from all AuthBasicAuthoritative Off @@ -52,7 +52,7 @@ An apache example configuration for using the RADOS gateway: ServerSignature Off .PP -And the corresponding rgw script: +And the corresponding radosgw script: .IP #!/bin/sh /usr/bin/radosgw -c /etc/ceph.conf diff --git a/man/radosgw_admin.8 b/man/radosgw_admin.8 new file mode 100644 index 000000000000..111feee5e17a --- /dev/null +++ b/man/radosgw_admin.8 @@ -0,0 +1,61 @@ +.TH RADOSGW_ADMIN 8 +.SH NAME +radosgw_admin \- rados REST gateway user administration utility +.SH SYNOPSIS +.B radosgw_admin +[ \fB\-\-user\-gen\fR ] +[ \fB\-\-user\-modify\fR ] +[ \fB\-\-read\-policy\fR ] +[ \fB\-\-list\-buckets\fR ] [ options ... ] +.SH DESCRIPTION +.B radosgw_admin +is a RADOS gateway user administration utility. It allows creating and modifying users. +.SH OPTIONS +.TP +\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR +Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP +to determine monitor addresses during startup. +.TP +\fB\-m\fI monaddress[:port]\fR +Connect to specified monitor (instead of looking through \fIceph.conf\fR). +.TP +\fB\-\-user\-gen\fR +Generate a new user. +.TP +\fB\-\-user\-modify\fR +Modify an existing user. +.TP +\fB\-\-read\-policy\fR +Show the ACL policy of an bucket or object. +.TP +\fB\-\-list\-buckets\fR +Dump the list of buckets that belong to a specific user. +.TP +\fB\-\-uid=\fIid\fR +Specify the user id for this operation. +.TP +\fB\-\-key=\fIkey\fR +Configure the secret key for this user. +.TP +\fB\-\-display\-name=\fIname\fR +Configure the display name of the user. +.TP +\fB\-\-bucket=\fIbucket\fR +Specify the bucket name. +.TP +\fB\-\-object=\fIobject\fR +Specify the object name. +.SH EXAMPLES +To generate a new user: +.IP + $ ./radosgw_admin --user-gen --display-name="johnny rotten" --email=johnny@rotten.com + User ID: CHBQFRTG26I8DGJDGQLW + Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB + Display Name: johnny rotten +.PP +.SH AVAILABILITY +.B radosgw_admin +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) diff --git a/man/rgw_admin.8 b/man/rgw_admin.8 deleted file mode 100644 index 1e5ab0813bc7..000000000000 --- a/man/rgw_admin.8 +++ /dev/null @@ -1,61 +0,0 @@ -.TH RGW 8 -.SH NAME -rgw_admin \- rados REST gateway user administration utility -.SH SYNOPSIS -.B rgw_admin -[ \fB\-\-user\-gen\fR ] -[ \fB\-\-user\-modify\fR ] -[ \fB\-\-read\-policy\fR ] -[ \fB\-\-list\-buckets\fR ] [ options ... ] -.SH DESCRIPTION -.B rgw_admin -is a RADOS gateway user administration utility. It allows creating and modifying users. -.SH OPTIONS -.TP -\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR -Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP -to determine monitor addresses during startup. -.TP -\fB\-m\fI monaddress[:port]\fR -Connect to specified monitor (instead of looking through \fIceph.conf\fR). -.TP -\fB\-\-user\-gen\fR -Generate a new user. -.TP -\fB\-\-user\-modify\fR -Modify an existing user. -.TP -\fB\-\-read\-policy\fR -Show the ACL policy of an bucket or object. -.TP -\fB\-\-list\-buckets\fR -Dump the list of buckets that belong to a specific user. -.TP -\fB\-\-uid=\fIid\fR -Specify the user id for this operation. -.TP -\fB\-\-key=\fIkey\fR -Configure the secret key for this user. -.TP -\fB\-\-display\-name=\fIname\fR -Configure the display name of the user. -.TP -\fB\-\-bucket=\fIbucket\fR -Specify the bucket name. -.TP -\fB\-\-object=\fIobject\fR -Specify the object name. -.SH EXAMPLES -To generate a new user: -.IP - $ ./rgw_admin --user-gen --display-name="johnny rotten" --email=johnny@rotten.com - User ID: CHBQFRTG26I8DGJDGQLW - Secret Key: QR6cI/31N+J0VKVgHSpEGVSfEEsmf6PyXG040KCB - Display Name: johnny rotten -.PP -.SH AVAILABILITY -.B rgw_admin -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)