summaryrefslogtreecommitdiff
path: root/man/radosgw.8
diff options
context:
space:
mode:
authorTommi Virtanen <tommi.virtanen@dreamhost.com>2011-09-09 16:25:14 -0700
committerTommi Virtanen <tommi.virtanen@dreamhost.com>2011-09-09 16:26:40 -0700
commit92fa2ff8fcdbb61cf0a052117a183a42583844ee (patch)
tree4da24bab00242f4df803aa3a8db70302600533c1 /man/radosgw.8
parent60aea0542385208112223003b5098f8839d8ad02 (diff)
downloadceph-92fa2ff8fcdbb61cf0a052117a183a42583844ee.tar.gz
man: Generate manpages from doc/man.
Keeping the generated files in version control lets us support builds from scratch without requiring the full documentation toolchain to be installed. The files were just copied over from build-doc/output/man, after a ./admin/build-doc call. When redoing this, also take care to remove any roff output if a file was removed from doc/man, and update Makefile.am. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
Diffstat (limited to 'man/radosgw.8')
-rw-r--r--man/radosgw.8123
1 files changed, 93 insertions, 30 deletions
diff --git a/man/radosgw.8 b/man/radosgw.8
index 847a9e1bc69..9c0970f8ecf 100644
--- a/man/radosgw.8
+++ b/man/radosgw.8
@@ -1,27 +1,70 @@
-.TH RADOSGW 8
+.TH "RADOSGW" "8" "September 09, 2011" "dev" "Ceph"
.SH NAME
radosgw \- rados REST gateway
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
.SH SYNOPSIS
-.B radosgw
+.nf
+\fBradosgw\fP
+.fi
+.sp
.SH DESCRIPTION
-.B radosgw
-is an HTTP REST gateway for the RADOS object store, a part of the Ceph
-distributed storage system. It is implemented as a FastCGI module using
-libfcgi, and can be used in conjunction with any FastCGI capable web server.
+.sp
+\fBradosgw\fP is an HTTP REST gateway for the RADOS object store, a part
+of the Ceph distributed storage system. It is implemented as a FastCGI
+module using libfcgi, and can be used in conjunction with any FastCGI
+capable web server.
.SH OPTIONS
+.INDENT 0.0
.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.
+.B \-c ceph.conf, \-\-conf=ceph.conf
+Use \fIceph.conf\fP configuration file instead of the default
+\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during startup.
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-m\fI monaddress[:port]\fR
-Connect to specified monitor (instead of looking through \fIceph.conf\fR).
+.B \-m monaddress[:port]
+Connect to specified monitor (instead of looking through
+\fBceph.conf\fP).
+.UNINDENT
+.INDENT 0.0
.TP
-\fB\-\-rgw\-socket\-path=\fIpath\fR
+.B \-\-rgw\-socket\-path=path
Specify a unix domain socket path.
+.UNINDENT
.SH EXAMPLES
+.sp
An apache example configuration for using the RADOS gateway:
-.IP
+.sp
+.nf
+.ft C
<VirtualHost *:80>
ServerName rgw.example1.com
ServerAlias rgw
@@ -32,15 +75,15 @@ An apache example configuration for using the RADOS gateway:
RewriteEngine On
#following is important for RGW/rados
- RewriteRule ^/([a-zA-Z0-9\-\_\.]*)([/]?.*) /s3gw.fcgi?page=$1&params=$2&%{QUERY_STRING} [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
+ RewriteRule ^/([a\-zA\-Z0\-9\-_.]*)([/]?.*) /s3gw.fcgi?page=$1&params=$2&%{QUERY_STRING} [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
<IfModule mod_fcgid.c>
SuexecUserGroup web1 web1
<Directory /var/www/web1/web/>
Options +ExecCGI
AllowOverride All
- SetHandler fcgid-script
- FCGIWrapper /var/www/fcgi-scripts/web1/radosgw .fcgi
+ SetHandler fcgid\-script
+ FCGIWrapper /var/www/fcgi\-scripts/web1/radosgw .fcgi
Order allow,deny
Allow from all
AuthBasicAuthoritative Off
@@ -54,21 +97,41 @@ An apache example configuration for using the RADOS gateway:
ServerSignature Off
</VirtualHost>
-.PP
+.ft P
+.fi
+.sp
And the corresponding radosgw script:
-.IP
+.sp
+.nf
+.ft C
#!/bin/sh
-/usr/bin/radosgw -c /etc/ceph.conf
-.PP
-By default radosgw will run as single threaded and its execution will be controlled by the fastcgi process manager.
-An alternative way to run it would be by specifying (along the lines of) the following in the apache config:
-.IP
-FastCgiExternalServer /var/www/web1/web/s3gw.fcgi -socket /tmp/.radosgw.sock
-.PP
-and specify a unix domain socket path (either by passing a command line option, or through ceph.conf).
+exec /usr/bin/radosgw \-c /etc/ceph.conf
+.ft P
+.fi
+.sp
+By default radosgw will run as single threaded and its execution will
+be controlled by the fastcgi process manager. An alternative way to
+run it would be by specifying (along the lines of) the following in
+the apache config:
+.sp
+.nf
+.ft C
+FastCgiExternalServer /var/www/web1/web/s3gw.fcgi \-socket /tmp/.radosgw.sock
+.ft P
+.fi
+.sp
+and specify a unix domain socket path (either by passing a command
+line option, or through ceph.conf).
.SH AVAILABILITY
-.B radosgw
-is part of the Ceph distributed file system. Please refer to the Ceph wiki at
-http://ceph.newdream.net/wiki for more information.
+.sp
+\fBradosgw\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
-.BR ceph (8)
+.sp
+\fBceph\fP(8)
+.SH COPYRIGHT
+2011, New Dream Network
+.\" Generated by docutils manpage writer.
+.\"
+.